Class: Google::Apis::SqladminV1::ReplicationCluster

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sqladmin_v1/classes.rb,
lib/google/apis/sqladmin_v1/representations.rb,
lib/google/apis/sqladmin_v1/representations.rb

Overview

A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ReplicationCluster

Returns a new instance of ReplicationCluster.



3630
3631
3632
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3630

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#dr_replica ⇒ Boolean Also known as: dr_replica?

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. Corresponds to the JSON property drReplica

Returns:

  • (Boolean) 


3606
3607
3608
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3606

def dr_replica
  @dr_replica
end

#failover_dr_replica_name ⇒ String

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. Corresponds to the JSON property failoverDrReplicaName

Returns:

  • (String) 


3617
3618
3619
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3617

def failover_dr_replica_name
  @failover_dr_replica_name
end

#psa_write_endpoint ⇒ String

Output only. If set, it 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, the dns should be pointing to this instance. After Switchover or Replica failover, 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 does not yet have a replica, or had a DR replica that was deleted. Corresponds to the JSON property psaWriteEndpoint

Returns:

  • (String) 


3628
3629
3630
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3628

def psa_write_endpoint
  @psa_write_endpoint
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3635
3636
3637
3638
3639
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 3635

def update!(**args)
  @dr_replica = args[:dr_replica] if args.key?(:dr_replica)
  @failover_dr_replica_name = args[:failover_dr_replica_name] if args.key?(:failover_dr_replica_name)
  @psa_write_endpoint = args[:psa_write_endpoint] if args.key?(:psa_write_endpoint)
end