Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class ListBackupPlansRequest.
Request message for ListBackupPlans.
Generated from protobuf message google.cloud.gkebackup.v1.ListBackupPlansRequest
Namespace
Google \ Cloud \ GkeBackup \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The location that contains the BackupPlans to list. Format: |
↳ page_size |
int
Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried. |
↳ page_token |
string
Optional. The value of next_page_token received from a previous |
↳ filter |
string
Optional. Field match expression used to filter the results. |
↳ order_by |
string
Optional. Field by which to sort the results. |
getParent
Required. The location that contains the BackupPlans to list.
Format: projects/*/locations/*
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The location that contains the BackupPlans to list.
Format: projects/*/locations/*
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. The target number of results to return in a single response.
If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. The target number of results to return in a single response.
If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. The value of
next_page_token
received from a previous ListBackupPlans call.
Provide this to retrieve the subsequent page in a multi-page list of
results. When paginating, all other parameters provided to
ListBackupPlans must match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. The value of
next_page_token
received from a previous ListBackupPlans call.
Provide this to retrieve the subsequent page in a multi-page list of
results. When paginating, all other parameters provided to
ListBackupPlans must match the call that provided the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. Field match expression used to filter the results.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. Field match expression used to filter the results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Optional. Field by which to sort the results.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Optional. Field by which to sort the results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The location that contains the BackupPlans to list.
Format: |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest |
|