target.apidocs.com.google.api.services.sqladmin.SQLAdmin.Instances.Failover.html Maven / Gradle / Ivy
The newest version!
SQLAdmin.Instances.Failover (Cloud SQL Admin API v1-rev20241108-2.0.0)
com.google.api.services.sqladmin
Class SQLAdmin.Instances.Failover
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
-
- com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
-
- com.google.api.services.sqladmin.SQLAdminRequest<Operation>
-
- com.google.api.services.sqladmin.SQLAdmin.Instances.Failover
-
- Enclosing class:
- SQLAdmin.Instances
public class SQLAdmin.Instances.Failover
extends SQLAdminRequest<Operation>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
Failover(String project,
String instance,
InstancesFailoverRequest content)
Initiates a manual failover of a high availability (HA) primary instance to a standby instance,
which becomes the primary instance.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
String
getInstance()
Cloud SQL instance ID.
String
getProject()
ID of the project that contains the read replica.
SQLAdmin.Instances.Failover
set(String parameterName,
Object value)
SQLAdmin.Instances.Failover
set$Xgafv(String $Xgafv)
V1 error format.
SQLAdmin.Instances.Failover
setAccessToken(String accessToken)
OAuth access token.
SQLAdmin.Instances.Failover
setAlt(String alt)
Data format for response.
SQLAdmin.Instances.Failover
setCallback(String callback)
JSONP
SQLAdmin.Instances.Failover
setFields(String fields)
Selector specifying which fields to include in a partial response.
SQLAdmin.Instances.Failover
setInstance(String instance)
Cloud SQL instance ID.
SQLAdmin.Instances.Failover
setKey(String key)
API key.
SQLAdmin.Instances.Failover
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
SQLAdmin.Instances.Failover
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
SQLAdmin.Instances.Failover
setProject(String project)
ID of the project that contains the read replica.
SQLAdmin.Instances.Failover
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
SQLAdmin.Instances.Failover
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
SQLAdmin.Instances.Failover
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
-
Methods inherited from class com.google.api.services.sqladmin.SQLAdminRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders
-
Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue
-
Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream
-
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Constructor Detail
-
Failover
protected Failover(String project,
String instance,
InstancesFailoverRequest content)
Initiates a manual failover of a high availability (HA) primary instance to a standby instance,
which becomes the primary instance. Users are then rerouted to the new primary. For more
information, see the [Overview of high
availability](https://cloud.google.com/sql/docs/mysql/high-availability) page in the Cloud SQL
documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its
failover replica instance.
Create a request for the method "instances.failover".
This request holds the parameters needed by the the sqladmin server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
SQLAdmin.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)
must be called to initialize this instance immediately after invoking the constructor.
- Parameters:
project
- ID of the project that contains the read replica.
instance
- Cloud SQL instance ID. This does not include the project ID.
content
- the InstancesFailoverRequest
- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public SQLAdmin.Instances.Failover set$Xgafv(String $Xgafv)
Description copied from class: SQLAdminRequest
V1 error format.
- Overrides:
set$Xgafv
in class SQLAdminRequest<Operation>
-
setAccessToken
public SQLAdmin.Instances.Failover setAccessToken(String accessToken)
Description copied from class: SQLAdminRequest
OAuth access token.
- Overrides:
setAccessToken
in class SQLAdminRequest<Operation>
-
setAlt
public SQLAdmin.Instances.Failover setAlt(String alt)
Description copied from class: SQLAdminRequest
Data format for response.
- Overrides:
setAlt
in class SQLAdminRequest<Operation>
-
setCallback
public SQLAdmin.Instances.Failover setCallback(String callback)
Description copied from class: SQLAdminRequest
JSONP
- Overrides:
setCallback
in class SQLAdminRequest<Operation>
-
setFields
public SQLAdmin.Instances.Failover setFields(String fields)
Description copied from class: SQLAdminRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class SQLAdminRequest<Operation>
-
setKey
public SQLAdmin.Instances.Failover setKey(String key)
Description copied from class: SQLAdminRequest
API key. Your API key identifies your project and provides you with API access, quota, and
reports. Required unless you provide an OAuth 2.0 token.
- Overrides:
setKey
in class SQLAdminRequest<Operation>
-
setOauthToken
public SQLAdmin.Instances.Failover setOauthToken(String oauthToken)
Description copied from class: SQLAdminRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class SQLAdminRequest<Operation>
-
setPrettyPrint
public SQLAdmin.Instances.Failover setPrettyPrint(Boolean prettyPrint)
Description copied from class: SQLAdminRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class SQLAdminRequest<Operation>
-
setQuotaUser
public SQLAdmin.Instances.Failover setQuotaUser(String quotaUser)
Description copied from class: SQLAdminRequest
Available to use for quota purposes for server-side applications. Can be any arbitrary string
assigned to a user, but should not exceed 40 characters.
- Overrides:
setQuotaUser
in class SQLAdminRequest<Operation>
-
setUploadType
public SQLAdmin.Instances.Failover setUploadType(String uploadType)
Description copied from class: SQLAdminRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class SQLAdminRequest<Operation>
-
setUploadProtocol
public SQLAdmin.Instances.Failover setUploadProtocol(String uploadProtocol)
Description copied from class: SQLAdminRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class SQLAdminRequest<Operation>
-
getProject
public String getProject()
ID of the project that contains the read replica.
-
setProject
public SQLAdmin.Instances.Failover setProject(String project)
ID of the project that contains the read replica.
-
getInstance
public String getInstance()
Cloud SQL instance ID. This does not include the project ID.
-
setInstance
public SQLAdmin.Instances.Failover setInstance(String instance)
Cloud SQL instance ID. This does not include the project ID.
-
set
public SQLAdmin.Instances.Failover set(String parameterName,
Object value)
- Overrides:
set
in class SQLAdminRequest<Operation>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy