public final class ListEndpointsRequest extends com.google.protobuf.GeneratedMessageV3 implements ListEndpointsRequestOrBuilder
The request message for [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].Protobuf type
google.cloud.servicedirectory.v1beta1.ListEndpointsRequest| Modifier and Type | Class and Description |
|---|---|
static class |
ListEndpointsRequest.Builder
The request message for [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
FILTER_FIELD_NUMBER |
static int |
ORDER_BY_FIELD_NUMBER |
static int |
PAGE_SIZE_FIELD_NUMBER |
static int |
PAGE_TOKEN_FIELD_NUMBER |
static int |
PARENT_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static ListEndpointsRequest |
getDefaultInstance() |
ListEndpointsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getFilter()
Optional.
|
com.google.protobuf.ByteString |
getFilterBytes()
Optional.
|
String |
getOrderBy()
Optional.
|
com.google.protobuf.ByteString |
getOrderByBytes()
Optional.
|
int |
getPageSize()
Optional.
|
String |
getPageToken()
Optional.
|
com.google.protobuf.ByteString |
getPageTokenBytes()
Optional.
|
String |
getParent()
Required.
|
com.google.protobuf.ByteString |
getParentBytes()
Required.
|
com.google.protobuf.Parser<ListEndpointsRequest> |
getParserForType() |
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ListEndpointsRequest.Builder |
newBuilder() |
static ListEndpointsRequest.Builder |
newBuilder(ListEndpointsRequest prototype) |
ListEndpointsRequest.Builder |
newBuilderForType() |
protected ListEndpointsRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ListEndpointsRequest |
parseDelimitedFrom(InputStream input) |
static ListEndpointsRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListEndpointsRequest |
parseFrom(byte[] data) |
static ListEndpointsRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListEndpointsRequest |
parseFrom(ByteBuffer data) |
static ListEndpointsRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListEndpointsRequest |
parseFrom(com.google.protobuf.ByteString data) |
static ListEndpointsRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListEndpointsRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ListEndpointsRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListEndpointsRequest |
parseFrom(InputStream input) |
static ListEndpointsRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ListEndpointsRequest> |
parser() |
ListEndpointsRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int PARENT_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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) = { ... }
getParent in interface ListEndpointsRequestOrBuilderpublic com.google.protobuf.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) = { ... }
getParentBytes in interface ListEndpointsRequestOrBuilderpublic int getPageSize()
Optional. The maximum number of items to return.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];getPageSize in interface ListEndpointsRequestOrBuilderpublic 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];getPageToken in interface ListEndpointsRequestOrBuilderpublic com.google.protobuf.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];getPageTokenBytes in interface ListEndpointsRequestOrBuilderpublic 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](https://aip.dev/160).
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];getFilter in interface ListEndpointsRequestOrBuilderpublic com.google.protobuf.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](https://aip.dev/160).
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];getFilterBytes in interface ListEndpointsRequestOrBuilderpublic 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];getOrderBy in interface ListEndpointsRequestOrBuilderpublic com.google.protobuf.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];getOrderByBytes in interface ListEndpointsRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ListEndpointsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListEndpointsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListEndpointsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListEndpointsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListEndpointsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListEndpointsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListEndpointsRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static ListEndpointsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ListEndpointsRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ListEndpointsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ListEndpointsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ListEndpointsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ListEndpointsRequest.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ListEndpointsRequest.Builder newBuilder()
public static ListEndpointsRequest.Builder newBuilder(ListEndpointsRequest prototype)
public ListEndpointsRequest.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ListEndpointsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ListEndpointsRequest getDefaultInstance()
public static com.google.protobuf.Parser<ListEndpointsRequest> parser()
public com.google.protobuf.Parser<ListEndpointsRequest> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ListEndpointsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.