Reference documentation and code samples for the Google Cloud Deploy V1 Client class ListDeliveryPipelinesRequest.
The request object for ListDeliveryPipelines.
Generated from protobuf message google.cloud.deploy.v1.ListDeliveryPipelinesRequest
Methods
build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}. Please see {@see \Google\Cloud\Deploy\V1\CloudDeployClient::locationName()} for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\ListDeliveryPipelinesRequest | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}. |
↳ page_size |
int
The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines will be returned. The maximum value is 1000; values above 1000 will be set to 1000. |
↳ page_token |
string
A page token, received from a previous |
↳ filter |
string
Filter pipelines to be returned. See https://google.aip.dev/160 for more details. |
↳ order_by |
string
Field to sort by. See https://google.aip.dev/132#ordering for more details. |
getParent
Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
A page token, received from a previous ListDeliveryPipelines call.
Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
A page token, received from a previous ListDeliveryPipelines call.
Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
Filter pipelines to be returned. See https://google.aip.dev/160 for more details.
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Filter pipelines to be returned. See https://google.aip.dev/160 for more details.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrderBy
Field to sort by. See https://google.aip.dev/132#ordering for more details.
| Returns | |
|---|---|
| Type | Description |
string | |
setOrderBy
Field to sort by. See https://google.aip.dev/132#ordering for more details.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |