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

Inheritance diagram for Google_Service_SQLAdmin_Instances_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.

	cloneInstances ($project, $instance, Google_Service_SQLAdmin_InstancesCloneRequest $postBody, $optParams=array())
	Creates a Cloud SQL instance as a clone of the source instance.

	delete ($project, $instance, $optParams=array())
	Deletes a Cloud SQL instance.

	export ($project, $instance, Google_Service_SQLAdmin_InstancesExportRequest $postBody, $optParams=array())
	Exports data from a Cloud SQL instance to a Google Cloud Storage bucket as a MySQL dump file.

	failover ($project, $instance, Google_Service_SQLAdmin_InstancesFailoverRequest $postBody, $optParams=array())
	Failover the instance to its failover replica instance.

	get ($project, $instance, $optParams=array())
	Retrieves a resource containing information about a Cloud SQL instance.

	import ($project, $instance, Google_Service_SQLAdmin_InstancesImportRequest $postBody, $optParams=array())
	Imports data into a Cloud SQL instance from a MySQL dump file in Google Cloud Storage.

	insert ($project, Google_Service_SQLAdmin_DatabaseInstance $postBody, $optParams=array())
	Creates a new Cloud SQL instance.

	listInstances ($project, $optParams=array())
	Lists instances under a given project in the alphabetical order of the instance name.

	patch ($project, $instance, Google_Service_SQLAdmin_DatabaseInstance $postBody, $optParams=array())
	Updates settings of a Cloud SQL instance.

	promoteReplica ($project, $instance, $optParams=array())
	Promotes the read replica instance to be a stand-alone Cloud SQL instance.

	resetSslConfig ($project, $instance, $optParams=array())
	Deletes all client certificates and generates a new server SSL certificate for the instance.

	restart ($project, $instance, $optParams=array())
	Restarts a Cloud SQL instance.

	restoreBackup ($project, $instance, Google_Service_SQLAdmin_InstancesRestoreBackupRequest $postBody, $optParams=array())
	Restores a backup of a Cloud SQL instance.

	startReplica ($project, $instance, $optParams=array())
	Starts the replication in the read replica instance.

	stopReplica ($project, $instance, $optParams=array())
	Stops the replication in the read replica instance.

	update ($project, $instance, Google_Service_SQLAdmin_DatabaseInstance $postBody, $optParams=array())
	Updates settings of a Cloud SQL instance.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "instances" collection of methods.

Typical usage is: $sqladminService = new Google_Service_SQLAdmin(...); $instances = $sqladminService->instances;

Member Function Documentation

◆ call()

