Package com.google.cloud.filestore.v1beta1

Class Share

  • All Implemented Interfaces:
    ShareOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Share
extends com.google.protobuf.GeneratedMessageV3
implements ShareOrBuilder
     A Filestore share.
    Protobuf type google.cloud.filestore.v1beta1.Share
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. The resource name of the share, in the format
 `projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface ShareOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the share, in the format
 `projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface ShareOrBuilder
        Returns:
        The bytes for name.

      • getMountName

        public String getMountName()
         The mount name of the share. Must be 63 characters or less and consist of
 uppercase or lowercase letters, numbers, and underscores.
        string mount_name = 2;
        Specified by:
        getMountName in interface ShareOrBuilder
        Returns:
        The mountName.

      • getMountNameBytes

        public com.google.protobuf.ByteString getMountNameBytes()
         The mount name of the share. Must be 63 characters or less and consist of
 uppercase or lowercase letters, numbers, and underscores.
        string mount_name = 2;
        Specified by:
        getMountNameBytes in interface ShareOrBuilder
        Returns:
        The bytes for mountName.

      • getDescription

        public String getDescription()
         A description of the share with 2048 characters or less. Requests with
 longer descriptions will be rejected.
        string description = 3;
        Specified by:
        getDescription in interface ShareOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         A description of the share with 2048 characters or less. Requests with
 longer descriptions will be rejected.
        string description = 3;
        Specified by:
        getDescriptionBytes in interface ShareOrBuilder
        Returns:
        The bytes for description.

      • getCapacityGb

        public long getCapacityGb()
         File share capacity in gigabytes (GB). Filestore defines 1 GB as
 1024^3 bytes. Must be greater than 0.
        int64 capacity_gb = 4;
        Specified by:
        getCapacityGb in interface ShareOrBuilder
        Returns:
        The capacityGb.

      • getNfsExportOptionsList

        public List<NfsExportOptions> getNfsExportOptionsList()
         Nfs Export Options.
 There is a limit of 10 export options per file share.
        repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;
        Specified by:
        getNfsExportOptionsList in interface ShareOrBuilder

      • getNfsExportOptionsCount

        public int getNfsExportOptionsCount()
         Nfs Export Options.
 There is a limit of 10 export options per file share.
        repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;
        Specified by:
        getNfsExportOptionsCount in interface ShareOrBuilder

      • getNfsExportOptions

        public NfsExportOptions getNfsExportOptions​(int index)
         Nfs Export Options.
 There is a limit of 10 export options per file share.
        repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;
        Specified by:
        getNfsExportOptions in interface ShareOrBuilder

      • getNfsExportOptionsOrBuilder

        public NfsExportOptionsOrBuilder getNfsExportOptionsOrBuilder​(int index)
         Nfs Export Options.
 There is a limit of 10 export options per file share.
        repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;
        Specified by:
        getNfsExportOptionsOrBuilder in interface ShareOrBuilder

      • getStateValue

        public int getStateValue()
         Output only. The share state.
        .google.cloud.filestore.v1beta1.Share.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface ShareOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Share.State getState()
         Output only. The share state.
        .google.cloud.filestore.v1beta1.Share.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface ShareOrBuilder
        Returns:
        The state.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time when the share was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface ShareOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time when the share was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface ShareOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time when the share was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface ShareOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: ShareOrBuilder
         Resource labels to represent user provided metadata.
        map<string, string> labels = 8;
        Specified by:
        getLabelsCount in interface ShareOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Resource labels to represent user provided metadata.
        map<string, string> labels = 8;
        Specified by:
        containsLabels in interface ShareOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Resource labels to represent user provided metadata.
        map<string, string> labels = 8;
        Specified by:
        getLabelsOrThrow in interface ShareOrBuilder

      • hasBackup

        public boolean hasBackup()
         Immutable. Full name of the Cloud Filestore Backup resource that this
 Share is restored from, in the format of
 projects/{project_id}/locations/{location_id}/backups/{backup_id}.
 Empty, if the Share is created from scratch and not restored from a
 backup.
        string backup = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        hasBackup in interface ShareOrBuilder
        Returns:
        Whether the backup field is set.

      • getBackup

        public String getBackup()
         Immutable. Full name of the Cloud Filestore Backup resource that this
 Share is restored from, in the format of
 projects/{project_id}/locations/{location_id}/backups/{backup_id}.
 Empty, if the Share is created from scratch and not restored from a
 backup.
        string backup = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getBackup in interface ShareOrBuilder
        Returns:
        The backup.

      • getBackupBytes

        public com.google.protobuf.ByteString getBackupBytes()
         Immutable. Full name of the Cloud Filestore Backup resource that this
 Share is restored from, in the format of
 projects/{project_id}/locations/{location_id}/backups/{backup_id}.
 Empty, if the Share is created from scratch and not restored from a
 backup.
        string backup = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getBackupBytes in interface ShareOrBuilder
        Returns:
        The bytes for backup.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Share parseFrom​(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Share parseFrom​(ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Share parseFrom​(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Share parseFrom​(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Share parseFrom​(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Share parseFrom​(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Share parseFrom​(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Share.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Share.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Share.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Share getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Share> parser()

      • getParserForType

        public com.google.protobuf.Parser<Share> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Share getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder