Reference documentation and code samples for the Service Directory V1beta1 API class Google::Cloud::ServiceDirectory::V1beta1::ListEndpointsRequest.
The request message for RegistrationService.ListEndpoints.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#filter
def filter() -> ::String
-
(::String) — Optional. The filter to list results by.
General
filter
string syntax:<field> <operator> <value> (<logical connector>)
-
<field>
can bename
,address
,port
,metadata.<key>
for map field, orattributes.<field>
for attributes 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:
-
metadata.owner
returns endpoints that have a metadata with the keyowner
, this is the same asmetadata:owner
-
metadata.protocol=gRPC
returns endpoints that have key/valueprotocol=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 haveowner
in metadata 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 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.
-
#filter=
def filter=(value) -> ::String
-
value (::String) — Optional. The filter to list results by.
General
filter
string syntax:<field> <operator> <value> (<logical connector>)
-
<field>
can bename
,address
,port
,metadata.<key>
for map field, orattributes.<field>
for attributes 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:
-
metadata.owner
returns endpoints that have a metadata with the keyowner
, this is the same asmetadata:owner
-
metadata.protocol=gRPC
returns endpoints that have key/valueprotocol=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 haveowner
in metadata 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 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) — Optional. The filter to list results by.
General
filter
string syntax:<field> <operator> <value> (<logical connector>)
-
<field>
can bename
,address
,port
,metadata.<key>
for map field, orattributes.<field>
for attributes 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:
-
metadata.owner
returns endpoints that have a metadata with the keyowner
, this is the same asmetadata:owner
-
metadata.protocol=gRPC
returns endpoints that have key/valueprotocol=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 haveowner
in metadata 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 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.
-
#order_by
def order_by() -> ::String
-
(::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 byname
in ascending order. -
#order_by=
def order_by=(value) -> ::String
-
value (::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 byname
in ascending order. -
-
(::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 byname
in ascending order. -
#page_size
def page_size() -> ::Integer
- (::Integer) — Optional. The maximum number of items to return. The default value is 100.
#page_size=
def page_size=(value) -> ::Integer
- value (::Integer) — Optional. The maximum number of items to return. The default value is 100.
- (::Integer) — Optional. The maximum number of items to return. The default value is 100.
#page_token
def page_token() -> ::String
- (::String) — Optional. The next_page_token value returned from a previous List request, if any.
#page_token=
def page_token=(value) -> ::String
- value (::String) — Optional. The next_page_token value returned from a previous List request, if any.
- (::String) — Optional. The next_page_token value returned from a previous List request, if any.
#parent
def parent() -> ::String
- (::String) — Required. The resource name of the service whose endpoints you'd like to list.
#parent=
def parent=(value) -> ::String
- value (::String) — Required. The resource name of the service whose endpoints you'd like to list.
- (::String) — Required. The resource name of the service whose endpoints you'd like to list.