Class FailoverHiveCatalogRequest.Builder (0.83.0)

public static final class FailoverHiveCatalogRequest.Builder extends GeneratedMessage.Builder<FailoverHiveCatalogRequest.Builder> implements FailoverHiveCatalogRequestOrBuilder

Request message for FailoverHiveCatalog.

Protobuf type google.cloud.biglake.hive.v1beta.FailoverHiveCatalogRequest

Static Methods

getDescriptor()

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

Methods

build()

public FailoverHiveCatalogRequest build()
Returns
Type Description
FailoverHiveCatalogRequest

buildPartial()

public FailoverHiveCatalogRequest buildPartial()
Returns
Type Description
FailoverHiveCatalogRequest

clear()

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

clearConditionalFailoverReplicationTime()

public FailoverHiveCatalogRequest.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
FailoverHiveCatalogRequest.Builder

clearName()

public FailoverHiveCatalogRequest.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
FailoverHiveCatalogRequest.Builder

This builder for chaining.

clearPrimaryReplica()

public FailoverHiveCatalogRequest.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
FailoverHiveCatalogRequest.Builder

This builder for chaining.

clearValidateOnly()

public FailoverHiveCatalogRequest.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
FailoverHiveCatalogRequest.Builder

This builder for chaining.

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 FailoverHiveCatalogRequest getDefaultInstanceForType()
Returns
Type Description
FailoverHiveCatalogRequest

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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeConditionalFailoverReplicationTime(Timestamp value)

public FailoverHiveCatalogRequest.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
FailoverHiveCatalogRequest.Builder

mergeFrom(FailoverHiveCatalogRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setConditionalFailoverReplicationTime(Timestamp value)

public FailoverHiveCatalogRequest.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
FailoverHiveCatalogRequest.Builder

setConditionalFailoverReplicationTime(Timestamp.Builder builderForValue)

public FailoverHiveCatalogRequest.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
FailoverHiveCatalogRequest.Builder

setName(String value)

public FailoverHiveCatalogRequest.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
FailoverHiveCatalogRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public FailoverHiveCatalogRequest.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
FailoverHiveCatalogRequest.Builder

This builder for chaining.

setPrimaryReplica(String value)

public FailoverHiveCatalogRequest.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
FailoverHiveCatalogRequest.Builder

This builder for chaining.

setPrimaryReplicaBytes(ByteString value)

public FailoverHiveCatalogRequest.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
FailoverHiveCatalogRequest.Builder

This builder for chaining.

setValidateOnly(boolean value)

public FailoverHiveCatalogRequest.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
FailoverHiveCatalogRequest.Builder

This builder for chaining.