Class Snapshot.Builder (1.49.0)

public static final class Snapshot.Builder extends GeneratedMessageV3.Builder<Snapshot.Builder> implements SnapshotOrBuilder

A Filestore snapshot.

Protobuf type google.cloud.filestore.v1.Snapshot

Implements

SnapshotOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Snapshot build()
Returns
Type Description
Snapshot

buildPartial()

public Snapshot buildPartial()
Returns
Type Description
Snapshot

clear()

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

clearCreateTime()

public Snapshot.Builder clearCreateTime()

Output only. The time when the snapshot was created.

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

Returns
Type Description
Snapshot.Builder

clearDescription()

public Snapshot.Builder clearDescription()

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

string description = 2;

Returns
Type Description
Snapshot.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearFilesystemUsedBytes()

public Snapshot.Builder clearFilesystemUsedBytes()

Output only. The amount of bytes needed to allocate a full copy of the snapshot content

int64 filesystem_used_bytes = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Snapshot.Builder

This builder for chaining.

clearLabels()

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

clearName()

public Snapshot.Builder clearName()

Output only. The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.

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

Returns
Type Description
Snapshot.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearState()

public Snapshot.Builder clearState()

Output only. The snapshot state.

.google.cloud.filestore.v1.Snapshot.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Snapshot.Builder

This builder for chaining.

clone()

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

containsLabels(String key)

public boolean containsLabels(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 5;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the snapshot was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the snapshot was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the snapshot was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Snapshot getDefaultInstanceForType()
Returns
Type Description
Snapshot

getDescription()

public String getDescription()

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

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getFilesystemUsedBytes()

public long getFilesystemUsedBytes()

Output only. The amount of bytes needed to allocate a full copy of the snapshot content

int64 filesystem_used_bytes = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The filesystemUsedBytes.

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 = 5;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Resource labels to represent user provided metadata.

map<string, string> labels = 5;

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 = 5;

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 = 5;

Parameter
Name Description
key String
Returns
Type Description
String

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 snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_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 snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.

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

Returns
Type Description
ByteString

The bytes for name.

getState()

public Snapshot.State getState()

Output only. The snapshot state.

.google.cloud.filestore.v1.Snapshot.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Snapshot.State

The state.

getStateValue()

public int getStateValue()

Output only. The snapshot state.

.google.cloud.filestore.v1.Snapshot.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the snapshot was created.

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

Returns
Type Description
boolean

Whether the createTime 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 Snapshot.Builder mergeCreateTime(Timestamp value)

Output only. The time when the snapshot was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Snapshot.Builder

mergeFrom(Snapshot other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllLabels(Map<String,String> values)

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

Resource labels to represent user provided metadata.

map<string, string> labels = 5;

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

putLabels(String key, String value)

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

Resource labels to represent user provided metadata.

map<string, string> labels = 5;

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

removeLabels(String key)

public Snapshot.Builder removeLabels(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 5;

Parameter
Name Description
key String
Returns
Type Description
Snapshot.Builder

setCreateTime(Timestamp value)

public Snapshot.Builder setCreateTime(Timestamp value)

Output only. The time when the snapshot was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Snapshot.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Snapshot.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the snapshot was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Snapshot.Builder

setDescription(String value)

public Snapshot.Builder setDescription(String value)

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

string description = 2;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
Snapshot.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Snapshot.Builder setDescriptionBytes(ByteString value)

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

string description = 2;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
Snapshot.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilesystemUsedBytes(long value)

public Snapshot.Builder setFilesystemUsedBytes(long value)

Output only. The amount of bytes needed to allocate a full copy of the snapshot content

int64 filesystem_used_bytes = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

The filesystemUsedBytes to set.

Returns
Type Description
Snapshot.Builder

This builder for chaining.

setName(String value)

public Snapshot.Builder setName(String value)

Output only. The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Snapshot.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Snapshot.Builder setNameBytes(ByteString value)

Output only. The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Snapshot.Builder

This builder for chaining.

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

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

setState(Snapshot.State value)

public Snapshot.Builder setState(Snapshot.State value)

Output only. The snapshot state.

.google.cloud.filestore.v1.Snapshot.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Snapshot.State

The state to set.

Returns
Type Description
Snapshot.Builder

This builder for chaining.

setStateValue(int value)

public Snapshot.Builder setStateValue(int value)

Output only. The snapshot state.

.google.cloud.filestore.v1.Snapshot.State state = 3 [(.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
Snapshot.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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