Google Cloud Deploy V1 Client - Class ListTargetsRequest (1.1.1)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class ListTargetsRequest.

The request object for ListTargets.

Generated from protobuf message google.cloud.deploy.v1.ListTargetsRequest

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}.
↳ page_size int

Optional. The maximum number of Target objects to return. The service may return fewer than this value. If unspecified, at most 50 Target objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
↳ page_token string

Optional. A page token, received from a previous ListTargets call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
↳ filter string

Optional. Filter targets to be returned. See https://google.aip.dev/160 for more details.
↳ order_by string

Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

getParent

Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}.

Returns
Type Description
string

setParent

Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of Target objects to return. The service may return fewer than this value. If unspecified, at most 50 Target objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

Returns
Type Description
int

setPageSize

Optional. The maximum number of Target objects to return. The service may return fewer than this value. If unspecified, at most 50 Target objects 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

Optional. A page token, received from a previous ListTargets 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

Optional. A page token, received from a previous ListTargets 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

Optional. Filter targets to be returned. See https://google.aip.dev/160 for more details.

Returns
Type Description
string

setFilter

Optional. Filter targets to be returned. See https://google.aip.dev/160 for more details.

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

Returns
Type Description
string

setOrderBy

Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}. Please see Google\Cloud\Deploy\V1\CloudDeployClient::locationName() for help formatting this field.
Returns
Type Description
Google\Cloud\Deploy\V1\ListTargetsRequest