Class ResolveServiceRequest.Builder (2.54.0) 

public static final class ResolveServiceRequest.Builder extends GeneratedMessageV3.Builder<ResolveServiceRequest.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ResolveServiceRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ResolveServiceRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ResolveServiceRequest.Builder
Overrides

build()

public ResolveServiceRequest build()
Returns
Type Description
ResolveServiceRequest

buildPartial()

public ResolveServiceRequest buildPartial()
Returns
Type Description
ResolveServiceRequest

clear()

public ResolveServiceRequest.Builder clear()
Returns
Type Description
ResolveServiceRequest.Builder
Overrides

clearEndpointFilter()

public ResolveServiceRequest.Builder clearEndpointFilter()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ResolveServiceRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ResolveServiceRequest.Builder
Overrides

clearMaxEndpoints()

public ResolveServiceRequest.Builder clearMaxEndpoints()

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

This builder for chaining.

clearName()

public ResolveServiceRequest.Builder clearName()

Required. The name of the service to resolve.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ResolveServiceRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ResolveServiceRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ResolveServiceRequest.Builder
Overrides

clone()

public ResolveServiceRequest.Builder clone()
Returns
Type Description
ResolveServiceRequest.Builder
Overrides

getDefaultInstanceForType()

public ResolveServiceRequest getDefaultInstanceForType()
Returns
Type Description
ResolveServiceRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ResolveServiceRequest other)

public ResolveServiceRequest.Builder mergeFrom(ResolveServiceRequest other)
Parameter
Name Description
other ResolveServiceRequest
Returns
Type Description
ResolveServiceRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ResolveServiceRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResolveServiceRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ResolveServiceRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ResolveServiceRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ResolveServiceRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ResolveServiceRequest.Builder
Overrides

setEndpointFilter(String value)

public ResolveServiceRequest.Builder setEndpointFilter(String value)

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];

Parameter
Name Description
value String

The endpointFilter to set.
Returns
Type Description
ResolveServiceRequest.Builder

This builder for chaining.

setEndpointFilterBytes(ByteString value)

public ResolveServiceRequest.Builder setEndpointFilterBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for endpointFilter to set.
Returns
Type Description
ResolveServiceRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ResolveServiceRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ResolveServiceRequest.Builder
Overrides

setMaxEndpoints(int value)

public ResolveServiceRequest.Builder setMaxEndpoints(int value)

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];

Parameter
Name Description
value int

The maxEndpoints to set.
Returns
Type Description
ResolveServiceRequest.Builder

This builder for chaining.

setName(String value)

public ResolveServiceRequest.Builder setName(String value)

Required. The name of the service to resolve.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.
Returns
Type Description
ResolveServiceRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ResolveServiceRequest.Builder setNameBytes(ByteString value)

Required. The name of the service to resolve.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
ResolveServiceRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ResolveServiceRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ResolveServiceRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ResolveServiceRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ResolveServiceRequest.Builder
Overrides