Documentation

Google_Service_SQLAdmin_Resource_BackupRuns extends Google_Service_Resource
in package

The "backupRuns" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_SQLAdmin_Operation
Deletes the backup taken by a backup run. (backupRuns.delete)
get()  : Google_Service_SQLAdmin_BackupRun
Retrieves a resource containing information about a backup run.
insert()  : Google_Service_SQLAdmin_Operation
Creates a new backup run on demand. This method is applicable only to Second Generation instances. (backupRuns.insert)
listBackupRuns()  : Google_Service_SQLAdmin_BackupRunsListResponse
Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes the backup taken by a backup run. (backupRuns.delete)

public delete(string $project, string $instance, string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SQLAdmin_Operation
Parameters
$project : string

Project ID of the project that contains the instance.

$instance : string

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

$id : string

The ID of the Backup Run to delete. To find a Backup Run ID, use the list method.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_SQLAdmin_Operation —

get()

Retrieves a resource containing information about a backup run.

public get(string $project, string $instance, string $id[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SQLAdmin_BackupRun

(backupRuns.get)

Parameters
$project : string

Project ID of the project that contains the instance.

$instance : string

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

$id : string

The ID of this Backup Run.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_SQLAdmin_BackupRun —

insert()

Creates a new backup run on demand. This method is applicable only to Second Generation instances. (backupRuns.insert)

public insert(string $project, string $instance, Google_Service_SQLAdmin_BackupRun $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SQLAdmin_Operation
Parameters
$project : string

Project ID of the project that contains the instance.

$instance : string

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

$postBody : Google_Service_SQLAdmin_BackupRun
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_SQLAdmin_Operation —

listBackupRuns()

Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.

public listBackupRuns(string $project, string $instance[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SQLAdmin_BackupRunsListResponse

(backupRuns.listBackupRuns)

Parameters
$project : string

Project ID of the project that contains the instance.

$instance : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken A previously-returned page token representing part of the larger set of results to view.

opt_param

int maxResults Maximum number of backup runs per response.

Return values
Google_Service_SQLAdmin_BackupRunsListResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results