Package com.google.cloud.filestore.v1
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 Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description booleancontainsLabels(String key)Resource labels to represent user provided metadata.com.google.protobuf.TimestampgetCreateTime()Output only.com.google.protobuf.TimestampOrBuildergetCreateTimeOrBuilder()Output only.StringgetDescription()The description of the instance (2048 characters or less).com.google.protobuf.ByteStringgetDescriptionBytes()The description of the instance (2048 characters or less).StringgetEtag()Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.com.google.protobuf.ByteStringgetEtagBytes()Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.FileShareConfiggetFileShares(int index)File system shares on the instance.intgetFileSharesCount()File system shares on the instance.List<FileShareConfig>getFileSharesList()File system shares on the instance.FileShareConfigOrBuildergetFileSharesOrBuilder(int index)File system shares on the instance.List<? extends FileShareConfigOrBuilder>getFileSharesOrBuilderList()File system shares on the instance.StringgetKmsKeyName()KMS key name used for data encryption.com.google.protobuf.ByteStringgetKmsKeyNameBytes()KMS key name used for data encryption.Map<String,String>getLabels()Deprecated.intgetLabelsCount()Resource labels to represent user provided metadata.Map<String,String>getLabelsMap()Resource labels to represent user provided metadata.StringgetLabelsOrDefault(String key, String defaultValue)Resource labels to represent user provided metadata.StringgetLabelsOrThrow(String key)Resource labels to represent user provided metadata.StringgetName()Output only.com.google.protobuf.ByteStringgetNameBytes()Output only.NetworkConfiggetNetworks(int index)VPC networks to which the instance is connected.intgetNetworksCount()VPC networks to which the instance is connected.List<NetworkConfig>getNetworksList()VPC networks to which the instance is connected.NetworkConfigOrBuildergetNetworksOrBuilder(int index)VPC networks to which the instance is connected.List<? extends NetworkConfigOrBuilder>getNetworksOrBuilderList()VPC networks to which the instance is connected.com.google.protobuf.BoolValuegetSatisfiesPzs()Output only.com.google.protobuf.BoolValueOrBuildergetSatisfiesPzsOrBuilder()Output only.Instance.StategetState()Output only.intgetStateValue()Output only.StringgetStatusMessage()Output only.com.google.protobuf.ByteStringgetStatusMessageBytes()Output only.Instance.SuspensionReasongetSuspensionReasons(int index)Output only.intgetSuspensionReasonsCount()Output only.List<Instance.SuspensionReason>getSuspensionReasonsList()Output only.intgetSuspensionReasonsValue(int index)Output only.List<Integer>getSuspensionReasonsValueList()Output only.Instance.TiergetTier()The service tier of the instance.intgetTierValue()The service tier of the instance.booleanhasCreateTime()Output only.booleanhasSatisfiesPzs()Output only.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getName
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];- Returns:
- The name.
-
getNameBytes
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];- 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.v1.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.v1.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.v1.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.v1.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;
-
getLabels
@Deprecated Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()instead.
-
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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.
-
-