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

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

Request for the ListDataSourceReferences method.

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

Namespace

Google \ Cloud \ BackupDR \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent resource name. Format: projects/{project}/locations/{location}

↳ page_size int

Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences 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 ListDataSourceReferences call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataSourceReferences must match the call that provided the page token.

↳ filter string

Optional. A filter expression that filters the results listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The following field and operator combinations are supported: * * data_source_gcp_resource_info.gcp_resourcename with =, != * * data_source_gcp_resource_info.type with =, !=

↳ 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. Supported fields: * * data_source * * data_source_gcp_resource_info.gcp_resourcename

getParent

Required. The parent resource name.

Format: projects/{project}/locations/{location}

Returns
Type Description
string

setParent

Required. The parent resource name.

Format: projects/{project}/locations/{location}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences 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 DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences 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 ListDataSourceReferences call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDataSourceReferences must match the call that provided the page token.

Returns
Type Description
string

setPageToken

Optional. A page token, received from a previous ListDataSourceReferences call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDataSourceReferences 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 listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering.

The following field and operator combinations are supported:

  • data_source_gcp_resource_info.gcp_resourcename with =, !=
  • data_source_gcp_resource_info.type with =, !=
Returns
Type Description
string

setFilter

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

The following field and operator combinations are supported:

  • data_source_gcp_resource_info.gcp_resourcename with =, !=
  • data_source_gcp_resource_info.type with =, !=
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.

Supported fields:

  • data_source
  • data_source_gcp_resource_info.gcp_resourcename
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.

Supported fields:

  • data_source
  • data_source_gcp_resource_info.gcp_resourcename
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent resource name. Format: projects/{project}/locations/{location} Please see BackupDRClient::locationName() for help formatting this field.

Returns
Type Description
ListDataSourceReferencesRequest