- 1.52.0 (latest)
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.2.0
public interface InstanceOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
containsLabels(String key)
public abstract boolean containsLabels(String key)
Resource labels to represent user provided metadata.
map<string, string> labels = 9;
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
boolean |
getCapacityGb()
public abstract 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 | |
---|---|
Type | Description |
long |
The capacityGb. |
getCapacityStepSizeGb()
public abstract long getCapacityStepSizeGb()
Output only. The increase/decrease capacity step size.
int64 capacity_step_size_gb = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
long |
The capacityStepSizeGb. |
getCreateTime()
public abstract Timestamp getCreateTime()
Output only. The time when the instance was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time when the instance was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDescription()
public abstract String getDescription()
The description of the instance (2048 characters or less).
string description = 2;
Returns | |
---|---|
Type | Description |
String |
The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()
The description of the instance (2048 characters or less).
string description = 2;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for description. |
getDirectoryServices()
public abstract 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 | |
---|---|
Type | Description |
DirectoryServicesConfig |
The directoryServices. |
getDirectoryServicesOrBuilder()
public abstract 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;
Returns | |
---|---|
Type | Description |
DirectoryServicesConfigOrBuilder |
getEtag()
public abstract String getEtag()
Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
string etag = 12;
Returns | |
---|---|
Type | Description |
String |
The etag. |
getEtagBytes()
public abstract ByteString getEtagBytes()
Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
string etag = 12;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for etag. |
getFileShares(int index)
public abstract 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;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
FileShareConfig |
getFileSharesCount()
public abstract 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;
Returns | |
---|---|
Type | Description |
int |
getFileSharesList()
public abstract 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;
Returns | |
---|---|
Type | Description |
List<FileShareConfig> |
getFileSharesOrBuilder(int index)
public abstract 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;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
FileShareConfigOrBuilder |
getFileSharesOrBuilderList()
public abstract 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;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.filestore.v1beta1.FileShareConfigOrBuilder> |
getKmsKeyName()
public abstract String getKmsKeyName()
KMS key name used for data encryption.
string kms_key_name = 14;
Returns | |
---|---|
Type | Description |
String |
The kmsKeyName. |
getKmsKeyNameBytes()
public abstract ByteString getKmsKeyNameBytes()
KMS key name used for data encryption.
string kms_key_name = 14;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for kmsKeyName. |
getLabels() (deprecated)
public abstract Map<String,String> getLabels()
Use #getLabelsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsCount()
public abstract int getLabelsCount()
Resource labels to represent user provided metadata.
map<string, string> labels = 9;
Returns | |
---|---|
Type | Description |
int |
getLabelsMap()
public abstract Map<String,String> getLabelsMap()
Resource labels to represent user provided metadata.
map<string, string> labels = 9;
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsOrDefault(String key, String defaultValue)
public abstract String getLabelsOrDefault(String key, String defaultValue)
Resource labels to represent user provided metadata.
map<string, string> labels = 9;
Parameters | |
---|---|
Name | Description |
key |
String |
defaultValue |
String |
Returns | |
---|---|
Type | Description |
String |
getLabelsOrThrow(String key)
public abstract String getLabelsOrThrow(String key)
Resource labels to represent user provided metadata.
map<string, string> labels = 9;
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
String |
getMaxCapacityGb()
public abstract long getMaxCapacityGb()
Output only. The max capacity of the instance.
int64 max_capacity_gb = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
long |
The maxCapacityGb. |
getMaxShareCount()
public abstract long getMaxShareCount()
The max number of shares allowed.
int64 max_share_count = 18;
Returns | |
---|---|
Type | Description |
long |
The maxShareCount. |
getMultiShareEnabled()
public abstract 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 | |
---|---|
Type | Description |
boolean |
The multiShareEnabled. |
getName()
public abstract 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 | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public abstract 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 | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getNetworks(int index)
public abstract 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;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
NetworkConfig |
getNetworksCount()
public abstract 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;
Returns | |
---|---|
Type | Description |
int |
getNetworksList()
public abstract 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;
Returns | |
---|---|
Type | Description |
List<NetworkConfig> |
getNetworksOrBuilder(int index)
public abstract 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;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
NetworkConfigOrBuilder |
getNetworksOrBuilderList()
public abstract 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;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.filestore.v1beta1.NetworkConfigOrBuilder> |
getProtocol()
public abstract 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 | |
---|---|
Type | Description |
Instance.FileProtocol |
The protocol. |
getProtocolValue()
public abstract 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 | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for protocol. |
getSatisfiesPzi()
public abstract boolean getSatisfiesPzi()
Output only. Reserved for future use.
bool satisfies_pzi = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
The satisfiesPzi. |
getSatisfiesPzs()
public abstract BoolValue getSatisfiesPzs()
Output only. Reserved for future use.
.google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
BoolValue |
The satisfiesPzs. |
getSatisfiesPzsOrBuilder()
public abstract BoolValueOrBuilder getSatisfiesPzsOrBuilder()
Output only. Reserved for future use.
.google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
BoolValueOrBuilder |
getState()
public abstract Instance.State getState()
Output only. The instance state.
.google.cloud.filestore.v1beta1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Instance.State |
The state. |
getStateValue()
public abstract int getStateValue()
Output only. The instance state.
.google.cloud.filestore.v1beta1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for state. |
getStatusMessage()
public abstract String getStatusMessage()
Output only. Additional information about the instance state, if available.
string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String |
The statusMessage. |
getStatusMessageBytes()
public abstract ByteString getStatusMessageBytes()
Output only. Additional information about the instance state, if available.
string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for statusMessage. |
getSuspensionReasons(int index)
public abstract 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];
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
Instance.SuspensionReason |
The suspensionReasons at the given index. |
getSuspensionReasonsCount()
public abstract 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 | |
---|---|
Type | Description |
int |
The count of suspensionReasons. |
getSuspensionReasonsList()
public abstract 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 | |
---|---|
Type | Description |
List<SuspensionReason> |
A list containing the suspensionReasons. |
getSuspensionReasonsValue(int index)
public abstract 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];
Parameter | |
---|---|
Name | Description |
index |
int The index of the value to return. |
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire of suspensionReasons at the given index. |
getSuspensionReasonsValueList()
public abstract 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 | |
---|---|
Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for suspensionReasons. |
getTier()
public abstract Instance.Tier getTier()
The service tier of the instance.
.google.cloud.filestore.v1beta1.Instance.Tier tier = 8;
Returns | |
---|---|
Type | Description |
Instance.Tier |
The tier. |
getTierValue()
public abstract int getTierValue()
The service tier of the instance.
.google.cloud.filestore.v1beta1.Instance.Tier tier = 8;
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for tier. |
hasCreateTime()
public abstract boolean hasCreateTime()
Output only. The time when the instance was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the createTime field is set. |
hasDirectoryServices()
public abstract 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 | |
---|---|
Type | Description |
boolean |
Whether the directoryServices field is set. |
hasSatisfiesPzs()
public abstract boolean hasSatisfiesPzs()
Output only. Reserved for future use.
.google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the satisfiesPzs field is set. |