public static final class Service.Builder extends GeneratedMessageV3.Builder<Service.Builder> implements ServiceOrBuilder
An individual service. A service contains a name and optional metadata.
A service must exist before
endpoints can be
added to it.
Protobuf type google.cloud.servicedirectory.v1.Service
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()
Returns
Methods
addAllEndpoints(Iterable<? extends Endpoint> values)
public Service.Builder addAllEndpoints(Iterable<? extends Endpoint> values)
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
values | Iterable<? extends com.google.cloud.servicedirectory.v1.Endpoint>
|
Returns
addEndpoints(Endpoint value)
public Service.Builder addEndpoints(Endpoint value)
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
addEndpoints(Endpoint.Builder builderForValue)
public Service.Builder addEndpoints(Endpoint.Builder builderForValue)
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
addEndpoints(int index, Endpoint value)
public Service.Builder addEndpoints(int index, Endpoint value)
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
addEndpoints(int index, Endpoint.Builder builderForValue)
public Service.Builder addEndpoints(int index, Endpoint.Builder builderForValue)
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
addEndpointsBuilder()
public Endpoint.Builder addEndpointsBuilder()
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
addEndpointsBuilder(int index)
public Endpoint.Builder addEndpointsBuilder(int index)
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Service.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
Returns
buildPartial()
public Service buildPartial()
Returns
clear()
public Service.Builder clear()
Returns
Overrides
clearAnnotations()
public Service.Builder clearAnnotations()
Returns
clearEndpoints()
public Service.Builder clearEndpoints()
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
clearField(Descriptors.FieldDescriptor field)
public Service.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearName()
public Service.Builder clearName()
Immutable. The resource name for the service in the format
projects/*/locations/*/namespaces/*/services/*.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
clearOneof(Descriptors.OneofDescriptor oneof)
public Service.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public Service.Builder clone()
Returns
Overrides
containsAnnotations(String key)
public boolean containsAnnotations(String key)
Optional. Annotations for the service. This data can be consumed by service
clients.
Restrictions:
- The entire annotations dictionary may contain up to 2000 characters,
spread accoss all key-value pairs. Annotations that goes beyond any
these limits will be rejected.
- Valid annotation keys have two segments: an optional prefix and name,
separated by a slash (/). The name segment is required and must be 63
characters or less, beginning and ending with an alphanumeric character
([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and
alphanumerics between. The prefix is optional. If specified, the prefix
must be a DNS subdomain: a series of DNS labels separated by dots (.),
not longer than 253 characters in total, followed by a slash (/).
Annotations that fails to meet these requirements will be rejected.
- The '(.)google.com/' and '(.)googleapis.com/' prefixes are reserved
for system annotations managed by Service Directory. If the user tries
to write to these keyspaces, those entries will be silently ignored by
the system.
Note: This field is equivalent to the 'metadata' field in the v1beta1 API.
They have the same syntax and read/write to the same location in Service
Directory.
map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];
getAnnotations()
public Map<String,String> getAnnotations()
Returns
getAnnotationsCount()
public int getAnnotationsCount()
Optional. Annotations for the service. This data can be consumed by service
clients.
Restrictions:
- The entire annotations dictionary may contain up to 2000 characters,
spread accoss all key-value pairs. Annotations that goes beyond any
these limits will be rejected.
- Valid annotation keys have two segments: an optional prefix and name,
separated by a slash (/). The name segment is required and must be 63
characters or less, beginning and ending with an alphanumeric character
([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and
alphanumerics between. The prefix is optional. If specified, the prefix
must be a DNS subdomain: a series of DNS labels separated by dots (.),
not longer than 253 characters in total, followed by a slash (/).
Annotations that fails to meet these requirements will be rejected.
- The '(.)google.com/' and '(.)googleapis.com/' prefixes are reserved
for system annotations managed by Service Directory. If the user tries
to write to these keyspaces, those entries will be silently ignored by
the system.
Note: This field is equivalent to the 'metadata' field in the v1beta1 API.
They have the same syntax and read/write to the same location in Service
Directory.
map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];
getAnnotationsMap()
public Map<String,String> getAnnotationsMap()
Optional. Annotations for the service. This data can be consumed by service
clients.
Restrictions:
- The entire annotations dictionary may contain up to 2000 characters,
spread accoss all key-value pairs. Annotations that goes beyond any
these limits will be rejected.
- Valid annotation keys have two segments: an optional prefix and name,
separated by a slash (/). The name segment is required and must be 63
characters or less, beginning and ending with an alphanumeric character
([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and
alphanumerics between. The prefix is optional. If specified, the prefix
must be a DNS subdomain: a series of DNS labels separated by dots (.),
not longer than 253 characters in total, followed by a slash (/).
Annotations that fails to meet these requirements will be rejected.
- The '(.)google.com/' and '(.)googleapis.com/' prefixes are reserved
for system annotations managed by Service Directory. If the user tries
to write to these keyspaces, those entries will be silently ignored by
the system.
Note: This field is equivalent to the 'metadata' field in the v1beta1 API.
They have the same syntax and read/write to the same location in Service
Directory.
map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];
getAnnotationsOrDefault(String key, String defaultValue)
public String getAnnotationsOrDefault(String key, String defaultValue)
Optional. Annotations for the service. This data can be consumed by service
clients.
Restrictions:
- The entire annotations dictionary may contain up to 2000 characters,
spread accoss all key-value pairs. Annotations that goes beyond any
these limits will be rejected.
- Valid annotation keys have two segments: an optional prefix and name,
separated by a slash (/). The name segment is required and must be 63
characters or less, beginning and ending with an alphanumeric character
([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and
alphanumerics between. The prefix is optional. If specified, the prefix
must be a DNS subdomain: a series of DNS labels separated by dots (.),
not longer than 253 characters in total, followed by a slash (/).
Annotations that fails to meet these requirements will be rejected.
- The '(.)google.com/' and '(.)googleapis.com/' prefixes are reserved
for system annotations managed by Service Directory. If the user tries
to write to these keyspaces, those entries will be silently ignored by
the system.
Note: This field is equivalent to the 'metadata' field in the v1beta1 API.
They have the same syntax and read/write to the same location in Service
Directory.
map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];
getAnnotationsOrThrow(String key)
public String getAnnotationsOrThrow(String key)
Optional. Annotations for the service. This data can be consumed by service
clients.
Restrictions:
- The entire annotations dictionary may contain up to 2000 characters,
spread accoss all key-value pairs. Annotations that goes beyond any
these limits will be rejected.
- Valid annotation keys have two segments: an optional prefix and name,
separated by a slash (/). The name segment is required and must be 63
characters or less, beginning and ending with an alphanumeric character
([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and
alphanumerics between. The prefix is optional. If specified, the prefix
must be a DNS subdomain: a series of DNS labels separated by dots (.),
not longer than 253 characters in total, followed by a slash (/).
Annotations that fails to meet these requirements will be rejected.
- The '(.)google.com/' and '(.)googleapis.com/' prefixes are reserved
for system annotations managed by Service Directory. If the user tries
to write to these keyspaces, those entries will be silently ignored by
the system.
Note: This field is equivalent to the 'metadata' field in the v1beta1 API.
They have the same syntax and read/write to the same location in Service
Directory.
map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public Service getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getEndpoints(int index)
public Endpoint getEndpoints(int index)
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEndpointsBuilder(int index)
public Endpoint.Builder getEndpointsBuilder(int index)
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEndpointsBuilderList()
public List<Endpoint.Builder> getEndpointsBuilderList()
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEndpointsCount()
public int getEndpointsCount()
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEndpointsList()
public List<Endpoint> getEndpointsList()
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEndpointsOrBuilder(int index)
public EndpointOrBuilder getEndpointsOrBuilder(int index)
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEndpointsOrBuilderList()
public List<? extends EndpointOrBuilder> getEndpointsOrBuilderList()
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
List<? extends com.google.cloud.servicedirectory.v1.EndpointOrBuilder> | |
getMutableAnnotations()
public Map<String,String> getMutableAnnotations()
Use alternate mutation accessors instead.
getName()
Immutable. The resource name for the service in the format
projects/*/locations/*/namespaces/*/services/*.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Immutable. The resource name for the service in the format
projects/*/locations/*/namespaces/*/services/*.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(Service other)
public Service.Builder mergeFrom(Service other)
Parameter
Returns
public Service.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Service.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Service.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
putAllAnnotations(Map<String,String> values)
public Service.Builder putAllAnnotations(Map<String,String> values)
Optional. Annotations for the service. This data can be consumed by service
clients.
Restrictions:
- The entire annotations dictionary may contain up to 2000 characters,
spread accoss all key-value pairs. Annotations that goes beyond any
these limits will be rejected.
- Valid annotation keys have two segments: an optional prefix and name,
separated by a slash (/). The name segment is required and must be 63
characters or less, beginning and ending with an alphanumeric character
([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and
alphanumerics between. The prefix is optional. If specified, the prefix
must be a DNS subdomain: a series of DNS labels separated by dots (.),
not longer than 253 characters in total, followed by a slash (/).
Annotations that fails to meet these requirements will be rejected.
- The '(.)google.com/' and '(.)googleapis.com/' prefixes are reserved
for system annotations managed by Service Directory. If the user tries
to write to these keyspaces, those entries will be silently ignored by
the system.
Note: This field is equivalent to the 'metadata' field in the v1beta1 API.
They have the same syntax and read/write to the same location in Service
Directory.
map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];
putAnnotations(String key, String value)
public Service.Builder putAnnotations(String key, String value)
Optional. Annotations for the service. This data can be consumed by service
clients.
Restrictions:
- The entire annotations dictionary may contain up to 2000 characters,
spread accoss all key-value pairs. Annotations that goes beyond any
these limits will be rejected.
- Valid annotation keys have two segments: an optional prefix and name,
separated by a slash (/). The name segment is required and must be 63
characters or less, beginning and ending with an alphanumeric character
([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and
alphanumerics between. The prefix is optional. If specified, the prefix
must be a DNS subdomain: a series of DNS labels separated by dots (.),
not longer than 253 characters in total, followed by a slash (/).
Annotations that fails to meet these requirements will be rejected.
- The '(.)google.com/' and '(.)googleapis.com/' prefixes are reserved
for system annotations managed by Service Directory. If the user tries
to write to these keyspaces, those entries will be silently ignored by
the system.
Note: This field is equivalent to the 'metadata' field in the v1beta1 API.
They have the same syntax and read/write to the same location in Service
Directory.
map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];
removeAnnotations(String key)
public Service.Builder removeAnnotations(String key)
Optional. Annotations for the service. This data can be consumed by service
clients.
Restrictions:
- The entire annotations dictionary may contain up to 2000 characters,
spread accoss all key-value pairs. Annotations that goes beyond any
these limits will be rejected.
- Valid annotation keys have two segments: an optional prefix and name,
separated by a slash (/). The name segment is required and must be 63
characters or less, beginning and ending with an alphanumeric character
([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and
alphanumerics between. The prefix is optional. If specified, the prefix
must be a DNS subdomain: a series of DNS labels separated by dots (.),
not longer than 253 characters in total, followed by a slash (/).
Annotations that fails to meet these requirements will be rejected.
- The '(.)google.com/' and '(.)googleapis.com/' prefixes are reserved
for system annotations managed by Service Directory. If the user tries
to write to these keyspaces, those entries will be silently ignored by
the system.
Note: This field is equivalent to the 'metadata' field in the v1beta1 API.
They have the same syntax and read/write to the same location in Service
Directory.
map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];
removeEndpoints(int index)
public Service.Builder removeEndpoints(int index)
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
setEndpoints(int index, Endpoint value)
public Service.Builder setEndpoints(int index, Endpoint value)
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
setEndpoints(int index, Endpoint.Builder builderForValue)
public Service.Builder setEndpoints(int index, Endpoint.Builder builderForValue)
Output only. Endpoints associated with this service. Returned on
LookupService.Resolve. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
setField(Descriptors.FieldDescriptor field, Object value)
public Service.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setName(String value)
public Service.Builder setName(String value)
Immutable. The resource name for the service in the format
projects/*/locations/*/namespaces/*/services/*.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Name | Description |
value | String
The name to set.
|
Returns
setNameBytes(ByteString value)
public Service.Builder setNameBytes(ByteString value)
Immutable. The resource name for the service in the format
projects/*/locations/*/namespaces/*/services/*.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Name | Description |
value | ByteString
The bytes for name to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Service.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Service.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
