Google Cloud Backup Dr V1 Client - Class FetchBackupsForResourceTypeRequest (0.9.0)

Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class FetchBackupsForResourceTypeRequest.

Request for the FetchBackupsForResourceType method.

Generated from protobuf message google.cloud.backupdr.v1.FetchBackupsForResourceTypeRequest

Namespace

Google \ Cloud \ BackupDR \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Datasources are the parent resource for the backups. Format: projects/{project}/locations/{location}/backupVaults/{backupVaultId}/dataSources/{datasourceId}

↳ resource_type string

Required. The type of the GCP resource. Ex: sqladmin.googleapis.com/Instance

↳ page_size int

Optional. The maximum number of Backups to return. The service may return fewer than this value. If unspecified, at most 50 Backups will be returned. The maximum value is 100; values above 100 will be coerced to 100.

↳ page_token string

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

↳ filter string

Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields:

↳ order_by string

Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

↳ view int

Optional. This parameter is used to specify the view of the backup. If not specified, the default view is BASIC.

getParent

Required. Datasources are the parent resource for the backups.

Format: projects/{project}/locations/{location}/backupVaults/{backupVaultId}/dataSources/{datasourceId}

Returns
Type Description
string

setParent

Required. Datasources are the parent resource for the backups.

Format: projects/{project}/locations/{location}/backupVaults/{backupVaultId}/dataSources/{datasourceId}

Parameter
Name Description
var string
Returns
Type Description
$this

getResourceType

Required. The type of the GCP resource.

Ex: sqladmin.googleapis.com/Instance

Returns
Type Description
string

setResourceType

Required. The type of the GCP resource.

Ex: sqladmin.googleapis.com/Instance

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of Backups to return. The service may return fewer than this value. If unspecified, at most 50 Backups will be returned. The maximum value is 100; values above 100 will be coerced to 100.

Returns
Type Description
int

setPageSize

Optional. The maximum number of Backups to return. The service may return fewer than this value. If unspecified, at most 50 Backups will be returned. The maximum value is 100; values above 100 will be coerced to 100.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A page token, received from a previous call of FetchBackupsForResourceType.

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

Returns
Type Description
string

setPageToken

Optional. A page token, received from a previous call of FetchBackupsForResourceType.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields:

Returns
Type Description
string

setFilter

Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields:

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

Returns
Type Description
string

setOrderBy

Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

Parameter
Name Description
var string
Returns
Type Description
$this

getView

Optional. This parameter is used to specify the view of the backup.

If not specified, the default view is BASIC.

Returns
Type Description
int Enum of type BackupView.

setView

Optional. This parameter is used to specify the view of the backup.

If not specified, the default view is BASIC.

Parameter
Name Description
var int

Enum of type BackupView.

Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. Datasources are the parent resource for the backups. Format: projects/{project}/locations/{location}/backupVaults/{backupVaultId}/dataSources/{datasourceId} Please see BackupDRClient::dataSourceName() for help formatting this field.

resourceType string

Required. The type of the GCP resource. Ex: sqladmin.googleapis.com/Instance

Returns
Type Description
FetchBackupsForResourceTypeRequest