Class ResolveServiceRequest (2.54.0) 

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.v1.ResolveServiceRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ResolveServiceRequest

Static Fields

ENDPOINT_FILTER_FIELD_NUMBER

public static final int ENDPOINT_FILTER_FIELD_NUMBER
Field Value
Type Description
int

MAX_ENDPOINTS_FIELD_NUMBER

public static final int MAX_ENDPOINTS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ResolveServiceRequest getDefaultInstance()
Returns
Type Description
ResolveServiceRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ResolveServiceRequest.Builder newBuilder()
Returns
Type Description
ResolveServiceRequest.Builder

newBuilder(ResolveServiceRequest prototype)

public static ResolveServiceRequest.Builder newBuilder(ResolveServiceRequest prototype)
Parameter
Name Description
prototype ResolveServiceRequest
Returns
Type Description
ResolveServiceRequest.Builder

parseDelimitedFrom(InputStream input)

public static ResolveServiceRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ResolveServiceRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ResolveServiceRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResolveServiceRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ResolveServiceRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ResolveServiceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ResolveServiceRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResolveServiceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ResolveServiceRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ResolveServiceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ResolveServiceRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResolveServiceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ResolveServiceRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ResolveServiceRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ResolveServiceRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResolveServiceRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ResolveServiceRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ResolveServiceRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ResolveServiceRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResolveServiceRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ResolveServiceRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ResolveServiceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ResolveServiceRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResolveServiceRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ResolveServiceRequest> parser()
Returns
Type Description
Parser<ResolveServiceRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ResolveServiceRequest getDefaultInstanceForType()
Returns
Type Description
ResolveServiceRequest

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 annotations.<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:

  • annotations.owner returns endpoints that have a annotation with the key owner, this is the same as annotations:owner

  • annotations.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 * name=projects/my-project/locations/us-central1/namespaces/my-namespace/services/my-service/endpoints/ep-1 returns the endpoint that has an endpoint_id equal to ep-1
  • annotations.owner!=sd AND annotations.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 annotations.<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:

  • annotations.owner returns endpoints that have a annotation with the key owner, this is the same as annotations:owner

  • annotations.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 * name=projects/my-project/locations/us-central1/namespaces/my-namespace/services/my-service/endpoints/ep-1 returns the endpoint that has an endpoint_id equal to ep-1
  • annotations.owner!=sd AND annotations.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()

public String 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
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<ResolveServiceRequest> getParserForType()
Returns
Type Description
Parser<ResolveServiceRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ResolveServiceRequest.Builder newBuilderForType()
Returns
Type Description
ResolveServiceRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ResolveServiceRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ResolveServiceRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ResolveServiceRequest.Builder toBuilder()
Returns
Type Description
ResolveServiceRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException