Package com.google.cloud.filestore.v1beta1

Interface InstanceOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Instance, Instance.Builder
    public interface InstanceOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

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

      • getNameBytes

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

      • getDescription

        String getDescription()
         The description of the instance (2048 characters or less).
        string description = 2;
        Returns:
        The description.

      • getDescriptionBytes

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

      • getStateValue

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

      • getState

        Instance.State getState()
         Output only. The instance state.
        .google.cloud.filestore.v1beta1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The state.

      • getStatusMessage

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

      • getStatusMessageBytes

        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];
        Returns:
        The bytes for statusMessage.

      • hasCreateTime

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

      • getCreateTime

        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];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        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];

      • getTierValue

        int getTierValue()
         The service tier of the instance.
        .google.cloud.filestore.v1beta1.Instance.Tier tier = 8;
        Returns:
        The enum numeric value on the wire for tier.

      • getTier

        Instance.Tier getTier()
         The service tier of the instance.
        .google.cloud.filestore.v1beta1.Instance.Tier tier = 8;
        Returns:
        The tier.

      • getLabelsCount

        int getLabelsCount()
         Resource labels to represent user provided metadata.
        map<string, string> labels = 9;

      • containsLabels

        boolean containsLabels​(String key)
         Resource labels to represent user provided metadata.
        map<string, string> labels = 9;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Resource labels to represent user provided metadata.
        map<string, string> labels = 9;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Resource labels to represent user provided metadata.
        map<string, string> labels = 9;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Resource labels to represent user provided metadata.
        map<string, string> labels = 9;

      • getFileSharesList

        List<FileShareConfig> getFileSharesList()
         File system shares on the instance.
 For this version, only a single file share is supported.
        repeated .google.cloud.filestore.v1beta1.FileShareConfig file_shares = 10;

      • getFileShares

        FileShareConfig getFileShares​(int index)
         File system shares on the instance.
 For this version, only a single file share is supported.
        repeated .google.cloud.filestore.v1beta1.FileShareConfig file_shares = 10;

      • getFileSharesCount

        int getFileSharesCount()
         File system shares on the instance.
 For this version, only a single file share is supported.
        repeated .google.cloud.filestore.v1beta1.FileShareConfig file_shares = 10;

      • getFileSharesOrBuilderList

        List<? extends FileShareConfigOrBuilder> getFileSharesOrBuilderList()
         File system shares on the instance.
 For this version, only a single file share is supported.
        repeated .google.cloud.filestore.v1beta1.FileShareConfig file_shares = 10;

      • getFileSharesOrBuilder

        FileShareConfigOrBuilder getFileSharesOrBuilder​(int index)
         File system shares on the instance.
 For this version, only a single file share is supported.
        repeated .google.cloud.filestore.v1beta1.FileShareConfig file_shares = 10;

      • getNetworksList

        List<NetworkConfig> getNetworksList()
         VPC networks to which the instance is connected.
 For this version, only a single network is supported.
        repeated .google.cloud.filestore.v1beta1.NetworkConfig networks = 11;

      • getNetworks

        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.v1beta1.NetworkConfig networks = 11;

      • getNetworksCount

        int getNetworksCount()
         VPC networks to which the instance is connected.
 For this version, only a single network is supported.
        repeated .google.cloud.filestore.v1beta1.NetworkConfig networks = 11;

      • getNetworksOrBuilderList

        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.v1beta1.NetworkConfig networks = 11;

      • getNetworksOrBuilder

        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.v1beta1.NetworkConfig networks = 11;

      • getEtag

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

      • getEtagBytes

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

      • hasSatisfiesPzs

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

      • getSatisfiesPzs

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

      • getSatisfiesPzsOrBuilder

        com.google.protobuf.BoolValueOrBuilder getSatisfiesPzsOrBuilder()
         Output only. Reserved for future use.
        .google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getKmsKeyName

        String getKmsKeyName()
         KMS key name used for data encryption.
        string kms_key_name = 14;
        Returns:
        The kmsKeyName.

      • getKmsKeyNameBytes

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

      • getSuspensionReasonsList

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

      • getSuspensionReasonsCount

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

      • getSuspensionReasons

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

      • getSuspensionReasonsValueList

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

      • getSuspensionReasonsValue

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

      • getMaxCapacityGb

        long getMaxCapacityGb()
         Output only. The max capacity of the instance.
        int64 max_capacity_gb = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The maxCapacityGb.

      • getCapacityStepSizeGb

        long getCapacityStepSizeGb()
         Output only. The increase/decrease capacity step size.
        int64 capacity_step_size_gb = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The capacityStepSizeGb.

      • getMaxShareCount

        long getMaxShareCount()
         The max number of shares allowed.
        int64 max_share_count = 18;
        Returns:
        The maxShareCount.

      • getCapacityGb

        long getCapacityGb()
         The storage capacity of the instance in gigabytes (GB = 1024^3 bytes).
 This capacity can be increased up to `max_capacity_gb` GB in multipliers
 of `capacity_step_size_gb` GB.
        int64 capacity_gb = 19;
        Returns:
        The capacityGb.

      • getMultiShareEnabled

        boolean getMultiShareEnabled()
         Indicates whether this instance uses a multi-share configuration with which
 it can have more than one file-share or none at all. File-shares are added,
 updated and removed through the separate file-share APIs.
        bool multi_share_enabled = 20;
        Returns:
        The multiShareEnabled.

      • getProtocolValue

        int getProtocolValue()
         Immutable. The protocol indicates the access protocol for all shares in the
 instance. This field is immutable and it cannot be changed after the
 instance has been created. Default value: `NFS_V3`.
        .google.cloud.filestore.v1beta1.Instance.FileProtocol protocol = 21 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The enum numeric value on the wire for protocol.

      • getProtocol

        Instance.FileProtocol getProtocol()
         Immutable. The protocol indicates the access protocol for all shares in the
 instance. This field is immutable and it cannot be changed after the
 instance has been created. Default value: `NFS_V3`.
        .google.cloud.filestore.v1beta1.Instance.FileProtocol protocol = 21 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The protocol.

      • hasDirectoryServices

        boolean hasDirectoryServices()
         Directory Services configuration for Kerberos-based authentication.
 Should only be set if protocol is "NFS_V4_1".
        .google.cloud.filestore.v1beta1.DirectoryServicesConfig directory_services = 24;
        Returns:
        Whether the directoryServices field is set.

      • getDirectoryServices

        DirectoryServicesConfig getDirectoryServices()
         Directory Services configuration for Kerberos-based authentication.
 Should only be set if protocol is "NFS_V4_1".
        .google.cloud.filestore.v1beta1.DirectoryServicesConfig directory_services = 24;
        Returns:
        The directoryServices.

      • getDirectoryServicesOrBuilder

        DirectoryServicesConfigOrBuilder getDirectoryServicesOrBuilder()
         Directory Services configuration for Kerberos-based authentication.
 Should only be set if protocol is "NFS_V4_1".
        .google.cloud.filestore.v1beta1.DirectoryServicesConfig directory_services = 24;