Show / Hide Table of Contents

Class InstancesResource.FailoverRequest

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 page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Operation>
SQLAdminBaseServiceRequest<Operation>
InstancesResource.FailoverRequest
Implements
IClientServiceRequest<Operation>
IClientServiceRequest
Inherited Members
SQLAdminBaseServiceRequest<Operation>.Xgafv
SQLAdminBaseServiceRequest<Operation>.AccessToken
SQLAdminBaseServiceRequest<Operation>.Alt
SQLAdminBaseServiceRequest<Operation>.Callback
SQLAdminBaseServiceRequest<Operation>.Fields
SQLAdminBaseServiceRequest<Operation>.Key
SQLAdminBaseServiceRequest<Operation>.OauthToken
SQLAdminBaseServiceRequest<Operation>.PrettyPrint
SQLAdminBaseServiceRequest<Operation>.QuotaUser
SQLAdminBaseServiceRequest<Operation>.UploadType
SQLAdminBaseServiceRequest<Operation>.UploadProtocol
ClientServiceRequest<Operation>.Execute()
ClientServiceRequest<Operation>.ExecuteAsStream()
ClientServiceRequest<Operation>.ExecuteAsync()
ClientServiceRequest<Operation>.ExecuteAsync(CancellationToken)
ClientServiceRequest<Operation>.ExecuteAsStreamAsync()
ClientServiceRequest<Operation>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<Operation>.CreateRequest(bool?)
ClientServiceRequest<Operation>.GenerateRequestUri()
ClientServiceRequest<Operation>.GetDefaultETagAction(string)
ClientServiceRequest<Operation>.ETagAction
ClientServiceRequest<Operation>.ModifyRequest
ClientServiceRequest<Operation>.ValidateParameters
ClientServiceRequest<Operation>.ApiVersion
ClientServiceRequest<Operation>.RequestParameters
ClientServiceRequest<Operation>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.SQLAdmin.v1
Assembly: Google.Apis.SQLAdmin.v1.dll
Syntax
public class InstancesResource.FailoverRequest : SQLAdminBaseServiceRequest<Operation>, IClientServiceRequest<Operation>, IClientServiceRequest

Constructors

FailoverRequest(IClientService, InstancesFailoverRequest, string, string)

Constructs a new Failover request.

Declaration
public FailoverRequest(IClientService service, InstancesFailoverRequest body, string project, string instance)
Parameters
Type Name Description
IClientService service
InstancesFailoverRequest body
string project
string instance

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Operation>.HttpMethod

Instance

Cloud SQL instance ID. This does not include the project ID.

Declaration
[RequestParameter("instance", RequestParameterType.Path)]
public virtual string Instance { get; }
Property Value
Type Description
string

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Operation>.MethodName

Project

ID of the project that contains the read replica.

Declaration
[RequestParameter("project", RequestParameterType.Path)]
public virtual string Project { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Operation>.RestPath

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides
ClientServiceRequest<Operation>.GetBody()

InitParameters()

Initializes Failover parameter list.

Declaration
protected override void InitParameters()
Overrides
SQLAdminBaseServiceRequest<Operation>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX