Google Cloud Ids V1 Client - Class ListEndpointsRequest (0.5.5)

Reference documentation and code samples for the Google Cloud Ids V1 Client class ListEndpointsRequest.

Generated from protobuf message google.cloud.ids.v1.ListEndpointsRequest

Namespace

Google \ Cloud \ Ids \ 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 endpoints.
`↳ page_size`	`int` Optional. The maximum number of endpoints to return. The service may return fewer than this value.
`↳ page_token`	`string` Optional. A page token, received from a previous `ListEndpoints` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEndpoints` must match the call that provided the page token.
`↳ filter`	`string` Optional. The filter expression, following the syntax outlined in https://google.aip.dev/160.
`↳ order_by`	`string` Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

getParent

Required. The parent, which owns this collection of endpoints.

Returns
Type	Description
`string`

setParent

Required. The parent, which owns this collection of endpoints.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

Optional. The maximum number of endpoints to return. The service may return fewer than this value.

Returns
Type	Description
`int`

setPageSize

Optional. The maximum number of endpoints to return. The service may return fewer than this value.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

Optional. A page token, received from a previous ListEndpoints call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEndpoints must match the call that provided the page token.

Returns
Type	Description
`string`

setPageToken

Optional. A page token, received from a previous ListEndpoints call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEndpoints must match the call that provided the page token.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

Optional. The filter expression, following the syntax outlined in https://google.aip.dev/160.

Returns
Type	Description
`string`

setFilter

Optional. The filter expression, following the syntax outlined in https://google.aip.dev/160.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrderBy

Optional. One or more fields to compare and use to sort the output.

See https://google.aip.dev/132#ordering.

Returns
Type	Description
`string`

setOrderBy

Optional. One or more fields to compare and use to sort the output.

See https://google.aip.dev/132#ordering.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`parent`	`string` Required. The parent, which owns this collection of endpoints. Please see Google\Cloud\Ids\V1\IDSClient::locationName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Ids\V1\ListEndpointsRequest`