Class Share.Builder (1.23.0)

public static final class Share.Builder extends GeneratedMessageV3.Builder<Share.Builder> implements ShareOrBuilder

A Filestore share.

Protobuf type google.cloud.filestore.v1beta1.Share

Implements

ShareOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllNfsExportOptions(Iterable<? extends NfsExportOptions> values)

public Share.Builder addAllNfsExportOptions(Iterable<? extends NfsExportOptions> values)

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.filestore.v1beta1.NfsExportOptions>
Returns
TypeDescription
Share.Builder

addNfsExportOptions(NfsExportOptions value)

public Share.Builder addNfsExportOptions(NfsExportOptions value)

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Parameter
NameDescription
valueNfsExportOptions
Returns
TypeDescription
Share.Builder

addNfsExportOptions(NfsExportOptions.Builder builderForValue)

public Share.Builder addNfsExportOptions(NfsExportOptions.Builder builderForValue)

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Parameter
NameDescription
builderForValueNfsExportOptions.Builder
Returns
TypeDescription
Share.Builder

addNfsExportOptions(int index, NfsExportOptions value)

public Share.Builder addNfsExportOptions(int index, NfsExportOptions value)

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Parameters
NameDescription
indexint
valueNfsExportOptions
Returns
TypeDescription
Share.Builder

addNfsExportOptions(int index, NfsExportOptions.Builder builderForValue)

public Share.Builder addNfsExportOptions(int index, NfsExportOptions.Builder builderForValue)

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Parameters
NameDescription
indexint
builderForValueNfsExportOptions.Builder
Returns
TypeDescription
Share.Builder

addNfsExportOptionsBuilder()

public NfsExportOptions.Builder addNfsExportOptionsBuilder()

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Returns
TypeDescription
NfsExportOptions.Builder

addNfsExportOptionsBuilder(int index)

public NfsExportOptions.Builder addNfsExportOptionsBuilder(int index)

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
NfsExportOptions.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Share.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Share.Builder
Overrides

build()

public Share build()
Returns
TypeDescription
Share

buildPartial()

public Share buildPartial()
Returns
TypeDescription
Share

clear()

public Share.Builder clear()
Returns
TypeDescription
Share.Builder
Overrides

clearCapacityGb()

public Share.Builder clearCapacityGb()

File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0.

int64 capacity_gb = 4;

Returns
TypeDescription
Share.Builder

This builder for chaining.

clearCreateTime()

public Share.Builder clearCreateTime()

Output only. The time when the share was created.

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

Returns
TypeDescription
Share.Builder

clearDescription()

public Share.Builder clearDescription()

A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected.

string description = 3;

Returns
TypeDescription
Share.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Share.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Share.Builder
Overrides

clearLabels()

public Share.Builder clearLabels()
Returns
TypeDescription
Share.Builder

clearMountName()

public Share.Builder clearMountName()

The mount name of the share. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.

string mount_name = 2;

Returns
TypeDescription
Share.Builder

This builder for chaining.

clearName()

public Share.Builder clearName()

Output only. The resource name of the share, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Share.Builder

This builder for chaining.

clearNfsExportOptions()

public Share.Builder clearNfsExportOptions()

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Returns
TypeDescription
Share.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Share.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Share.Builder
Overrides

clearState()

public Share.Builder clearState()

Output only. The share state.

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

Returns
TypeDescription
Share.Builder

This builder for chaining.

clone()

public Share.Builder clone()
Returns
TypeDescription
Share.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getCapacityGb()

public long getCapacityGb()

File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0.

int64 capacity_gb = 4;

Returns
TypeDescription
long

The capacityGb.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the share was created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the share was created.

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

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the share was created.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Share getDefaultInstanceForType()
Returns
TypeDescription
Share

getDescription()

public String getDescription()

A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected.

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Returns
TypeDescription
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 = 8;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMountName()

public String getMountName()

The mount name of the share. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.

string mount_name = 2;

Returns
TypeDescription
String

The mountName.

getMountNameBytes()

public ByteString getMountNameBytes()

The mount name of the share. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.

string mount_name = 2;

Returns
TypeDescription
ByteString

The bytes for mountName.

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

Output only. The resource name of the share, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the share, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getNfsExportOptions(int index)

public NfsExportOptions getNfsExportOptions(int index)

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
NfsExportOptions

getNfsExportOptionsBuilder(int index)

