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.v1beta1.ResolveServiceRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ResolveServiceRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public ResolveServiceRequest build()
buildPartial()
public ResolveServiceRequest buildPartial()
clear()
public ResolveServiceRequest.Builder clear()
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 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:ownermetadata.protocol=gRPC returns endpoints that have key/value
protocol=gRPCaddress=192.108.1.105 returns endpoints that have this addressport>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 notmetadata.owner!=sd AND metadata.foo=bar returns endpoints that have
owner in annotation key but value is not sd AND have key/value
foo=bardoesnotexist.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];
clearField(Descriptors.FieldDescriptor field)
public ResolveServiceRequest.Builder clearField(Descriptors.FieldDescriptor field)
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];
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) = { ... }
clearOneof(Descriptors.OneofDescriptor oneof)
public ResolveServiceRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clone()
public ResolveServiceRequest.Builder clone()
Overrides
getDefaultInstanceForType()
public ResolveServiceRequest getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
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 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:ownermetadata.protocol=gRPC returns endpoints that have key/value
protocol=gRPCaddress=192.108.1.105 returns endpoints that have this addressport>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 notmetadata.owner!=sd AND metadata.foo=bar returns endpoints that have
owner in annotation key but value is not sd AND have key/value
foo=bardoesnotexist.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:ownermetadata.protocol=gRPC returns endpoints that have key/value
protocol=gRPCaddress=192.108.1.105 returns endpoints that have this addressport>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 notmetadata.owner!=sd AND metadata.foo=bar returns endpoints that have
owner in annotation key but value is not sd AND have key/value
foo=bardoesnotexist.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 |
|---|
| Type | Description |
ByteString | The bytes for name.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(ResolveServiceRequest other)
public ResolveServiceRequest.Builder mergeFrom(ResolveServiceRequest other)
public ResolveServiceRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public ResolveServiceRequest.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ResolveServiceRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
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 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:ownermetadata.protocol=gRPC returns endpoints that have key/value
protocol=gRPCaddress=192.108.1.105 returns endpoints that have this addressport>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 notmetadata.owner!=sd AND metadata.foo=bar returns endpoints that have
owner in annotation key but value is not sd AND have key/value
foo=bardoesnotexist.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.
|
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 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:ownermetadata.protocol=gRPC returns endpoints that have key/value
protocol=gRPCaddress=192.108.1.105 returns endpoints that have this addressport>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 notmetadata.owner!=sd AND metadata.foo=bar returns endpoints that have
owner in annotation key but value is not sd AND have key/value
foo=bardoesnotexist.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.
|
setField(Descriptors.FieldDescriptor field, Object value)
public ResolveServiceRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
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.
|
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.
|
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.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ResolveServiceRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final ResolveServiceRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