Google_Service_Resource::call	(	$name,
		$arguments,
		$expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

◆ cloneInstances()

Google_Service_SQLAdmin_Instances_Resource::cloneInstances	(		$project,
			$instance,
		Google_Service_SQLAdmin_InstancesCloneRequest	$postBody,
			$optParams = array() )

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

(instances.cloneInstances)

Parameters

string	$project	Project ID of the source as well as the clone Cloud SQL instance.
string	$instance	The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
Google_InstancesCloneRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_Operation

◆ delete()

Google_Service_SQLAdmin_Instances_Resource::delete	(	$project,
		$instance,
		$optParams = array() )

Deletes a Cloud SQL instance.

(instances.delete)

Parameters

string	$project	Project ID of the project that contains the instance to be deleted.
string	$instance	Cloud SQL instance ID. This does not include the project ID.
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_Operation

◆ export()

Google_Service_SQLAdmin_Instances_Resource::export	(		$project,
			$instance,
		Google_Service_SQLAdmin_InstancesExportRequest	$postBody,
			$optParams = array() )

Exports data from a Cloud SQL instance to a Google Cloud Storage bucket as a MySQL dump file.

(instances.export)

Parameters

string	$project	Project ID of the project that contains the instance to be exported.
string	$instance	Cloud SQL instance ID. This does not include the project ID.
Google_InstancesExportRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_Operation

◆ failover()

Google_Service_SQLAdmin_Instances_Resource::failover	(		$project,
			$instance,
		Google_Service_SQLAdmin_InstancesFailoverRequest	$postBody,
			$optParams = array() )

Failover the instance to its failover replica instance.

(instances.failover)

Parameters

string	$project	ID of the project that contains the read replica.
string	$instance	Cloud SQL instance ID. This does not include the project ID.
Google_InstancesFailoverRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_Operation

◆ get()

Google_Service_SQLAdmin_Instances_Resource::get	(	$project,
		$instance,
		$optParams = array() )

Retrieves a resource containing information about a Cloud SQL instance.

(instances.get)

Parameters

string	$project	Project ID of the project that contains the instance.
string	$instance	Database instance ID. This does not include the project ID.
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_DatabaseInstance

◆ import()

Google_Service_SQLAdmin_Instances_Resource::import	(		$project,
			$instance,
		Google_Service_SQLAdmin_InstancesImportRequest	$postBody,
			$optParams = array() )

Imports data into a Cloud SQL instance from a MySQL dump file in Google Cloud Storage.

(instances.import)

Parameters

string	$project	Project ID of the project that contains the instance.
string	$instance	Cloud SQL instance ID. This does not include the project ID.
Google_InstancesImportRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_Operation

◆ insert()

Google_Service_SQLAdmin_Instances_Resource::insert	(		$project,
		Google_Service_SQLAdmin_DatabaseInstance	$postBody,
			$optParams = array() )

Creates a new Cloud SQL instance.

(instances.insert)

Parameters

string	$project	Project ID of the project to which the newly created Cloud SQL instances should belong.
Google_DatabaseInstance	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_Operation

◆ listInstances()

Google_Service_SQLAdmin_Instances_Resource::listInstances	(		$project,
			$optParams = array() )

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

(instances.listInstances)

Parameters

string	$project	Project ID of the project for which to list Cloud SQL instances.
array	$optParams	Optional parameters.

@opt_param string pageToken A previously-returned page token representing part of the larger set of results to view. @opt_param string maxResults The maximum number of results to return per response.

Return values

Google_Service_SQLAdmin_InstancesListResponse

◆ patch()

Google_Service_SQLAdmin_Instances_Resource::patch	(		$project,
			$instance,
		Google_Service_SQLAdmin_DatabaseInstance	$postBody,
			$optParams = array() )

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. (instances.patch)

Parameters

string	$project	Project ID of the project that contains the instance.
string	$instance	Cloud SQL instance ID. This does not include the project ID.
Google_DatabaseInstance	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_Operation

◆ promoteReplica()

Google_Service_SQLAdmin_Instances_Resource::promoteReplica	(	$project,
		$instance,
		$optParams = array() )

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

(instances.promoteReplica)

Parameters

string	$project	ID of the project that contains the read replica.
string	$instance	Cloud SQL read replica instance name.
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_Operation

◆ resetSslConfig()

Google_Service_SQLAdmin_Instances_Resource::resetSslConfig	(	$project,
		$instance,
		$optParams = array() )

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

The changes will not take effect until the instance is restarted. Existing instances without a server certificate will need to call this once to set a server certificate. (instances.resetSslConfig)

Parameters

string	$project	Project ID of the project that contains the instance.
string	$instance	Cloud SQL instance ID. This does not include the project ID.
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_Operation

◆ restart()

Google_Service_SQLAdmin_Instances_Resource::restart	(	$project,
		$instance,
		$optParams = array() )

Restarts a Cloud SQL instance.

(instances.restart)

Parameters

string	$project	Project ID of the project that contains the instance to be restarted.
string	$instance	Cloud SQL instance ID. This does not include the project ID.
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_Operation

◆ restoreBackup()

Google_Service_SQLAdmin_Instances_Resource::restoreBackup	(		$project,
			$instance,
		Google_Service_SQLAdmin_InstancesRestoreBackupRequest	$postBody,
			$optParams = array() )

Restores a backup of a Cloud SQL instance.

(instances.restoreBackup)

Parameters

string	$project	Project ID of the project that contains the instance.
string	$instance	Cloud SQL instance ID. This does not include the project ID.
Google_InstancesRestoreBackupRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_Operation

◆ startReplica()

Google_Service_SQLAdmin_Instances_Resource::startReplica	(	$project,
		$instance,
		$optParams = array() )

Starts the replication in the read replica instance.

(instances.startReplica)

Parameters

string	$project	ID of the project that contains the read replica.
string	$instance	Cloud SQL read replica instance name.
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_Operation

◆ stopReplica()

Google_Service_SQLAdmin_Instances_Resource::stopReplica	(	$project,
		$instance,
		$optParams = array() )

Stops the replication in the read replica instance.

(instances.stopReplica)

Parameters

string	$project	ID of the project that contains the read replica.
string	$instance	Cloud SQL read replica instance name.
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_Operation

◆ update()

Google_Service_SQLAdmin_Instances_Resource::update	(		$project,
			$instance,
		Google_Service_SQLAdmin_DatabaseInstance	$postBody,
			$optParams = array() )

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. (instances.update)

Parameters

string	$project	Project ID of the project that contains the instance.
string	$instance	Cloud SQL instance ID. This does not include the project ID.
Google_DatabaseInstance	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_SQLAdmin_Operation

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

lib/google/src/Google/Service/SQLAdmin.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ call()

◆ cloneInstances()

◆ delete()

◆ export()

◆ failover()

◆ get()

◆ import()

◆ insert()

◆ listInstances()

◆ patch()

◆ promoteReplica()

◆ resetSslConfig()

◆ restart()

◆ restoreBackup()

◆ startReplica()

◆ stopReplica()

◆ update()