Class FailoverIcebergCatalogRequest (0.62.0) 

public final class FailoverIcebergCatalogRequest extends GeneratedMessageV3 implements FailoverIcebergCatalogRequestOrBuilder

Request message for FailoverIcebergCatalog.

Protobuf type google.cloud.biglake.v1.FailoverIcebergCatalogRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > FailoverIcebergCatalogRequest

Static Fields

CONDITIONAL_FAILOVER_REPLICATION_TIME_FIELD_NUMBER

public static final int CONDITIONAL_FAILOVER_REPLICATION_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PRIMARY_REPLICA_FIELD_NUMBER

public static final int PRIMARY_REPLICA_FIELD_NUMBER
Field Value
Type Description
int

VALIDATE_ONLY_FIELD_NUMBER

public static final int VALIDATE_ONLY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FailoverIcebergCatalogRequest getDefaultInstance()
Returns
Type Description
FailoverIcebergCatalogRequest

getDescriptor()

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

newBuilder()

public static FailoverIcebergCatalogRequest.Builder newBuilder()
Returns
Type Description
FailoverIcebergCatalogRequest.Builder

newBuilder(FailoverIcebergCatalogRequest prototype)

public static FailoverIcebergCatalogRequest.Builder newBuilder(FailoverIcebergCatalogRequest prototype)
Parameter
Name Description
prototype FailoverIcebergCatalogRequest
Returns
Type Description
FailoverIcebergCatalogRequest.Builder

parseDelimitedFrom(InputStream input)

public static FailoverIcebergCatalogRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FailoverIcebergCatalogRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FailoverIcebergCatalogRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FailoverIcebergCatalogRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FailoverIcebergCatalogRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FailoverIcebergCatalogRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FailoverIcebergCatalogRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FailoverIcebergCatalogRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FailoverIcebergCatalogRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FailoverIcebergCatalogRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FailoverIcebergCatalogRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FailoverIcebergCatalogRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FailoverIcebergCatalogRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FailoverIcebergCatalogRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FailoverIcebergCatalogRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FailoverIcebergCatalogRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FailoverIcebergCatalogRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FailoverIcebergCatalogRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FailoverIcebergCatalogRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FailoverIcebergCatalogRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FailoverIcebergCatalogRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FailoverIcebergCatalogRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FailoverIcebergCatalogRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FailoverIcebergCatalogRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FailoverIcebergCatalogRequest> parser()
Returns
Type Description
Parser<FailoverIcebergCatalogRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

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.

getParserForType()

public Parser<FailoverIcebergCatalogRequest> getParserForType()
Returns
Type Description
Parser<FailoverIcebergCatalogRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FailoverIcebergCatalogRequest.Builder newBuilderForType()
Returns
Type Description
FailoverIcebergCatalogRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FailoverIcebergCatalogRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FailoverIcebergCatalogRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FailoverIcebergCatalogRequest.Builder toBuilder()
Returns
Type Description
FailoverIcebergCatalogRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException