com.google.api.services.sqladmin.model.ReplicationCluster Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-sqladmin Show documentation
The newest version!
/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.sqladmin.model;

/**
 * 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.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Cloud SQL Admin API. For a detailed explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class ReplicationCluster extends com.google.api.client.json.GenericJson {

  /**
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean drReplica;

  /**
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String failoverDrReplicaName;

  /**
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String psaWriteEndpoint;

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getDrReplica() {
    return drReplica;
  }

  /**
   * 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.
   * @param drReplica drReplica or {@code null} for none
   */
  public ReplicationCluster setDrReplica(java.lang.Boolean drReplica) {
    this.drReplica = drReplica;
    return this;
  }

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.lang.String getFailoverDrReplicaName() {
    return failoverDrReplicaName;
  }

  /**
   * 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.
   * @param failoverDrReplicaName failoverDrReplicaName or {@code null} for none
   */
  public ReplicationCluster setFailoverDrReplicaName(java.lang.String failoverDrReplicaName) {
    this.failoverDrReplicaName = failoverDrReplicaName;
    return this;
  }

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.lang.String getPsaWriteEndpoint() {
    return psaWriteEndpoint;
  }

  /**
   * 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.
   * @param psaWriteEndpoint psaWriteEndpoint or {@code null} for none
   */
  public ReplicationCluster setPsaWriteEndpoint(java.lang.String psaWriteEndpoint) {
    this.psaWriteEndpoint = psaWriteEndpoint;
    return this;
  }

  @Override
  public ReplicationCluster set(String fieldName, Object value) {
    return (ReplicationCluster) super.set(fieldName, value);
  }

  @Override
  public ReplicationCluster clone() {
    return (ReplicationCluster) super.clone();
  }

}