Google Cloud Agent Registry V1 Client - Class ListEndpointsRequest (0.2.0)

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

Message for requesting list of Endpoints

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

Namespace

Google \ Cloud \ AgentRegistry \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The project and location to list endpoints in. Expected format: projects/{project}/locations/{location}.
↳ page_size int

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
↳ page_token string

Optional. A token identifying a page of results the server should return.
↳ filter string

Optional. A query string used to filter the list of endpoints returned. The filter expression must follow AIP-160 syntax. Filtering is supported on the name, display_name, description, version, and interfaces fields. Some examples: * * name = "projects/p1/locations/l1/endpoints/e1" * * display_name = "my-endpoint" * * description = "my-endpoint-description" * * version = "v1" * * interfaces.transport = "HTTP_JSON"

getParent

Required. The project and location to list endpoints in.

Expected format: projects/{project}/locations/{location}.

Returns
Type Description
string

setParent

Required. The project and location to list endpoints in.

Expected format: projects/{project}/locations/{location}.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Returns
Type Description
int

setPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A token identifying a page of results the server should return.

Returns
Type Description
string

setPageToken

Optional. A token identifying a page of results the server should return.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. A query string used to filter the list of endpoints returned.

The filter expression must follow AIP-160 syntax. Filtering is supported on the name, display_name, description, version, and interfaces fields. Some examples:

  • name = "projects/p1/locations/l1/endpoints/e1"
  • display_name = "my-endpoint"
  • description = "my-endpoint-description"
  • version = "v1"
  • interfaces.transport = "HTTP_JSON"
Returns
Type Description
string

setFilter

Optional. A query string used to filter the list of endpoints returned.

The filter expression must follow AIP-160 syntax. Filtering is supported on the name, display_name, description, version, and interfaces fields. Some examples:

  • name = "projects/p1/locations/l1/endpoints/e1"
  • display_name = "my-endpoint"
  • description = "my-endpoint-description"
  • version = "v1"
  • interfaces.transport = "HTTP_JSON"
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The project and location to list endpoints in. Expected format: projects/{project}/locations/{location}. Please see AgentRegistryClient::locationName() for help formatting this field.
Returns
Type Description
ListEndpointsRequest