Reference documentation and code samples for the Google Cloud Dataproc Metastore V1 Client class ListBackupsRequest.
Request message for DataprocMetastore.ListBackups.
Generated from protobuf message google.cloud.metastore.v1.ListBackupsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The relative resource name of the service whose backups to list, in the following form: |
↳ page_size |
int
Optional. The maximum number of backups to return. The response may contain less than the maximum number. If unspecified, no more than 500 backups are returned. The maximum value is 1000; values above 1000 are changed to 1000. |
↳ page_token |
string
Optional. A page token, received from a previous DataprocMetastore.ListBackups call. Provide this token to retrieve the subsequent page. To retrieve the first page, supply an empty page token. When paginating, other parameters provided to DataprocMetastore.ListBackups must match the call that provided the page token. |
↳ filter |
string
Optional. The filter to apply to list results. |
↳ order_by |
string
Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order. |
getParent
Required. The relative resource name of the service whose backups to
list, in the following form:
projects/{project_number}/locations/{location_id}/services/{service_id}/backups.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The relative resource name of the service whose backups to
list, in the following form:
projects/{project_number}/locations/{location_id}/services/{service_id}/backups.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Optional. The maximum number of backups to return. The response may contain less than the maximum number. If unspecified, no more than 500 backups are returned. The maximum value is 1000; values above 1000 are changed to 1000.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Optional. The maximum number of backups to return. The response may contain less than the maximum number. If unspecified, no more than 500 backups are returned. The maximum value is 1000; values above 1000 are changed to 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
Optional. A page token, received from a previous DataprocMetastore.ListBackups call. Provide this token to retrieve the subsequent page.
To retrieve the first page, supply an empty page token. When paginating, other parameters provided to DataprocMetastore.ListBackups must match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
Optional. A page token, received from a previous DataprocMetastore.ListBackups call. Provide this token to retrieve the subsequent page.
To retrieve the first page, supply an empty page token. When paginating, other parameters provided to DataprocMetastore.ListBackups must match the call that provided the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
Optional. The filter to apply to list results.
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Optional. The filter to apply to list results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrderBy
Optional. Specify the ordering of results as described in Sorting Order.
If not specified, the results will be sorted in the default order.
| Returns | |
|---|---|
| Type | Description |
string | |
setOrderBy
Optional. Specify the ordering of results as described in Sorting Order.
If not specified, the results will be sorted in the default order.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |