Class FailoverIcebergCatalogRequest.Builder (0.62.0)

public static final class FailoverIcebergCatalogRequest.Builder extends GeneratedMessageV3.Builder<FailoverIcebergCatalogRequest.Builder> implements FailoverIcebergCatalogRequestOrBuilder

Request message for FailoverIcebergCatalog.

Protobuf type google.cloud.biglake.v1.FailoverIcebergCatalogRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public FailoverIcebergCatalogRequest build()
Returns
Type Description
FailoverIcebergCatalogRequest

buildPartial()

public FailoverIcebergCatalogRequest buildPartial()
Returns
Type Description
FailoverIcebergCatalogRequest

clear()

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

clearConditionalFailoverReplicationTime()

public FailoverIcebergCatalogRequest.Builder clearConditionalFailoverReplicationTime()

Optional. If unset, wait for all data from the source region to replicate to the new primary region before completing the failover, with no data loss (also called "soft failover"). If set, failover immediately, accepting the loss of any data committed in the source region after this timestamp, that has not yet replicated. If any data committed before this time has not replicated, the failover will not be performed and an error will be returned (also called "hard failover").

.google.protobuf.Timestamp conditional_failover_replication_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FailoverIcebergCatalogRequest.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public FailoverIcebergCatalogRequest.Builder clearName()

Required. The name of the catalog in the form "projects/{project_id}/catalogs/{catalog_id}"

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

Returns
Type Description
FailoverIcebergCatalogRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPrimaryReplica()

public FailoverIcebergCatalogRequest.Builder clearPrimaryReplica()

Required. The region being assigned as the new primary replica region. For example "us-east1". This must be one of the replica regions in the catalog's list of replicas marked as a "secondary".

string primary_replica = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FailoverIcebergCatalogRequest.Builder

This builder for chaining.

clearValidateOnly()

public FailoverIcebergCatalogRequest.Builder clearValidateOnly()

Optional. If set, only validate the request, but do not perform the update. This can be used to inspect the replication_time at any time, including before performing a fail-over.

bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FailoverIcebergCatalogRequest.Builder

This builder for chaining.

clone()

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

getConditionalFailoverReplicationTime()

public Timestamp getConditionalFailoverReplicationTime()

Optional. If unset, wait for all data from the source region to replicate to the new primary region before completing the failover, with no data loss (also called "soft failover"). If set, failover immediately, accepting the loss of any data committed in the source region after this timestamp, that has not yet replicated. If any data committed before this time has not replicated, the failover will not be performed and an error will be returned (also called "hard failover").

.google.protobuf.Timestamp conditional_failover_replication_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The conditionalFailoverReplicationTime.

getConditionalFailoverReplicationTimeBuilder()

public Timestamp.Builder getConditionalFailoverReplicationTimeBuilder()

Optional. If unset, wait for all data from the source region to replicate to the new primary region before completing the failover, with no data loss (also called "soft failover"). If set, failover immediately, accepting the loss of any data committed in the source region after this timestamp, that has not yet replicated. If any data committed before this time has not replicated, the failover will not be performed and an error will be returned (also called "hard failover").

.google.protobuf.Timestamp conditional_failover_replication_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getConditionalFailoverReplicationTimeOrBuilder()

public TimestampOrBuilder getConditionalFailoverReplicationTimeOrBuilder()

Optional. If unset, wait for all data from the source region to replicate to the new primary region before completing the failover, with no data loss (also called "soft failover"). If set, failover immediately, accepting the loss of any data committed in the source region after this timestamp, that has not yet replicated. If any data committed before this time has not replicated, the failover will not be performed and an error will be returned (also called "hard failover").

.google.protobuf.Timestamp conditional_failover_replication_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public FailoverIcebergCatalogRequest getDefaultInstanceForType()
Returns
Type Description
FailoverIcebergCatalogRequest

getDescriptorForType()

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

getName()

public String getName()

Required. The name of the catalog in the form "projects/{project_id}/catalogs/{catalog_id}"

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the catalog in the form "projects/{project_id}/catalogs/{catalog_id}"

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

Returns
Type Description
ByteString

The bytes for name.

getPrimaryReplica()

public String getPrimaryReplica()

Required. The region being assigned as the new primary replica region. For example "us-east1". This must be one of the replica regions in the catalog's list of replicas marked as a "secondary".

string primary_replica = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The primaryReplica.

getPrimaryReplicaBytes()

public ByteString getPrimaryReplicaBytes()

