Google Cloud Sql Admin V1 Client - Class ListBackupsRequest (1.6.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class ListBackupsRequest.

The request payload to list the backups.

Generated from protobuf message google.cloud.sql.v1.ListBackupsRequest

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. The parent that owns this collection of backups. Format: projects/{project}

↳ page_size
int

The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000.

↳ page_token
string

A page token, received from a previous ListBackups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBackups must match the call that provided the page token.

↳ filter
string

Multiple filter queries are separated by spaces. For example, 'instance:abc AND type:FINAL, 'location:us', 'backupInterval.startTime>=1950-01-01T01:01:25.771Z'. You can filter by type, instance, backupInterval.startTime (creation time), or location.

getParent

Required. The parent that owns this collection of backups.

Format: projects/{project}

Returns
Type
Description
string

setParent

Required. The parent that owns this collection of backups.

Format: projects/{project}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000.

Returns
Type
Description
int

setPageSize

The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

A page token, received from a previous ListBackups call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBackups must match the call that provided the page token.

Returns
Type
Description
string

setPageToken

A page token, received from a previous ListBackups call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBackups must match the call that provided the page token.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFilter

Multiple filter queries are separated by spaces. For example, 'instance:abc AND type:FINAL, 'location:us', 'backupInterval.startTime>=1950-01-01T01:01:25.771Z'. You can filter by type, instance, backupInterval.startTime (creation time), or location.

Returns
Type
Description
string

setFilter

Multiple filter queries are separated by spaces. For example, 'instance:abc AND type:FINAL, 'location:us', 'backupInterval.startTime>=1950-01-01T01:01:25.771Z'. You can filter by type, instance, backupInterval.startTime (creation time), or location.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

static::build

Parameter
Name
Description
parent
string

Required. The parent that owns this collection of backups. Format: projects/{project} Please see SqlBackupsServiceClient::projectName() for help formatting this field.

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: