Class BackupChannel.Builder (0.62.0)

public static final class BackupChannel.Builder extends GeneratedMessageV3.Builder<BackupChannel.Builder> implements BackupChannelOrBuilder

A BackupChannel imposes constraints on where clusters can be backed up. The BackupChannel should be in the same project and region as the cluster being backed up. The backup can be created only in destination_project.

Protobuf type google.cloud.gkebackup.v1.BackupChannel

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public BackupChannel build()
Returns
Type Description
BackupChannel

buildPartial()

public BackupChannel buildPartial()
Returns
Type Description
BackupChannel

clear()

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

clearCreateTime()

public BackupChannel.Builder clearCreateTime()

Output only. The timestamp when this BackupChannel resource was created.

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

Returns
Type Description
BackupChannel.Builder

clearDescription()

public BackupChannel.Builder clearDescription()

Optional. User specified descriptive string for this BackupChannel.

string description = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

clearDestinationProject()

public BackupChannel.Builder clearDestinationProject()

Required. Immutable. The project where Backups are allowed to be stored. The format is projects/{projectId} or projects/{projectNumber}.

string destination_project = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

clearDestinationProjectId()

public BackupChannel.Builder clearDestinationProjectId()

Output only. The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id". This will be an OUTPUT_ONLY field to return the project_id of the destination project.

string destination_project_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

clearEtag()

public BackupChannel.Builder clearEtag()

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupChannel updates in order to avoid race conditions: An etag is returned in the response to GetBackupChannel, and systems are expected to put that etag in the request to UpdateBackupChannel or DeleteBackupChannel to ensure that their change will be applied to the same version of the resource.

string etag = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearLabels()

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

clearName()

public BackupChannel.Builder clearName()