Required. The region being assigned as the new primary replica region. For example "us-east1". This must be one of the replica regions in the catalog's list of replicas marked as a "secondary".

string primary_replica = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for primaryReplica.

getValidateOnly()

public boolean getValidateOnly()

Optional. If set, only validate the request, but do not perform the update. This can be used to inspect the replication_time at any time, including before performing a fail-over.

bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The validateOnly.

hasConditionalFailoverReplicationTime()

public boolean hasConditionalFailoverReplicationTime()

Optional. If unset, wait for all data from the source region to replicate to the new primary region before completing the failover, with no data loss (also called "soft failover"). If set, failover immediately, accepting the loss of any data committed in the source region after this timestamp, that has not yet replicated. If any data committed before this time has not replicated, the failover will not be performed and an error will be returned (also called "hard failover").

.google.protobuf.Timestamp conditional_failover_replication_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the conditionalFailoverReplicationTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeConditionalFailoverReplicationTime(Timestamp value)

public FailoverIcebergCatalogRequest.Builder mergeConditionalFailoverReplicationTime(Timestamp value)

Optional. If unset, wait for all data from the source region to replicate to the new primary region before completing the failover, with no data loss (also called "soft failover"). If set, failover immediately, accepting the loss of any data committed in the source region after this timestamp, that has not yet replicated. If any data committed before this time has not replicated, the failover will not be performed and an error will be returned (also called "hard failover").

.google.protobuf.Timestamp conditional_failover_replication_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Timestamp
Returns
Type Description
FailoverIcebergCatalogRequest.Builder

mergeFrom(FailoverIcebergCatalogRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setConditionalFailoverReplicationTime(Timestamp value)

public FailoverIcebergCatalogRequest.Builder setConditionalFailoverReplicationTime(Timestamp value)

Optional. If unset, wait for all data from the source region to replicate to the new primary region before completing the failover, with no data loss (also called "soft failover"). If set, failover immediately, accepting the loss of any data committed in the source region after this timestamp, that has not yet replicated. If any data committed before this time has not replicated, the failover will not be performed and an error will be returned (also called "hard failover").

.google.protobuf.Timestamp conditional_failover_replication_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Timestamp
Returns
Type Description
FailoverIcebergCatalogRequest.Builder

setConditionalFailoverReplicationTime(Timestamp.Builder builderForValue)

public FailoverIcebergCatalogRequest.Builder setConditionalFailoverReplicationTime(Timestamp.Builder builderForValue)

Optional. If unset, wait for all data from the source region to replicate to the new primary region before completing the failover, with no data loss (also called "soft failover"). If set, failover immediately, accepting the loss of any data committed in the source region after this timestamp, that has not yet replicated. If any data committed before this time has not replicated, the failover will not be performed and an error will be returned (also called "hard failover").

.google.protobuf.Timestamp conditional_failover_replication_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
FailoverIcebergCatalogRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public FailoverIcebergCatalogRequest.Builder setName(String value)

Required. The name of the catalog in the form "projects/{project_id}/catalogs/{catalog_id}"

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
FailoverIcebergCatalogRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public FailoverIcebergCatalogRequest.Builder setNameBytes(ByteString value)

Required. The name of the catalog in the form "projects/{project_id}/catalogs/{catalog_id}"

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
FailoverIcebergCatalogRequest.Builder

This builder for chaining.

setPrimaryReplica(String value)

public FailoverIcebergCatalogRequest.Builder setPrimaryReplica(String value)

Required. The region being assigned as the new primary replica region. For example "us-east1". This must be one of the replica regions in the catalog's list of replicas marked as a "secondary".

string primary_replica = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The primaryReplica to set.

Returns
Type Description
FailoverIcebergCatalogRequest.Builder

This builder for chaining.

setPrimaryReplicaBytes(ByteString value)

public FailoverIcebergCatalogRequest.Builder setPrimaryReplicaBytes(ByteString value)

Required. The region being assigned as the new primary replica region. For example "us-east1". This must be one of the replica regions in the catalog's list of replicas marked as a "secondary".

string primary_replica = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for primaryReplica to set.

Returns
Type Description
FailoverIcebergCatalogRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setValidateOnly(boolean value)

public FailoverIcebergCatalogRequest.Builder setValidateOnly(boolean value)

Optional. If set, only validate the request, but do not perform the update. This can be used to inspect the replication_time at any time, including before performing a fail-over.

bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The validateOnly to set.

Returns
Type Description
FailoverIcebergCatalogRequest.Builder

This builder for chaining.