public NfsExportOptions.Builder getNfsExportOptionsBuilder(int index)

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
NfsExportOptions.Builder

getNfsExportOptionsBuilderList()

public List<NfsExportOptions.Builder> getNfsExportOptionsBuilderList()

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Returns
TypeDescription
List<Builder>

getNfsExportOptionsCount()

public int getNfsExportOptionsCount()

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Returns
TypeDescription
int

getNfsExportOptionsList()

public List<NfsExportOptions> getNfsExportOptionsList()

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Returns
TypeDescription
List<NfsExportOptions>

getNfsExportOptionsOrBuilder(int index)

public NfsExportOptionsOrBuilder getNfsExportOptionsOrBuilder(int index)

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
NfsExportOptionsOrBuilder

getNfsExportOptionsOrBuilderList()

public List<? extends NfsExportOptionsOrBuilder> getNfsExportOptionsOrBuilderList()

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Returns
TypeDescription
List<? extends com.google.cloud.filestore.v1beta1.NfsExportOptionsOrBuilder>

getState()

public Share.State getState()

Output only. The share state.

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

Returns
TypeDescription
Share.State

The state.

getStateValue()

public int getStateValue()

Output only. The share state.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the share was created.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public Share.Builder mergeCreateTime(Timestamp value)

Output only. The time when the share was created.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Share.Builder

mergeFrom(Share other)

public Share.Builder mergeFrom(Share other)
Parameter
NameDescription
otherShare
Returns
TypeDescription
Share.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Share.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Share.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Share.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Share.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Share.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Share.Builder
Overrides

putAllLabels(Map<String,String> values)

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

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Share.Builder

putLabels(String key, String value)

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

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Share.Builder

removeLabels(String key)

public Share.Builder removeLabels(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
Share.Builder

removeNfsExportOptions(int index)

public Share.Builder removeNfsExportOptions(int index)

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
Share.Builder

setCapacityGb(long value)

public Share.Builder setCapacityGb(long value)

File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0.

int64 capacity_gb = 4;

Parameter
NameDescription
valuelong

The capacityGb to set.

Returns
TypeDescription
Share.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Share.Builder setCreateTime(Timestamp value)

Output only. The time when the share was created.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Share.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Share.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the share was created.

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Share.Builder

setDescription(String value)

public Share.Builder setDescription(String value)

A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected.

string description = 3;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Share.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Share.Builder setDescriptionBytes(ByteString value)

A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected.

string description = 3;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Share.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Share.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Share.Builder
Overrides

setMountName(String value)

public Share.Builder setMountName(String value)

The mount name of the share. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.

string mount_name = 2;

Parameter
NameDescription
valueString

The mountName to set.

Returns
TypeDescription
Share.Builder

This builder for chaining.

setMountNameBytes(ByteString value)

public Share.Builder setMountNameBytes(ByteString value)

The mount name of the share. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.

string mount_name = 2;

Parameter
NameDescription
valueByteString

The bytes for mountName to set.

Returns
TypeDescription
Share.Builder

This builder for chaining.

setName(String value)

public Share.Builder setName(String value)

Output only. The resource name of the share, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Share.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Share.Builder setNameBytes(ByteString value)

Output only. The resource name of the share, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Share.Builder

This builder for chaining.

setNfsExportOptions(int index, NfsExportOptions value)

public Share.Builder setNfsExportOptions(int index, NfsExportOptions value)

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Parameters
NameDescription
indexint
valueNfsExportOptions
Returns
TypeDescription
Share.Builder

setNfsExportOptions(int index, NfsExportOptions.Builder builderForValue)

public Share.Builder setNfsExportOptions(int index, NfsExportOptions.Builder builderForValue)

Nfs Export Options. There is a limit of 10 export options per file share.

repeated .google.cloud.filestore.v1beta1.NfsExportOptions nfs_export_options = 5;

Parameters
NameDescription
indexint
builderForValueNfsExportOptions.Builder
Returns
TypeDescription
Share.Builder

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

public Share.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Share.Builder
Overrides

setState(Share.State value)

public Share.Builder setState(Share.State value)

Output only. The share state.

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

Parameter
NameDescription
valueShare.State

The state to set.

Returns
TypeDescription
Share.Builder

This builder for chaining.

setStateValue(int value)

public Share.Builder setStateValue(int value)

Output only. The share state.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
Share.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Share.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Share.Builder
Overrides