public final class ListServicesRequest extends GeneratedMessageV3 implements ListServicesRequestOrBuilder
The request message for
RegistrationService.ListServices.
Protobuf type google.cloud.servicedirectory.v1beta1.ListServicesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListServicesRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListServicesRequest.Builder newBuilder()
newBuilder(ListServicesRequest prototype)
public static ListServicesRequest.Builder newBuilder(ListServicesRequest prototype)
public static ListServicesRequest parseDelimitedFrom(InputStream input)
public static ListServicesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListServicesRequest parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListServicesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListServicesRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListServicesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListServicesRequest parseFrom(CodedInputStream input)
public static ListServicesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListServicesRequest parseFrom(InputStream input)
public static ListServicesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListServicesRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListServicesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListServicesRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListServicesRequest getDefaultInstanceForType()
getFilter()
public String getFilter()
Optional. The filter to list results by.
General filter
string syntax:
<field> <operator> <value> (<logical connector>)
<field>
can be name
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 services that have a metadata with the key
owner
, this is the same as metadata:owner
metadata.protocol=gRPC
returns services that have key/value
protocol=gRPC
*
name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/service-c
returns services that have name that is alphabetically later than the
string, so "service-e" is returned but "service-a" is not
metadata.owner!=sd AND metadata.foo=bar
returns services 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 service
doesn't have a field called "doesnotexist". Since the filter does not
match any services, it returns no results
attributes.managed_registration=true
returns services that are
managed
by a GCP product or service
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
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 services that have a metadata with the key
owner
, this is the same as metadata:owner
metadata.protocol=gRPC
returns services that have key/value
protocol=gRPC
*
name>projects/my-project/locations/us-east1/namespaces/my-namespace/services/service-c
returns services that have name that is alphabetically later than the
string, so "service-e" is returned but "service-a" is not
metadata.owner!=sd AND metadata.foo=bar
returns services 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 service
doesn't have a field called "doesnotexist". Since the filter does not
match any services, it returns no results
attributes.managed_registration=true
returns services that are
managed
by a GCP product or service
For 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 value: name
<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 value: name
<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 |
ByteString |
The bytes for orderBy.
|
getPageSize()
Optional. The maximum number of items to return. The default value is 100.
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 namespace whose services 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 namespace whose services 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.
|
getParserForType()
public Parser<ListServicesRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListServicesRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListServicesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public ListServicesRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides