Class ReplicaConfiguration (0.1.0)

public final class ReplicaConfiguration extends GeneratedMessage implements ReplicaConfigurationOrBuilder

Read-replica configuration for connecting to the primary instance.

Protobuf type google.cloud.sql.v1beta4.ReplicaConfiguration

Static Fields

CASCADABLE_REPLICA_FIELD_NUMBER

public static final int CASCADABLE_REPLICA_FIELD_NUMBER
Field Value
Type Description
int

FAILOVER_TARGET_FIELD_NUMBER

public static final int FAILOVER_TARGET_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

MYSQL_REPLICA_CONFIGURATION_FIELD_NUMBER

public static final int MYSQL_REPLICA_CONFIGURATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReplicaConfiguration getDefaultInstance()
Returns
Type Description
ReplicaConfiguration

getDescriptor()

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

newBuilder()

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

newBuilder(ReplicaConfiguration prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCascadableReplica()

public BoolValue getCascadableReplica()

Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.

.google.protobuf.BoolValue cascadable_replica = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BoolValue

The cascadableReplica.

getCascadableReplicaOrBuilder()

public BoolValueOrBuilder getCascadableReplicaOrBuilder()

Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.

.google.protobuf.BoolValue cascadable_replica = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BoolValueOrBuilder

getDefaultInstanceForType()

public ReplicaConfiguration getDefaultInstanceForType()
Returns
Type Description
ReplicaConfiguration

getFailoverTarget()

public BoolValue getFailoverTarget()

Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

.google.protobuf.BoolValue failover_target = 3;

Returns
Type Description
BoolValue

The failoverTarget.

getFailoverTargetOrBuilder()

public BoolValueOrBuilder getFailoverTargetOrBuilder()

Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

.google.protobuf.BoolValue failover_target = 3;

Returns
Type Description
BoolValueOrBuilder

getKind()

public String getKind()

This is always sql#replicaConfiguration.

string kind = 1;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

This is always sql#replicaConfiguration.

string kind = 1;

Returns
Type Description
ByteString

The bytes for kind.

getMysqlReplicaConfiguration()

public MySqlReplicaConfiguration getMysqlReplicaConfiguration()

MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.

.google.cloud.sql.v1beta4.MySqlReplicaConfiguration mysql_replica_configuration = 2;

Returns
Type Description
MySqlReplicaConfiguration

The mysqlReplicaConfiguration.

getMysqlReplicaConfigurationOrBuilder()

public MySqlReplicaConfigurationOrBuilder getMysqlReplicaConfigurationOrBuilder()

MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.

.google.cloud.sql.v1beta4.MySqlReplicaConfiguration mysql_replica_configuration = 2;

Returns
Type Description
MySqlReplicaConfigurationOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCascadableReplica()

public boolean hasCascadableReplica()

Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.

.google.protobuf.BoolValue cascadable_replica = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the cascadableReplica field is set.

hasFailoverTarget()

public boolean hasFailoverTarget()

Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.

.google.protobuf.BoolValue failover_target = 3;

Returns
Type Description
boolean

Whether the failoverTarget field is set.

hasMysqlReplicaConfiguration()

public boolean hasMysqlReplicaConfiguration()

MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.

.google.cloud.sql.v1beta4.MySqlReplicaConfiguration mysql_replica_configuration = 2;

Returns
Type Description
boolean

Whether the mysqlReplicaConfiguration field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ReplicaConfiguration.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ReplicaConfiguration.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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