Identifier. The fully qualified name of the BackupChannel. projects/*/locations/*/backupChannels/*

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

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearUid()

public BackupChannel.Builder clearUid()

Output only. Server generated global unique identifier of UUID format.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

clearUpdateTime()

public BackupChannel.Builder clearUpdateTime()

Output only. The timestamp when this BackupChannel resource was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BackupChannel.Builder

clone()

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

containsLabels(String key)

public boolean containsLabels(String key)

Optional. A set of custom labels supplied by user.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when this BackupChannel resource 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 timestamp when this BackupChannel resource 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 timestamp when this BackupChannel resource was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public BackupChannel getDefaultInstanceForType()
Returns
Type Description
BackupChannel

getDescription()

public String getDescription()

Optional. User specified descriptive string for this BackupChannel.

string description = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. User specified descriptive string for this BackupChannel.

string description = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getDestinationProject()

public String getDestinationProject()

Required. Immutable. The project where Backups are allowed to be stored. The format is projects/{projectId} or projects/{projectNumber}.

string destination_project = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The destinationProject.

getDestinationProjectBytes()

public ByteString getDestinationProjectBytes()

Required. Immutable. The project where Backups are allowed to be stored. The format is projects/{projectId} or projects/{projectNumber}.

string destination_project = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for destinationProject.

getDestinationProjectId()

public String getDestinationProjectId()

Output only. The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id". This will be an OUTPUT_ONLY field to return the project_id of the destination project.

string destination_project_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The destinationProjectId.

getDestinationProjectIdBytes()

public ByteString getDestinationProjectIdBytes()

Output only. The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id". This will be an OUTPUT_ONLY field to return the project_id of the destination project.

string destination_project_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for destinationProjectId.

getEtag()

public String getEtag()

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupChannel updates in order to avoid race conditions: An etag is returned in the response to GetBackupChannel, and systems are expected to put that etag in the request to UpdateBackupChannel or DeleteBackupChannel to ensure that their change will be applied to the same version of the resource.

string etag = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupChannel updates in order to avoid race conditions: An etag is returned in the response to GetBackupChannel, and systems are expected to put that etag in the request to UpdateBackupChannel or DeleteBackupChannel to ensure that their change will be applied to the same version of the resource.

string etag = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for etag.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. A set of custom labels supplied by user.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. A set of custom labels supplied by user.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. A set of custom labels supplied by user.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. A set of custom labels supplied by user.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

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

Identifier. The fully qualified name of the BackupChannel. projects/*/locations/*/backupChannels/*

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The fully qualified name of the BackupChannel. projects/*/locations/*/backupChannels/*

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

Returns
Type Description
ByteString

The bytes for name.

getUid()

public String getUid()

Output only. Server generated global unique identifier of UUID format.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. Server generated global unique identifier of UUID format.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when this BackupChannel resource was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The timestamp when this BackupChannel resource was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when this BackupChannel resource was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp when this BackupChannel resource was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when this BackupChannel resource was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

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

Output only. The timestamp when this BackupChannel resource was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
BackupChannel.Builder

mergeFrom(BackupChannel other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public BackupChannel.Builder mergeUpdateTime(Timestamp value)

Output only. The timestamp when this BackupChannel resource was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BackupChannel.Builder

putAllLabels(Map<String,String> values)

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

Optional. A set of custom labels supplied by user.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

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

putLabels(String key, String value)

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

Optional. A set of custom labels supplied by user.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

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

removeLabels(String key)

public BackupChannel.Builder removeLabels(String key)

Optional. A set of custom labels supplied by user.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
BackupChannel.Builder

setCreateTime(Timestamp value)

public BackupChannel.Builder setCreateTime(Timestamp value)

Output only. The timestamp when this BackupChannel resource was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
BackupChannel.Builder

setCreateTime(Timestamp.Builder builderForValue)

public BackupChannel.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The timestamp when this BackupChannel resource was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BackupChannel.Builder

setDescription(String value)

public BackupChannel.Builder setDescription(String value)

Optional. User specified descriptive string for this BackupChannel.

string description = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public BackupChannel.Builder setDescriptionBytes(ByteString value)

Optional. User specified descriptive string for this BackupChannel.

string description = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

setDestinationProject(String value)

public BackupChannel.Builder setDestinationProject(String value)

Required. Immutable. The project where Backups are allowed to be stored. The format is projects/{projectId} or projects/{projectNumber}.

string destination_project = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The destinationProject to set.

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

setDestinationProjectBytes(ByteString value)

public BackupChannel.Builder setDestinationProjectBytes(ByteString value)

Required. Immutable. The project where Backups are allowed to be stored. The format is projects/{projectId} or projects/{projectNumber}.

string destination_project = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for destinationProject to set.

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

setDestinationProjectId(String value)

public BackupChannel.Builder setDestinationProjectId(String value)

Output only. The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id". This will be an OUTPUT_ONLY field to return the project_id of the destination project.

string destination_project_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The destinationProjectId to set.

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

setDestinationProjectIdBytes(ByteString value)

public BackupChannel.Builder setDestinationProjectIdBytes(ByteString value)

Output only. The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id". This will be an OUTPUT_ONLY field to return the project_id of the destination project.

string destination_project_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for destinationProjectId to set.

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

setEtag(String value)

public BackupChannel.Builder setEtag(String value)

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupChannel updates in order to avoid race conditions: An etag is returned in the response to GetBackupChannel, and systems are expected to put that etag in the request to UpdateBackupChannel or DeleteBackupChannel to ensure that their change will be applied to the same version of the resource.

string etag = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public BackupChannel.Builder setEtagBytes(ByteString value)

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a BackupChannel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupChannel updates in order to avoid race conditions: An etag is returned in the response to GetBackupChannel, and systems are expected to put that etag in the request to UpdateBackupChannel or DeleteBackupChannel to ensure that their change will be applied to the same version of the resource.

string etag = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public BackupChannel.Builder setName(String value)

Identifier. The fully qualified name of the BackupChannel. projects/*/locations/*/backupChannels/*

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

setNameBytes(ByteString value)

public BackupChannel.Builder setNameBytes(ByteString value)

Identifier. The fully qualified name of the BackupChannel. projects/*/locations/*/backupChannels/*

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

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

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

setUid(String value)

public BackupChannel.Builder setUid(String value)

Output only. Server generated global unique identifier of UUID format.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Parameter
Name Description
value String

The uid to set.

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

setUidBytes(ByteString value)

public BackupChannel.Builder setUidBytes(ByteString value)

Output only. Server generated global unique identifier of UUID format.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Parameter
Name Description
value ByteString

The bytes for uid to set.

Returns
Type Description
BackupChannel.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public BackupChannel.Builder setUpdateTime(Timestamp value)

Output only. The timestamp when this BackupChannel resource was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BackupChannel.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public BackupChannel.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The timestamp when this BackupChannel resource was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BackupChannel.Builder