sqladmin  v1beta4
Classes | Public Member Functions | List of all members
Google.Apis.SQLAdmin.v1beta4.InstancesResource Class Reference

The "instances" collection of methods. More...

Classes

class  AddServerCaRequest
 Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. More...
 
class  CloneRequest
 Creates a Cloud SQL instance as a clone of the source instance. More...
 
class  DeleteRequest
 Deletes a Cloud SQL instance. More...
 
class  DemoteMasterRequest
 Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server. More...
 
class  ExportRequest
 Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file. More...
 
class  FailoverRequest
 Failover the instance to its failover replica instance. More...
 
class  GetRequest
 Retrieves a resource containing information about a Cloud SQL instance. More...
 
class  ImportRequest
 Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage. More...
 
class  InsertRequest
 Creates a new Cloud SQL instance. More...
 
class  ListRequest
 Lists instances under a given project in the alphabetical order of the instance name. More...
 
class  ListServerCasRequest
 Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out. More...
 
class  PatchRequest
 Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.. This method supports patch semantics. More...
 
class  PromoteReplicaRequest
 Promotes the read replica instance to be a stand-alone Cloud SQL instance. More...
 
class  ResetSslConfigRequest
 Deletes all client certificates and generates a new server SSL certificate for the instance. More...
 
class  RestartRequest
 Restarts a Cloud SQL instance. More...
 
class  RestoreBackupRequest
 Restores a backup of a Cloud SQL instance. More...
 
class  RotateServerCaRequest
 Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. More...
 
class  StartReplicaRequest
 Starts the replication in the read replica instance. More...
 
class  StopReplicaRequest
 Stops the replication in the read replica instance. More...
 
class  TruncateLogRequest
 Truncate MySQL general and slow query log tables More...
 
class  UpdateRequest
 Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch. More...
 

Public Member Functions

 InstancesResource (Google.Apis.Services.IClientService service)
 Constructs a new resource. More...
 
virtual AddServerCaRequest AddServerCa (string project, string instance)
 Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. More...
 
virtual CloneRequest Clone (Google.Apis.SQLAdmin.v1beta4.Data.InstancesCloneRequest body, string project, string instance)
 Creates a Cloud SQL instance as a clone of the source instance. More...
 
virtual DeleteRequest Delete (string project, string instance)
 Deletes a Cloud SQL instance. More...
 
virtual DemoteMasterRequest DemoteMaster (Google.Apis.SQLAdmin.v1beta4.Data.InstancesDemoteMasterRequest body, string project, string instance)
 Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server. More...
 
virtual ExportRequest Export (Google.Apis.SQLAdmin.v1beta4.Data.InstancesExportRequest body, string project, string instance)
 Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file. More...
 
virtual FailoverRequest Failover (Google.Apis.SQLAdmin.v1beta4.Data.InstancesFailoverRequest body, string project, string instance)
 Failover the instance to its failover replica instance. More...
 
virtual GetRequest Get (string project, string instance)
 Retrieves a resource containing information about a Cloud SQL instance. More...
 
virtual ImportRequest Import (Google.Apis.SQLAdmin.v1beta4.Data.InstancesImportRequest body, string project, string instance)
 Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage. More...
 
virtual InsertRequest Insert (Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance body, string project)
 Creates a new Cloud SQL instance. More...
 
virtual ListRequest List (string project)
 Lists instances under a given project in the alphabetical order of the instance name. More...
 
virtual ListServerCasRequest ListServerCas (string project, string instance)
 Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out. More...
 
virtual PatchRequest Patch (Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance body, string project, string instance)
 Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.. This method supports patch semantics. More...
 
virtual PromoteReplicaRequest PromoteReplica (string project, string instance)
 Promotes the read replica instance to be a stand-alone Cloud SQL instance. More...
 
virtual ResetSslConfigRequest ResetSslConfig (string project, string instance)
 Deletes all client certificates and generates a new server SSL certificate for the instance. More...
 
virtual RestartRequest Restart (string project, string instance)
 Restarts a Cloud SQL instance. More...
 
virtual RestoreBackupRequest RestoreBackup (Google.Apis.SQLAdmin.v1beta4.Data.InstancesRestoreBackupRequest body, string project, string instance)
 Restores a backup of a Cloud SQL instance. More...
 
virtual RotateServerCaRequest RotateServerCa (Google.Apis.SQLAdmin.v1beta4.Data.InstancesRotateServerCaRequest body, string project, string instance)
 Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. More...
 
virtual StartReplicaRequest StartReplica (string project, string instance)
 Starts the replication in the read replica instance. More...
 
virtual StopReplicaRequest StopReplica (string project, string instance)
 Stops the replication in the read replica instance. More...
 
virtual TruncateLogRequest TruncateLog (Google.Apis.SQLAdmin.v1beta4.Data.InstancesTruncateLogRequest body, string project, string instance)
 Truncate MySQL general and slow query log tables More...
 
virtual UpdateRequest Update (Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance body, string project, string instance)
 Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch. More...
 

Detailed Description

The "instances" collection of methods.

Constructor & Destructor Documentation

◆ InstancesResource()

Google.Apis.SQLAdmin.v1beta4.InstancesResource.InstancesResource ( Google.Apis.Services.IClientService  service)
inline

Constructs a new resource.

Member Function Documentation

◆ AddServerCa()

virtual AddServerCaRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.AddServerCa ( string  project,
string  instance 
)
inlinevirtual

Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.

Parameters
projectProject ID of the project that contains the instance.
instanceCloud SQL instance ID. This does not include the project ID.

◆ Clone()

virtual CloneRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.Clone ( Google.Apis.SQLAdmin.v1beta4.Data.InstancesCloneRequest  body,
string  project,
string  instance 
)
inlinevirtual

Creates a Cloud SQL instance as a clone of the source instance.

Parameters
bodyThe body of the request.
projectProject ID of the source as well as the clone Cloud SQL instance.
instanceThe ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.

◆ Delete()

virtual DeleteRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.Delete ( string  project,
string  instance 
)
inlinevirtual

Deletes a Cloud SQL instance.

Parameters
projectProject ID of the project that contains the instance to be deleted.
instanceCloud SQL instance ID. This does not include the project ID.

◆ DemoteMaster()

virtual DemoteMasterRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.DemoteMaster ( Google.Apis.SQLAdmin.v1beta4.Data.InstancesDemoteMasterRequest  body,
string  project,
string  instance 
)
inlinevirtual

Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.

Parameters
bodyThe body of the request.
projectID of the project that contains the instance.
instanceCloud SQL instance name.

◆ Export()

virtual ExportRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.Export ( Google.Apis.SQLAdmin.v1beta4.Data.InstancesExportRequest  body,
string  project,
string  instance 
)
inlinevirtual

Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.

Parameters
bodyThe body of the request.
projectProject ID of the project that contains the instance to be exported.
instanceCloud SQL instance ID. This does not include the project ID.

◆ Failover()

virtual FailoverRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.Failover ( Google.Apis.SQLAdmin.v1beta4.Data.InstancesFailoverRequest  body,
string  project,
string  instance 
)
inlinevirtual

Failover the instance to its failover replica instance.

Parameters
bodyThe body of the request.
projectID of the project that contains the read replica.
instanceCloud SQL instance ID. This does not include the project ID.

◆ Get()

virtual GetRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.Get ( string  project,
string  instance 
)
inlinevirtual

Retrieves a resource containing information about a Cloud SQL instance.

Parameters
projectProject ID of the project that contains the instance.
instanceDatabase instance ID. This does not include the project ID.

◆ Import()

virtual ImportRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.Import ( Google.Apis.SQLAdmin.v1beta4.Data.InstancesImportRequest  body,
string  project,
string  instance 
)
inlinevirtual

Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.

Parameters
bodyThe body of the request.
projectProject ID of the project that contains the instance.
instanceCloud SQL instance ID. This does not include the project ID.

◆ Insert()

virtual InsertRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.Insert ( Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance  body,
string  project 
)
inlinevirtual

Creates a new Cloud SQL instance.

Parameters
bodyThe body of the request.
projectProject ID of the project to which the newly created Cloud SQL instances should belong.

◆ List()

virtual ListRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.List ( string  project)
inlinevirtual

Lists instances under a given project in the alphabetical order of the instance name.

Parameters
projectProject ID of the project for which to list Cloud SQL instances.

◆ ListServerCas()

virtual ListServerCasRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.ListServerCas ( string  project,
string  instance 
)
inlinevirtual

Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.

Parameters
projectProject ID of the project that contains the instance.
instanceCloud SQL instance ID. This does not include the project ID.

◆ Patch()

virtual PatchRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.Patch ( Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance  body,
string  project,
string  instance 
)
inlinevirtual

Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.. This method supports patch semantics.

Parameters
bodyThe body of the request.
projectProject ID of the project that contains the instance.
instanceCloud SQL instance ID. This does not include the project ID.

◆ PromoteReplica()

virtual PromoteReplicaRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.PromoteReplica ( string  project,
string  instance 
)
inlinevirtual

Promotes the read replica instance to be a stand-alone Cloud SQL instance.

Parameters
projectID of the project that contains the read replica.
instanceCloud SQL read replica instance name.

◆ ResetSslConfig()

virtual ResetSslConfigRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.ResetSslConfig ( string  project,
string  instance 
)
inlinevirtual

Deletes all client certificates and generates a new server SSL certificate for the instance.

Parameters
projectProject ID of the project that contains the instance.
instanceCloud SQL instance ID. This does not include the project ID.

◆ Restart()

virtual RestartRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.Restart ( string  project,
string  instance 
)
inlinevirtual

Restarts a Cloud SQL instance.

Parameters
projectProject ID of the project that contains the instance to be restarted.
instanceCloud SQL instance ID. This does not include the project ID.

◆ RestoreBackup()

virtual RestoreBackupRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.RestoreBackup ( Google.Apis.SQLAdmin.v1beta4.Data.InstancesRestoreBackupRequest  body,
string  project,
string  instance 
)
inlinevirtual

Restores a backup of a Cloud SQL instance.

Parameters
bodyThe body of the request.
projectProject ID of the project that contains the instance.
instanceCloud SQL instance ID. This does not include the project ID.

◆ RotateServerCa()

virtual RotateServerCaRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.RotateServerCa ( Google.Apis.SQLAdmin.v1beta4.Data.InstancesRotateServerCaRequest  body,
string  project,
string  instance 
)
inlinevirtual

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.

Parameters
bodyThe body of the request.
projectProject ID of the project that contains the instance.
instanceCloud SQL instance ID. This does not include the project ID.

◆ StartReplica()

virtual StartReplicaRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.StartReplica ( string  project,
string  instance 
)
inlinevirtual

Starts the replication in the read replica instance.

Parameters
projectID of the project that contains the read replica.
instanceCloud SQL read replica instance name.

◆ StopReplica()

virtual StopReplicaRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.StopReplica ( string  project,
string  instance 
)
inlinevirtual

Stops the replication in the read replica instance.

Parameters
projectID of the project that contains the read replica.
instanceCloud SQL read replica instance name.

◆ TruncateLog()

virtual TruncateLogRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.TruncateLog ( Google.Apis.SQLAdmin.v1beta4.Data.InstancesTruncateLogRequest  body,
string  project,
string  instance 
)
inlinevirtual

Truncate MySQL general and slow query log tables

Parameters
bodyThe body of the request.
projectProject ID of the Cloud SQL project.
instanceCloud SQL instance ID. This does not include the project ID.

◆ Update()

virtual UpdateRequest Google.Apis.SQLAdmin.v1beta4.InstancesResource.Update ( Google.Apis.SQLAdmin.v1beta4.Data.DatabaseInstance  body,
string  project,
string  instance 
)
inlinevirtual

Updates settings of a Cloud SQL instance. Caution: This is not a partial update, so you must include values for all the settings that you want to retain. For partial updates, use patch.

Parameters
bodyThe body of the request.
projectProject ID of the project that contains the instance.
instanceCloud SQL instance ID. This does not include the project ID.

The documentation for this class was generated from the following file: