Interface ListEndpointsRequestOrBuilder (2.17.0)

Version 2.17.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.5
• 2.2.7

public interface ListEndpointsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

Optional. The filter to list results by. General filter string syntax: <field> <operator> <value> (<logical connector>)

• <field> can be name, address, port, or metadata.<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:
• 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 For more information about filtering, see API Filtering.

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

Returns
Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Optional. The filter to list results by. General filter string syntax: <field> <operator> <value> (<logical connector>)

• <field> can be name, address, port, or metadata.<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:
• 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 For more information about filtering, see API Filtering.

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

Returns
Type	Description
ByteString	The bytes for filter.

getOrderBy()

public abstract String 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.

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

Returns
Type	Description
String	The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

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];

Returns
Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

Optional. The maximum number of items to return.

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

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

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

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

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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

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

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public abstract String getParent()

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) = { ... }

Returns
Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.