Google Cloud Service Directory V1 Client - Class ListEndpointsRequest (2.0.3)

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

The request message for RegistrationService.ListEndpoints.

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

Namespace

Google \ Cloud \ ServiceDirectory \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The resource name of the service whose endpoints you'd like to list.
↳ page_size int

Optional. The maximum number of items to return.
↳ page_token string

Optional. The next_page_token value returned from a previous List request, if any.
↳ filter string

Optional. The filter to list results by. General filter string syntax: <field> <operator> <value> (<logical connector>) * * <field> can be name, address, port, or annotations.<key> for map field * * <operator> can be <, >, <=, >=, !=, =, :. Of which : means HAS, and is roughly the same as = * * <value> must be the same data type as field * * <logical connector> can be AND, OR, NOT Examples of valid filters: * * annotations.owner returns endpoints that have a annotation with the key owner, this is the same as annotations:owner * * annotations.protocol=gRPC returns endpoints that have key/value protocol=gRPC * * address=192.108.1.105 returns endpoints that have this address * * port>8080 returns endpoints that have port number larger than 8080 * name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/my-service/endpoints/endpoint-c returns endpoints that have name that is alphabetically later than the string, so "endpoint-e" is returned but "endpoint-a" is not * * annotations.owner!=sd AND annotations.foo=bar returns endpoints that have owner in annotation key but value is not sd AND have key/value foo=bar * * doesnotexist.foo=bar returns an empty list. Note that endpoint doesn't have a field called "doesnotexist". Since the filter does not match any endpoints, it returns no results For more information about filtering, see API Filtering.
↳ order_by string

Optional. The order to list results by. General order_by string syntax: <field> (<asc|desc>) (,) * * <field> allows values: name, address, port * * <asc|desc> ascending or descending order by <field>. If this is left blank, asc is used Note that an empty order_by string results in default order, which is order by name in ascending order.

getParent

Required. The resource name of the service whose endpoints you'd like to list.

Returns
Type Description
string

setParent

Required. The resource name of the service whose endpoints you'd like to list.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of items to return.

Returns
Type Description
int

setPageSize

Optional. The maximum number of items to return.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. The next_page_token value returned from a previous List request, if any.

Returns
Type Description
string

setPageToken

Optional. The next_page_token value returned from a previous List request, if any.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. The filter to list results by.

General filter string syntax: <field> <operator> <value> (<logical connector>)

  • <field> can be name, address, port, or annotations.<key> for map field
  • <operator> can be <, >, <=, >=, !=, =, :. Of which : means HAS, and is roughly the same as =
  • <value> must be the same data type as field
  • <logical connector> can be AND, OR, NOT Examples of valid filters:
  • annotations.owner returns endpoints that have a annotation with the key owner, this is the same as annotations:owner
  • annotations.protocol=gRPC returns endpoints that have key/value protocol=gRPC
  • address=192.108.1.105 returns endpoints that have this address
  • port>8080 returns endpoints that have port number larger than 8080 * name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/my-service/endpoints/endpoint-c returns endpoints that have name that is alphabetically later than the string, so "endpoint-e" is returned but "endpoint-a" is not
  • annotations.owner!=sd AND annotations.foo=bar returns endpoints that have owner in annotation key but value is not sd AND have key/value foo=bar
  • doesnotexist.foo=bar returns an empty list. Note that endpoint doesn't have a field called "doesnotexist". Since the filter does not match any endpoints, it returns no results For more information about filtering, see API Filtering.
Returns
Type Description
string

setFilter

Optional. The filter to list results by.

General filter string syntax: <field> <operator> <value> (<logical connector>)

  • <field> can be name, address, port, or annotations.<key> for map field
  • <operator> can be <, >, <=, >=, !=, =, :. Of which : means HAS, and is roughly the same as =
  • <value> must be the same data type as field
  • <logical connector> can be AND, OR, NOT Examples of valid filters:
  • annotations.owner returns endpoints that have a annotation with the key owner, this is the same as annotations:owner
  • annotations.protocol=gRPC returns endpoints that have key/value protocol=gRPC
  • address=192.108.1.105 returns endpoints that have this address
  • port>8080 returns endpoints that have port number larger than 8080 * name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/my-service/endpoints/endpoint-c returns endpoints that have name that is alphabetically later than the string, so "endpoint-e" is returned but "endpoint-a" is not
  • annotations.owner!=sd AND annotations.foo=bar returns endpoints that have owner in annotation key but value is not sd AND have key/value foo=bar
  • doesnotexist.foo=bar returns an empty list. Note that endpoint doesn't have a field called "doesnotexist". Since the filter does not match any endpoints, it returns no results For more information about filtering, see API Filtering.
Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. The order to list results by.

General order_by string syntax: <field> (<asc|desc>) (,)

  • <field> allows values: name, address, port
  • <asc|desc> ascending or descending order by <field>. If this is left blank, asc is used Note that an empty order_by string results in default order, which is order by name in ascending order.
Returns
Type Description
string

setOrderBy

Optional. The order to list results by.

General order_by string syntax: <field> (<asc|desc>) (,)

  • <field> allows values: name, address, port
  • <asc|desc> ascending or descending order by <field>. If this is left blank, asc is used Note that an empty order_by string results in default order, which is order by name in ascending order.
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The resource name of the service whose endpoints you'd like to list. Please see RegistrationServiceClient::serviceName() for help formatting this field.
Returns
Type Description
ListEndpointsRequest