Package com.google.cloud.filestore.v1

Class Instance

  • All Implemented Interfaces:
    InstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Instance
extends com.google.protobuf.GeneratedMessageV3
implements InstanceOrBuilder
     A Filestore instance.
    Protobuf type google.cloud.filestore.v1.Instance
    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 instance, in the format
 `projects/{project}/locations/{location}/instances/{instance}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface InstanceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the instance, in the format
 `projects/{project}/locations/{location}/instances/{instance}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface InstanceOrBuilder
        Returns:
        The bytes for name.

      • getDescription

        public String getDescription()
         The description of the instance (2048 characters or less).
        string description = 2;
        Specified by:
        getDescription in interface InstanceOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         The description of the instance (2048 characters or less).
        string description = 2;
        Specified by:
        getDescriptionBytes in interface InstanceOrBuilder
        Returns:
        The bytes for description.

      • getStateValue

        public int getStateValue()
         Output only. The instance state.
        .google.cloud.filestore.v1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Instance.State getState()
         Output only. The instance state.
        .google.cloud.filestore.v1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface InstanceOrBuilder
        Returns:
        The state.

      • getStatusMessage

        public String getStatusMessage()
         Output only. Additional information about the instance state, if available.
        string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusMessage in interface InstanceOrBuilder
        Returns:
        The statusMessage.

      • getStatusMessageBytes

        public com.google.protobuf.ByteString getStatusMessageBytes()
         Output only. Additional information about the instance state, if available.
        string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusMessageBytes in interface InstanceOrBuilder
        Returns:
        The bytes for statusMessage.

      • hasCreateTime

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

      • getCreateTime

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

      • getCreateTimeOrBuilder

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

      • getTierValue

        public int getTierValue()
         The service tier of the instance.
        .google.cloud.filestore.v1.Instance.Tier tier = 8;
        Specified by:
        getTierValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for tier.

      • getTier

        public Instance.Tier getTier()
         The service tier of the instance.
        .google.cloud.filestore.v1.Instance.Tier tier = 8;
        Specified by:
        getTier in interface InstanceOrBuilder
        Returns:
        The tier.

      • getLabelsCount

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

      • containsLabels

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

      • getFileSharesList

        public List<FileShareConfig> getFileSharesList()
         File system shares on the instance.
 For this version, only a single file share is supported.
        repeated .google.cloud.filestore.v1.FileShareConfig file_shares = 10;
        Specified by:
        getFileSharesList in interface InstanceOrBuilder

      • getFileSharesCount

        public int getFileSharesCount()
         File system shares on the instance.
 For this version, only a single file share is supported.
        repeated .google.cloud.filestore.v1.FileShareConfig file_shares = 10;
        Specified by:
        getFileSharesCount in interface InstanceOrBuilder

      • getFileShares

        public FileShareConfig getFileShares​(int index)
         File system shares on the instance.
 For this version, only a single file share is supported.
        repeated .google.cloud.filestore.v1.FileShareConfig file_shares = 10;
        Specified by:
        getFileShares in interface InstanceOrBuilder

      • getFileSharesOrBuilder

        public FileShareConfigOrBuilder getFileSharesOrBuilder​(int index)
         File system shares on the instance.
 For this version, only a single file share is supported.
        repeated .google.cloud.filestore.v1.FileShareConfig file_shares = 10;
        Specified by:
        getFileSharesOrBuilder in interface InstanceOrBuilder

      • getNetworksList

        public List<NetworkConfig> getNetworksList()
         VPC networks to which the instance is connected.
 For this version, only a single network is supported.
        repeated .google.cloud.filestore.v1.NetworkConfig networks = 11;
        Specified by:
        getNetworksList in interface InstanceOrBuilder

      • getNetworksOrBuilderList

        public List<? extends NetworkConfigOrBuilder> getNetworksOrBuilderList()
         VPC networks to which the instance is connected.
 For this version, only a single network is supported.
        repeated .google.cloud.filestore.v1.NetworkConfig networks = 11;
        Specified by:
        getNetworksOrBuilderList in interface InstanceOrBuilder

      • getNetworksCount

        public int getNetworksCount()
         VPC networks to which the instance is connected.
 For this version, only a single network is supported.
        repeated .google.cloud.filestore.v1.NetworkConfig networks = 11;
        Specified by:
        getNetworksCount in interface InstanceOrBuilder

      • getNetworks

        public NetworkConfig getNetworks​(int index)
         VPC networks to which the instance is connected.
 For this version, only a single network is supported.
        repeated .google.cloud.filestore.v1.NetworkConfig networks = 11;
        Specified by:
        getNetworks in interface InstanceOrBuilder

      • getNetworksOrBuilder

        public NetworkConfigOrBuilder getNetworksOrBuilder​(int index)
         VPC networks to which the instance is connected.
 For this version, only a single network is supported.
        repeated .google.cloud.filestore.v1.NetworkConfig networks = 11;
        Specified by:
        getNetworksOrBuilder in interface InstanceOrBuilder

      • getEtag

        public String getEtag()
         Server-specified ETag for the instance resource to prevent simultaneous
 updates from overwriting each other.
        string etag = 12;
        Specified by:
        getEtag in interface InstanceOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Server-specified ETag for the instance resource to prevent simultaneous
 updates from overwriting each other.
        string etag = 12;
        Specified by:
        getEtagBytes in interface InstanceOrBuilder
        Returns:
        The bytes for etag.

      • hasSatisfiesPzs

        public boolean hasSatisfiesPzs()
         Output only. Reserved for future use.
        .google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasSatisfiesPzs in interface InstanceOrBuilder
        Returns:
        Whether the satisfiesPzs field is set.

      • getSatisfiesPzs

        public com.google.protobuf.BoolValue getSatisfiesPzs()
         Output only. Reserved for future use.
        .google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSatisfiesPzs in interface InstanceOrBuilder
        Returns:
        The satisfiesPzs.

      • getSatisfiesPzsOrBuilder

        public com.google.protobuf.BoolValueOrBuilder getSatisfiesPzsOrBuilder()
         Output only. Reserved for future use.
        .google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSatisfiesPzsOrBuilder in interface InstanceOrBuilder

      • getKmsKeyName

        public String getKmsKeyName()
         KMS key name used for data encryption.
        string kms_key_name = 14;
        Specified by:
        getKmsKeyName in interface InstanceOrBuilder
        Returns:
        The kmsKeyName.

      • getKmsKeyNameBytes

        public com.google.protobuf.ByteString getKmsKeyNameBytes()
         KMS key name used for data encryption.
        string kms_key_name = 14;
        Specified by:
        getKmsKeyNameBytes in interface InstanceOrBuilder
        Returns:
        The bytes for kmsKeyName.

      • getSuspensionReasonsList

        public List<Instance.SuspensionReason> getSuspensionReasonsList()
         Output only. Field indicates all the reasons the instance is in "SUSPENDED"
 state.
        repeated .google.cloud.filestore.v1.Instance.SuspensionReason suspension_reasons = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSuspensionReasonsList in interface InstanceOrBuilder
        Returns:
        A list containing the suspensionReasons.

      • getSuspensionReasonsCount

        public int getSuspensionReasonsCount()
         Output only. Field indicates all the reasons the instance is in "SUSPENDED"
 state.
        repeated .google.cloud.filestore.v1.Instance.SuspensionReason suspension_reasons = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSuspensionReasonsCount in interface InstanceOrBuilder
        Returns:
        The count of suspensionReasons.

      • getSuspensionReasons

        public Instance.SuspensionReason getSuspensionReasons​(int index)
         Output only. Field indicates all the reasons the instance is in "SUSPENDED"
 state.
        repeated .google.cloud.filestore.v1.Instance.SuspensionReason suspension_reasons = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSuspensionReasons in interface InstanceOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The suspensionReasons at the given index.

      • getSuspensionReasonsValueList

        public List<Integer> getSuspensionReasonsValueList()
         Output only. Field indicates all the reasons the instance is in "SUSPENDED"
 state.
        repeated .google.cloud.filestore.v1.Instance.SuspensionReason suspension_reasons = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSuspensionReasonsValueList in interface InstanceOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for suspensionReasons.

      • getSuspensionReasonsValue

        public int getSuspensionReasonsValue​(int index)
         Output only. Field indicates all the reasons the instance is in "SUSPENDED"
 state.
        repeated .google.cloud.filestore.v1.Instance.SuspensionReason suspension_reasons = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSuspensionReasonsValue in interface InstanceOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of suspensionReasons at the given index.

      • 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 Instance parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Instance getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Instance> 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 Instance getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder