public final class ResolveServiceRequest extends GeneratedMessageV3 implements ResolveServiceRequestOrBuilder
The request message for LookupService.ResolveService.
Looks up a service by its name, returns the service and its endpoints.
Protobuf type google.cloud.servicedirectory.v1beta1.ResolveServiceRequest
Static Fields
ENDPOINT_FILTER_FIELD_NUMBER
public static final int ENDPOINT_FILTER_FIELD_NUMBER
Field Value
MAX_ENDPOINTS_FIELD_NUMBER
public static final int MAX_ENDPOINTS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ResolveServiceRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ResolveServiceRequest.Builder newBuilder()
Returns
newBuilder(ResolveServiceRequest prototype)
public static ResolveServiceRequest.Builder newBuilder(ResolveServiceRequest prototype)
Parameter
Returns
public static ResolveServiceRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ResolveServiceRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ResolveServiceRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ResolveServiceRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ResolveServiceRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ResolveServiceRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ResolveServiceRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ResolveServiceRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ResolveServiceRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ResolveServiceRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ResolveServiceRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ResolveServiceRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ResolveServiceRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ResolveServiceRequest getDefaultInstanceForType()
Returns
getEndpointFilter()
public String getEndpointFilter()
Optional. The filter applied to the endpoints of the resolved service.
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 annotation 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 annotation 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 endpoint, it returns no results
For more information about filtering, see
API Filtering.
string endpoint_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type | Description |
String | The endpointFilter.
|
getEndpointFilterBytes()
public ByteString getEndpointFilterBytes()
Optional. The filter applied to the endpoints of the resolved service.
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 annotation 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 annotation 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 endpoint, it returns no results
For more information about filtering, see
API Filtering.
string endpoint_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type | Description |
ByteString | The bytes for endpointFilter.
|
getMaxEndpoints()
public int getMaxEndpoints()
Optional. The maximum number of endpoints to return. Defaults to 25. Maximum is 100.
If a value less than one is specified, the Default is used.
If a value greater than the Maximum is specified, the Maximum is used.
int32 max_endpoints = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type | Description |
int | The maxEndpoints.
|
getName()
Required. The name of the service to resolve.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. The name of the service to resolve.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
getParserForType()
public Parser<ResolveServiceRequest> 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 ResolveServiceRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ResolveServiceRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ResolveServiceRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions