Class Instance.Builder (1.55.0) 

public static final class Instance.Builder extends GeneratedMessageV3.Builder<Instance.Builder> implements InstanceOrBuilder

A Filestore instance.

Protobuf type google.cloud.filestore.v1beta1.Instance

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Instance.Builder

Implements

InstanceOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllFileShares(Iterable<? extends FileShareConfig> values)

public Instance.Builder addAllFileShares(Iterable<? extends FileShareConfig> values)

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
values Iterable<? extends com.google.cloud.filestore.v1beta1.FileShareConfig>
Returns
Type Description
Instance.Builder

addAllNetworks(Iterable<? extends NetworkConfig> values)

public Instance.Builder addAllNetworks(Iterable<? extends NetworkConfig> values)

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
values Iterable<? extends com.google.cloud.filestore.v1beta1.NetworkConfig>
Returns
Type Description
Instance.Builder

addAllSuspensionReasons(Iterable<? extends Instance.SuspensionReason> values)

public Instance.Builder addAllSuspensionReasons(Iterable<? extends Instance.SuspensionReason> values)

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
values Iterable<? extends com.google.cloud.filestore.v1beta1.Instance.SuspensionReason>

The suspensionReasons to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addAllSuspensionReasonsValue(Iterable<Integer> values)

public Instance.Builder addAllSuspensionReasonsValue(Iterable<Integer> values)

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
values Iterable<Integer>

The enum numeric values on the wire for suspensionReasons to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addFileShares(FileShareConfig value)

public Instance.Builder addFileShares(FileShareConfig value)

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
value FileShareConfig
Returns
Type Description
Instance.Builder

addFileShares(FileShareConfig.Builder builderForValue)

public Instance.Builder addFileShares(FileShareConfig.Builder builderForValue)

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
builderForValue FileShareConfig.Builder
Returns
Type Description
Instance.Builder

addFileShares(int index, FileShareConfig value)

public Instance.Builder addFileShares(int index, FileShareConfig value)

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;

Parameters
Name Description
index int
value FileShareConfig
Returns
Type Description
Instance.Builder

addFileShares(int index, FileShareConfig.Builder builderForValue)

public Instance.Builder addFileShares(int index, FileShareConfig.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue FileShareConfig.Builder
Returns
Type Description
Instance.Builder

addFileSharesBuilder()

public FileShareConfig.Builder addFileSharesBuilder()

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
FileShareConfig.Builder

addFileSharesBuilder(int index)

public FileShareConfig.Builder addFileSharesBuilder(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.Builder

addNetworks(NetworkConfig value)

public Instance.Builder addNetworks(NetworkConfig value)

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
value NetworkConfig
Returns
Type Description
Instance.Builder

addNetworks(NetworkConfig.Builder builderForValue)

public Instance.Builder addNetworks(NetworkConfig.Builder builderForValue)

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
builderForValue NetworkConfig.Builder
Returns
Type Description
Instance.Builder

addNetworks(int index, NetworkConfig value)

public Instance.Builder addNetworks(int index, NetworkConfig value)

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;

Parameters
Name Description
index int
value NetworkConfig
Returns
Type Description
Instance.Builder

addNetworks(int index, NetworkConfig.Builder builderForValue)

public Instance.Builder addNetworks(int index, NetworkConfig.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue NetworkConfig.Builder
Returns
Type Description
Instance.Builder

addNetworksBuilder()

public NetworkConfig.Builder addNetworksBuilder()

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
NetworkConfig.Builder

addNetworksBuilder(int index)

public NetworkConfig.Builder addNetworksBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Instance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Instance.Builder
Overrides

addSuspensionReasons(Instance.SuspensionReason value)

public Instance.Builder addSuspensionReasons(Instance.SuspensionReason value)

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
value Instance.SuspensionReason

The suspensionReasons to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

addSuspensionReasonsValue(int value)

public Instance.Builder addSuspensionReasonsValue(int value)

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
value int

The enum numeric value on the wire for suspensionReasons to add.
Returns
Type Description
Instance.Builder

This builder for chaining.

build()

public Instance build()
Returns
Type Description
Instance

buildPartial()

public Instance buildPartial()
Returns
Type Description
Instance

clear()

public Instance.Builder clear()
Returns
Type Description
Instance.Builder
Overrides

clearCapacityGb()

public Instance.Builder clearCapacityGb()

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
Instance.Builder

This builder for chaining.

clearCapacityStepSizeGb()

public Instance.Builder clearCapacityStepSizeGb()

Output only. The increase/decrease capacity step size.

int64 capacity_step_size_gb = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearCreateTime()

public Instance.Builder clearCreateTime()

Output only. The time when the instance was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

clearDescription()

public Instance.Builder clearDescription()

The description of the instance (2048 characters or less).

string description = 2;

Returns
Type Description
Instance.Builder

This builder for chaining.

clearDirectoryServices()

public Instance.Builder clearDirectoryServices()

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
Instance.Builder

clearEtag()

public Instance.Builder clearEtag()

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

string etag = 12;

Returns
Type Description
Instance.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Instance.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Instance.Builder
Overrides

clearFileShares()

public Instance.Builder clearFileShares()

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
Instance.Builder

clearKmsKeyName()

public Instance.Builder clearKmsKeyName()

KMS key name used for data encryption.

string kms_key_name = 14;

Returns
Type Description
Instance.Builder

This builder for chaining.

clearLabels()

public Instance.Builder clearLabels()
Returns
Type Description
Instance.Builder

clearMaxCapacityGb()

public Instance.Builder clearMaxCapacityGb()

Output only. The max capacity of the instance.

int64 max_capacity_gb = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearMaxShareCount()

public Instance.Builder clearMaxShareCount()

The max number of shares allowed.

int64 max_share_count = 18;

Returns
Type Description
Instance.Builder

This builder for chaining.

clearMultiShareEnabled()

public Instance.Builder clearMultiShareEnabled()

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
Instance.Builder

This builder for chaining.

clearName()

public Instance.Builder clearName()

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
Instance.Builder

This builder for chaining.

clearNetworks()

public Instance.Builder clearNetworks()

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
Instance.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Instance.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Instance.Builder
Overrides

clearProtocol()

public Instance.Builder clearProtocol()

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.Builder

This builder for chaining.

clearSatisfiesPzi()

public Instance.Builder clearSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearSatisfiesPzs()

public Instance.Builder clearSatisfiesPzs()

Output only. Reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

clearState()

public Instance.Builder clearState()

Output only. The instance state.

.google.cloud.filestore.v1beta1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearStatusMessage()

public Instance.Builder clearStatusMessage()

Output only. Additional information about the instance state, if available.

string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Instance.Builder

This builder for chaining.

clearSuspensionReasons()

public Instance.Builder clearSuspensionReasons()

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
Instance.Builder

This builder for chaining.

clearTier()

public Instance.Builder clearTier()

The service tier of the instance.

.google.cloud.filestore.v1beta1.Instance.Tier tier = 8;

Returns
Type Description
Instance.Builder

This builder for chaining.

clone()

public Instance.Builder clone()
Returns
Type Description
Instance.Builder
Overrides

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
Returns
Type Description
boolean

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the instance was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()
Returns
Type Description
Instance

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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;

Returns
Type Description
DirectoryServicesConfig

The directoryServices.

getDirectoryServicesBuilder()

public DirectoryServicesConfig.Builder getDirectoryServicesBuilder()

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.Builder

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;

Returns
Type Description
DirectoryServicesConfigOrBuilder

getEtag()

public 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 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
Returns
Type Description
FileShareConfig

getFileSharesBuilder(int index)

public FileShareConfig.Builder getFileSharesBuilder(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.Builder

getFileSharesBuilderList()

public List<FileShareConfig.Builder> getFileSharesBuilderList()

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<Builder>

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;

Returns
Type Description
List<FileShareConfig>

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
Returns
Type Description
FileShareConfigOrBuilder

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() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

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;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public 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 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 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.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public 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 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
Returns
Type Description
NetworkConfig

getNetworksBuilder(int index)

public NetworkConfig.Builder getNetworksBuilder(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.Builder

getNetworksBuilderList()

public List<NetworkConfig.Builder> getNetworksBuilderList()

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<Builder>

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;

Returns
Type Description
List<NetworkConfig>

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
Returns
Type Description
NetworkConfigOrBuilder

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>

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

Returns
Type Description
Instance.FileProtocol

The protocol.

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.

getSatisfiesPzi()

public 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 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.

getSatisfiesPzsBuilder()

public BoolValue.Builder getSatisfiesPzsBuilder()

Output only. Reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getSatisfiesPzsOrBuilder()

public 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 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 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.
Returns
Type Description
Instance.SuspensionReason

The suspensionReasons at the given index.

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

Returns
Type Description
List<SuspensionReason>

A list containing the suspensionReasons.

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;

Returns
Type Description
Instance.Tier

The tier.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Instance.Builder mergeCreateTime(Timestamp value)

Output only. The time when the instance was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Instance.Builder

mergeDirectoryServices(DirectoryServicesConfig value)

public Instance.Builder mergeDirectoryServices(DirectoryServicesConfig value)

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;

Parameter
Name Description
value DirectoryServicesConfig
Returns
Type Description
Instance.Builder

mergeFrom(Instance other)

public Instance.Builder mergeFrom(Instance other)
Parameter
Name Description
other Instance
Returns
Type Description
Instance.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Instance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Instance.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Instance.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Instance.Builder
Overrides

mergeSatisfiesPzs(BoolValue value)

public Instance.Builder mergeSatisfiesPzs(BoolValue value)

Output only. Reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value BoolValue
Returns
Type Description
Instance.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Instance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Instance.Builder
Overrides

putAllLabels(Map<String,String> values)

public Instance.Builder putAllLabels(Map<String,String> values)

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Instance.Builder

putLabels(String key, String value)

public Instance.Builder putLabels(String key, String value)

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

Parameters
Name Description
key String
value String
Returns
Type Description
Instance.Builder

removeFileShares(int index)

public Instance.Builder removeFileShares(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
Instance.Builder

removeLabels(String key)

public Instance.Builder removeLabels(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 9;

Parameter
Name Description
key String
Returns
Type Description
Instance.Builder

removeNetworks(int index)

public Instance.Builder removeNetworks(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
Instance.Builder

setCapacityGb(long value)

public Instance.Builder setCapacityGb(long value)

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;

Parameter
Name Description
value long

The capacityGb to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setCapacityStepSizeGb(long value)

public Instance.Builder setCapacityStepSizeGb(long value)

Output only. The increase/decrease capacity step size.

int64 capacity_step_size_gb = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

The capacityStepSizeGb to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Instance.Builder setCreateTime(Timestamp value)

Output only. The time when the instance was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Instance.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Instance.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the instance was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Instance.Builder

setDescription(String value)

public Instance.Builder setDescription(String value)

The description of the instance (2048 characters or less).

string description = 2;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Instance.Builder setDescriptionBytes(ByteString value)

The description of the instance (2048 characters or less).

string description = 2;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setDirectoryServices(DirectoryServicesConfig value)

public Instance.Builder setDirectoryServices(DirectoryServicesConfig value)

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;

Parameter
Name Description
value DirectoryServicesConfig
Returns
Type Description
Instance.Builder

setDirectoryServices(DirectoryServicesConfig.Builder builderForValue)

public Instance.Builder setDirectoryServices(DirectoryServicesConfig.Builder builderForValue)

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;

Parameter
Name Description
builderForValue DirectoryServicesConfig.Builder
Returns
Type Description
Instance.Builder

setEtag(String value)

public Instance.Builder setEtag(String value)

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

string etag = 12;

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Instance.Builder setEtagBytes(ByteString value)

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

string etag = 12;

Parameter
Name Description
value ByteString

The bytes for etag to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Instance.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Instance.Builder
Overrides

setFileShares(int index, FileShareConfig value)

public Instance.Builder setFileShares(int index, FileShareConfig value)

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;

Parameters
Name Description
index int
value FileShareConfig
Returns
Type Description
Instance.Builder

setFileShares(int index, FileShareConfig.Builder builderForValue)

public Instance.Builder setFileShares(int index, FileShareConfig.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue FileShareConfig.Builder
Returns
Type Description
Instance.Builder

setKmsKeyName(String value)

public Instance.Builder setKmsKeyName(String value)

KMS key name used for data encryption.

string kms_key_name = 14;

Parameter
Name Description
value String

The kmsKeyName to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setKmsKeyNameBytes(ByteString value)

public Instance.Builder setKmsKeyNameBytes(ByteString value)

KMS key name used for data encryption.

string kms_key_name = 14;

Parameter
Name Description
value ByteString

The bytes for kmsKeyName to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setMaxCapacityGb(long value)

public Instance.Builder setMaxCapacityGb(long value)

Output only. The max capacity of the instance.

int64 max_capacity_gb = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

The maxCapacityGb to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setMaxShareCount(long value)

public Instance.Builder setMaxShareCount(long value)

The max number of shares allowed.

int64 max_share_count = 18;

Parameter
Name Description
value long

The maxShareCount to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setMultiShareEnabled(boolean value)

public Instance.Builder setMultiShareEnabled(boolean value)

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;

Parameter
Name Description
value boolean

The multiShareEnabled to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setName(String value)

public Instance.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Instance.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setNetworks(int index, NetworkConfig value)

public Instance.Builder setNetworks(int index, NetworkConfig value)

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;

Parameters
Name Description
index int
value NetworkConfig
Returns
Type Description
Instance.Builder

setNetworks(int index, NetworkConfig.Builder builderForValue)

public Instance.Builder setNetworks(int index, NetworkConfig.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue NetworkConfig.Builder
Returns
Type Description
Instance.Builder

setProtocol(Instance.FileProtocol value)

public Instance.Builder setProtocol(Instance.FileProtocol value)

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

Parameter
Name Description
value Instance.FileProtocol

The protocol to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setProtocolValue(int value)

public Instance.Builder setProtocolValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for protocol to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Instance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Instance.Builder
Overrides

setSatisfiesPzi(boolean value)

public Instance.Builder setSatisfiesPzi(boolean value)

Output only. Reserved for future use.

bool satisfies_pzi = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzi to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setSatisfiesPzs(BoolValue value)

public Instance.Builder setSatisfiesPzs(BoolValue value)

Output only. Reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value BoolValue
Returns
Type Description
Instance.Builder

setSatisfiesPzs(BoolValue.Builder builderForValue)

public Instance.Builder setSatisfiesPzs(BoolValue.Builder builderForValue)

Output only. Reserved for future use.

.google.protobuf.BoolValue satisfies_pzs = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Instance.Builder

setState(Instance.State value)

public Instance.Builder setState(Instance.State value)

Output only. The instance state.

.google.cloud.filestore.v1beta1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Instance.State

The state to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setStateValue(int value)

public Instance.Builder setStateValue(int value)

Output only. The instance state.

.google.cloud.filestore.v1beta1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setStatusMessage(String value)

public Instance.Builder setStatusMessage(String value)

Output only. Additional information about the instance state, if available.

string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The statusMessage to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setStatusMessageBytes(ByteString value)

public Instance.Builder setStatusMessageBytes(ByteString value)

Output only. Additional information about the instance state, if available.

string status_message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for statusMessage to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setSuspensionReasons(int index, Instance.SuspensionReason value)

public Instance.Builder setSuspensionReasons(int index, Instance.SuspensionReason value)

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
Name Description
index int

The index to set the value at.
value Instance.SuspensionReason

The suspensionReasons to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setSuspensionReasonsValue(int index, int value)

public Instance.Builder setSuspensionReasonsValue(int index, int value)

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
Name Description
index int

The index to set the value at.
value int

The enum numeric value on the wire for suspensionReasons to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setTier(Instance.Tier value)

public Instance.Builder setTier(Instance.Tier value)

The service tier of the instance.

.google.cloud.filestore.v1beta1.Instance.Tier tier = 8;

Parameter
Name Description
value Instance.Tier

The tier to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setTierValue(int value)

public Instance.Builder setTierValue(int value)

The service tier of the instance.

.google.cloud.filestore.v1beta1.Instance.Tier tier = 8;

Parameter
Name Description
value int

The enum numeric value on the wire for tier to set.
Returns
Type Description
Instance.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Instance.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Instance.Builder
Overrides