Class Backup.Builder (1.20.0)

public static final class Backup.Builder extends GeneratedMessageV3.Builder<Backup.Builder> implements BackupOrBuilder

A Filestore backup.

Protobuf type google.cloud.filestore.v1.Backup

Inheritance

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

Implements

BackupOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Backup build()
Returns
TypeDescription
Backup

buildPartial()

public Backup buildPartial()
Returns
TypeDescription
Backup

clear()

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

clearCapacityGb()

public Backup.Builder clearCapacityGb()

Output only. Capacity of the source file share when the backup was created.

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

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearCreateTime()

public Backup.Builder clearCreateTime()

Output only. The time when the backup was created.

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

Returns
TypeDescription
Backup.Builder

clearDescription()

public Backup.Builder clearDescription()

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

string description = 2;

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearDownloadBytes()

public Backup.Builder clearDownloadBytes()

Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.

int64 download_bytes = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearKmsKey()

public Backup.Builder clearKmsKey()

Immutable. KMS key name used for data encryption.

string kms_key = 13 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearLabels()

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

clearName()

public Backup.Builder clearName()

Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.

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

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSatisfiesPzs()

public Backup.Builder clearSatisfiesPzs()

Output only. Reserved for future use.

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

Returns
TypeDescription
Backup.Builder

clearSourceFileShare()

public Backup.Builder clearSourceFileShare()

Name of the file share in the source Filestore instance that the backup is created from.

string source_file_share = 9;

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearSourceInstance()

public Backup.Builder clearSourceInstance()

The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.

string source_instance = 8 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearSourceInstanceTier()

public Backup.Builder clearSourceInstanceTier()

Output only. The service tier of the source Filestore instance that this backup is created from.

.google.cloud.filestore.v1.Instance.Tier source_instance_tier = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearState()

public Backup.Builder clearState()

Output only. The backup state.

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

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clearStorageBytes()

public Backup.Builder clearStorageBytes()

Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.

int64 storage_bytes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Backup.Builder

This builder for chaining.

clone()

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

containsLabels(String key)

public boolean containsLabels(String key)

Resource labels to represent user provided metadata.

map<string, string> labels = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getCapacityGb()

public long getCapacityGb()

Output only. Capacity of the source file share when the backup was created.

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

Returns
TypeDescription
long

The capacityGb.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the backup was created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the backup was created.

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

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the backup was created.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Backup getDefaultInstanceForType()
Returns
TypeDescription
Backup

getDescription()

public String getDescription()

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

string description = 2;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 2;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDownloadBytes()

public long getDownloadBytes()

Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.

int64 download_bytes = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
long

The downloadBytes.

getKmsKey()

public String getKmsKey()

Immutable. KMS key name used for data encryption.

string kms_key = 13 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
String

The kmsKey.

getKmsKeyBytes()

public ByteString getKmsKeyBytes()

Immutable. KMS key name used for data encryption.

string kms_key = 13 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ByteString

The bytes for kmsKey.

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

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Resource labels to represent user provided metadata.

map<string, string> labels = 5;

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

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

Parameter
NameDescription
keyString
Returns
TypeDescription
String

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 backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_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 backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.

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

Returns
TypeDescription
ByteString

The bytes for name.

getSatisfiesPzs()

public BoolValue getSatisfiesPzs()

Output only. Reserved for future use.

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

Returns
TypeDescription
BoolValue

The satisfiesPzs.

getSatisfiesPzsBuilder()

public BoolValue.Builder getSatisfiesPzsBuilder()

Output only. Reserved for future use.

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

Returns
TypeDescription
Builder

getSatisfiesPzsOrBuilder()

public BoolValueOrBuilder getSatisfiesPzsOrBuilder()

Output only. Reserved for future use.

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

Returns
TypeDescription
BoolValueOrBuilder

getSourceFileShare()

public String getSourceFileShare()

Name of the file share in the source Filestore instance that the backup is created from.

string source_file_share = 9;

Returns
TypeDescription
String

The sourceFileShare.

getSourceFileShareBytes()

public ByteString getSourceFileShareBytes()

Name of the file share in the source Filestore instance that the backup is created from.

string source_file_share = 9;

Returns
TypeDescription
ByteString

The bytes for sourceFileShare.

getSourceInstance()

public String getSourceInstance()

The resource name