public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder
A Filestore instance.
Protobuf type google.cloud.filestore.v1beta1.Instance
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
CAPACITY_GB_FIELD_NUMBER
public static final int CAPACITY_GB_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CAPACITY_STEP_SIZE_GB_FIELD_NUMBER
public static final int CAPACITY_STEP_SIZE_GB_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DIRECTORY_SERVICES_FIELD_NUMBER
public static final int DIRECTORY_SERVICES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FILE_SHARES_FIELD_NUMBER
public static final int FILE_SHARES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KMS_KEY_NAME_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MAX_CAPACITY_GB_FIELD_NUMBER
public static final int MAX_CAPACITY_GB_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MAX_SHARE_COUNT_FIELD_NUMBER
public static final int MAX_SHARE_COUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MULTI_SHARE_ENABLED_FIELD_NUMBER
public static final int MULTI_SHARE_ENABLED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NETWORKS_FIELD_NUMBER
public static final int NETWORKS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROTOCOL_FIELD_NUMBER
public static final int PROTOCOL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SATISFIES_PZS_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATUS_MESSAGE_FIELD_NUMBER
public static final int STATUS_MESSAGE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SUSPENSION_REASONS_FIELD_NUMBER
public static final int SUSPENSION_REASONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TIER_FIELD_NUMBER
public static final int TIER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Instance getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Instance.Builder newBuilder()
newBuilder(Instance prototype)
public static Instance.Builder newBuilder(Instance prototype)
| Parameter |
|---|
| Name | Description |
prototype | Instance
|
public static Instance parseDelimitedFrom(InputStream input)
public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Instance parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Instance parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(CodedInputStream input)
public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(InputStream input)
public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Instance parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Instance> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Resource labels to represent user provided metadata.
map<string, string> labels = 9;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCapacityGb()
public 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 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 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 TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time when the instance was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Instance getDefaultInstanceForType()
getDescription()
public String getDescription()
The description of the instance (2048 characters or less).
string description = 2;
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
The description of the instance (2048 characters or less).
string description = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
getDirectoryServices()
public 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;
getDirectoryServicesOrBuilder()
public 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;
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 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 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
|
getFileSharesCount()
public 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 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;
getFileSharesOrBuilder(int index)
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.v1beta1.FileShareConfig file_shares = 10;
| Parameter |
|---|
| Name | Description |
index | int
|
getFileSharesOrBuilderList()
public 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 String getKmsKeyName()
KMS key name used for data encryption.
string kms_key_name = 14;
| Returns |
|---|
| Type | Description |
String | The kmsKeyName.
|
getKmsKeyNameBytes()
public ByteString getKmsKeyNameBytes()
KMS key name used for data encryption.
string kms_key_name = 14;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for kmsKeyName.
|
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Resource labels to represent user provided metadata.
map<string, string> labels = 9;
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()
Resource labels to represent user provided metadata.
map<string, string> labels = 9;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Resource labels to represent user provided metadata.
map<string, string> labels = 9;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Resource labels to represent user provided metadata.
map<string, string> labels = 9;
| Parameter |
|---|
| Name | Description |
key | String
|
getMaxCapacityGb()
public 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 long getMaxShareCount()
The max number of shares allowed.
int64 max_share_count = 18;
| Returns |
|---|
| Type | Description |
long | The maxShareCount.
|
getMultiShareEnabled()
public 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()
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 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 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
|
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.v1beta1.NetworkConfig networks = 11;
| Returns |
|---|
| Type | Description |
int | |
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.v1beta1.NetworkConfig networks = 11;
getNetworksOrBuilder(int index)
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.v1beta1.NetworkConfig networks = 11;
| Parameter |
|---|
| Name | Description |
index | int
|
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.v1beta1.NetworkConfig networks = 11;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.filestore.v1beta1.NetworkConfigOrBuilder> | |
getParserForType()
public Parser<Instance> getParserForType()
Overrides
getProtocol()
public 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];
getProtocolValue()
public 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.
|
getSatisfiesPzs()
public 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 BoolValueOrBuilder getSatisfiesPzsOrBuilder()
Output only. Reserved for future use.
.google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getState()
public Instance.State getState()
Output only. The instance state.
.google.cloud.filestore.v1beta1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public 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 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 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 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.
|
getSuspensionReasonsCount()
public 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 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];
getSuspensionReasonsValue(int index)
public 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 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 Instance.Tier getTier()
The service tier of the instance.
.google.cloud.filestore.v1beta1.Instance.Tier tier = 8;
getTierValue()
public 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 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 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 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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Instance.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Instance.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
