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
InstancesResource.FailoverRequest
Inherited Members
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
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
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
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
Type | Description |
---|---|
object |
Overrides
InitParameters()
Initializes Failover parameter list.
Declaration
protected override void InitParameters()