public final class ListEndpointsRequest extends GeneratedMessageV3 implements ListEndpointsRequestOrBuilder
The request message for RegistrationService.ListEndpoints.
Protobuf type google.cloud.servicedirectory.v1beta1.ListEndpointsRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListEndpointsRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ListEndpointsRequest.Builder newBuilder()
Returns
newBuilder(ListEndpointsRequest prototype)
public static ListEndpointsRequest.Builder newBuilder(ListEndpointsRequest prototype)
Parameter
Returns
public static ListEndpointsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListEndpointsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListEndpointsRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListEndpointsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListEndpointsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListEndpointsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListEndpointsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListEndpointsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListEndpointsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListEndpointsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListEndpointsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListEndpointsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListEndpointsRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ListEndpointsRequest getDefaultInstanceForType()
Returns
getFilter()
public 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 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
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 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 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
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
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
getParserForType()
public Parser<ListEndpointsRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ListEndpointsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListEndpointsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ListEndpointsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions