public static final class ListEndpointsRequest.Builder extends GeneratedMessageV3.Builder<ListEndpointsRequest.Builder> implements ListEndpointsRequestOrBuilder
The request message for RegistrationService.ListEndpoints.
Protobuf type google.cloud.servicedirectory.v1beta1.ListEndpointsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListEndpointsRequest.BuilderImplements
ListEndpointsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListEndpointsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ListEndpointsRequest.Builder |
build()
public ListEndpointsRequest build()
Returns | |
---|---|
Type | Description |
ListEndpointsRequest |
buildPartial()
public ListEndpointsRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListEndpointsRequest |
clear()
public ListEndpointsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListEndpointsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListEndpointsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListEndpointsRequest.Builder |
clearFilter()
public ListEndpointsRequest.Builder clearFilter()
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 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 notmetadata.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 resultsattributes.kubernetes_resource_type=KUBERNETES_RESOURCE_TYPE_CLUSTER_ IP
returns endpoints with the corresponding kubernetes_resource_typeFor more information about filtering, see API Filtering.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ListEndpointsRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListEndpointsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListEndpointsRequest.Builder |
clearOrderBy()
public ListEndpointsRequest.Builder clearOrderBy()
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 |
ListEndpointsRequest.Builder | This builder for chaining. |
clearPageSize()
public ListEndpointsRequest.Builder clearPageSize()
Optional. The maximum number of items to return.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ListEndpointsRequest.Builder | This builder for chaining. |
clearPageToken()
public ListEndpointsRequest.Builder clearPageToken()
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 |
ListEndpointsRequest.Builder | This builder for chaining. |
clearParent()
public ListEndpointsRequest.Builder clearParent()
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 |
ListEndpointsRequest.Builder | This builder for chaining. |
clone()
public ListEndpointsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListEndpointsRequest.Builder |
getDefaultInstanceForType()
public ListEndpointsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListEndpointsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getFilter()
public String getFilter()
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 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 notmetadata.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 resultsattributes.kubernetes_resource_type=KUBERNETES_RESOURCE_TYPE_CLUSTER_ IP
returns endpoints with the corresponding kubernetes_resource_typeFor more information about filtering, see API Filtering.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The filter. |
getFilterBytes()
public ByteString getFilterBytes()
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 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 notmetadata.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 resultsattributes.kubernetes_resource_type=KUBERNETES_RESOURCE_TYPE_CLUSTER_ IP
returns endpoints with the corresponding kubernetes_resource_typeFor 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 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.Fiel