Class ListEndpointsRequest (2.44.0)

The request message for RegistrationService.ListEndpoints.

Protobuf type google.cloud.servicedirectory.v1beta1.ListEndpointsRequest

Optional. The filter to list results by.

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

• <field> can be name, address, port, metadata.<key> for map field, or attributes.<field> for attributes 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:

• metadata.owner returns endpoints that have a metadata with the key owner, this is the same as metadata:owner

• metadata.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
• metadata.owner!=sd AND metadata.foo=bar returns endpoints that have owner in metadata 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

• attributes.kubernetes_resource_type=KUBERNETES_RESOURCE_TYPE_CLUSTER_ IP returns endpoints with the corresponding kubernetes_resource_type

  For more information about filtering, see API Filtering.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Optional. The filter to list results by.

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

• <field> can be name, address, port, metadata.<key> for map field, or attributes.<field> for attributes 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:

• metadata.owner returns endpoints that have a metadata with the key owner, this is the same as metadata:owner

• metadata.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
• metadata.owner!=sd AND metadata.foo=bar returns endpoints that have owner in metadata 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

• attributes.kubernetes_resource_type=KUBERNETES_RESOURCE_TYPE_CLUSTER_ IP returns endpoints with the corresponding kubernetes_resource_type

  For more information about filtering, see API Filtering.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

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.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

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.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Optional. The maximum number of items to return.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

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

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

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

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }