public interface ListEndpointsRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getFilter()
public abstract String getFilter()
Optional. The filter to list results by.
General filter
string syntax:
<field> <operator> <value> (<logical connector>)
<field>
can bename
,address
,port
, orannotations.<key>
for map field<operator>
can be<
,>
,<=
,>=
,!=
,=
,:
. Of which:
meansHAS
, and is roughly the same as=
<value>
must be the same data type as field<logical connector>
can beAND
,OR
,NOT
Examples of valid filters:
annotations.owner
returns endpoints that have a annotation with the keyowner
, this is the same asannotations:owner
annotations.protocol=gRPC
returns endpoints that have key/valueprotocol=gRPC
address=192.108.1.105
returns endpoints that have this addressport>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 notannotations.owner!=sd AND annotations.foo=bar
returns endpoints that haveowner
in annotation key but value is notsd
AND have key/valuefoo=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 resultsFor 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 bename
,address
,port
, orannotations.<key>
for map field<operator>
can be<
,>
,<=
,>=
,!=
,=
,:
. Of which:
meansHAS
, and is roughly the same as=
<value>
must be the same data type as field<logical connector>
can beAND
,OR
,NOT
Examples of valid filters:
annotations.owner
returns endpoints that have a annotation with the keyowner
, this is the same asannotations:owner
annotations.protocol=gRPC
returns endpoints that have key/valueprotocol=gRPC
address=192.108.1.105
returns endpoints that have this addressport>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 notannotations.owner!=sd AND annotations.foo=bar
returns endpoints that haveowner
in annotation key but value is notsd
AND have key/valuefoo=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 resultsFor 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 usedNote that an empty
order_by
string results in default order, which is order byname
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 usedNote that an empty
order_by
string results in default order, which is order byname
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. |