Interface ReplicationClusterOrBuilder (0.1.0)

public interface ReplicationClusterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDrReplica()

public abstract boolean getDrReplica()

Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.

optional bool dr_replica = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The drReplica.

getFailoverDrReplicaName()

public abstract String getFailoverDrReplicaName()

Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.

optional string failover_dr_replica_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The failoverDrReplicaName.

getFailoverDrReplicaNameBytes()

public abstract ByteString getFailoverDrReplicaNameBytes()

Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.

optional string failover_dr_replica_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for failoverDrReplicaName.

getPsaWriteEndpoint()

public abstract String getPsaWriteEndpoint()

Output only. If set, this field indicates this instance has a private service access (PSA) DNS endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, then the DNS endpoint points to this instance. After a switchover or replica failover operation, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance doesn't have a DR replica yet or the DR replica is deleted.

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

Returns
Type Description
String

The psaWriteEndpoint.

getPsaWriteEndpointBytes()

public abstract ByteString getPsaWriteEndpointBytes()

Output only. If set, this field indicates this instance has a private service access (PSA) DNS endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, then the DNS endpoint points to this instance. After a switchover or replica failover operation, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance doesn't have a DR replica yet or the DR replica is deleted.

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

Returns
Type Description
ByteString

The bytes for psaWriteEndpoint.

hasDrReplica()

public abstract boolean hasDrReplica()

Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance.

optional bool dr_replica = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the drReplica field is set.

hasFailoverDrReplicaName()

public abstract boolean hasFailoverDrReplicaName()

Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation.

optional string failover_dr_replica_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the failoverDrReplicaName field is set.

hasPsaWriteEndpoint()

public abstract boolean hasPsaWriteEndpoint()

Output only. If set, this field indicates this instance has a private service access (PSA) DNS endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, then the DNS endpoint points to this instance. After a switchover or replica failover operation, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance doesn't have a DR replica yet or the DR replica is deleted.

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

Returns
Type Description
boolean

Whether the psaWriteEndpoint field is set.