public static final class Endpoint.Builder extends GeneratedMessageV3.Builder<Endpoint.Builder> implements EndpointOrBuilder
An individual endpoint that provides a
service. The service must
already exist to create an endpoint.
Protobuf type google.cloud.servicedirectory.v1.Endpoint
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Endpoint.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
Returns
buildPartial()
public Endpoint buildPartial()
Returns
clear()
public Endpoint.Builder clear()
Returns
Overrides
clearAddress()
public Endpoint.Builder clearAddress()
Optional. An IPv4 or IPv6 address. Service Directory will reject bad
addresses like:
"8.8.8"
"8.8.8.8:53"
"test:bad:address"
"[::1]"
"[::1]:8080"
Limited to 45 characters.
string address = 2 [(.google.api.field_behavior) = OPTIONAL];
clearAnnotations()
public Endpoint.Builder clearAnnotations()
Returns
clearField(Descriptors.FieldDescriptor field)
public Endpoint.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearName()
public Endpoint.Builder clearName()
Immutable. The resource name for the endpoint in the format
projects/*/locations/*/namespaces/*/services/*/endpoints/*.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
clearOneof(Descriptors.OneofDescriptor oneof)
public Endpoint.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearPort()
public Endpoint.Builder clearPort()
Optional. Service Directory will reject values outside of [0, 65535].
int32 port = 3 [(.google.api.field_behavior) = OPTIONAL];
clone()
public Endpoint.Builder clone()
Returns
Overrides
containsAnnotations(String key)
public boolean containsAnnotations(String key)
Optional. Annotations for the endpoint. This data can be consumed by
service clients. Restrictions:
- The entire annotations dictionary may contain up to 512 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
getAddress()
public String getAddress()
Optional. An IPv4 or IPv6 address. Service Directory will reject bad
addresses like:
"8.8.8"
"8.8.8.8:53"
"test:bad:address"
"[::1]"
"[::1]:8080"
Limited to 45 characters.
string address = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The address.
|
getAddressBytes()
public ByteString getAddressBytes()
Optional. An IPv4 or IPv6 address. Service Directory will reject bad
addresses like:
"8.8.8"
"8.8.8.8:53"
"test:bad:address"
"[::1]"
"[::1]:8080"
Limited to 45 characters.
string address = 2 [(.google.api.field_behavior) = OPTIONAL];
getAnnotations()
public Map<String,String> getAnnotations()
Returns
getAnnotationsCount()
public int getAnnotationsCount()
Optional. Annotations for the endpoint. This data can be consumed by
service clients. Restrictions:
- The entire annotations dictionary may contain up to 512 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
getAnnotationsMap()
public Map<String,String> getAnnotationsMap()
Optional. Annotations for the endpoint. This data can be consumed by
service clients. Restrictions:
- The entire annotations dictionary may contain up to 512 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
getAnnotationsOrDefault(String key, String defaultValue)
public String getAnnotationsOrDefault(String key, String defaultValue)
Optional. Annotations for the endpoint. This data can be consumed by
service clients. Restrictions:
- The entire annotations dictionary may contain up to 512 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
getAnnotationsOrThrow(String key)
public String getAnnotationsOrThrow(String key)
Optional. Annotations for the endpoint. This data can be consumed by
service clients. Restrictions:
- The entire annotations dictionary may contain up to 512 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public Endpoint getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getMutableAnnotations()
public Map<String,String> getMutableAnnotations()
Use alternate mutation accessors instead.
getName()
Immutable. The resource name for the endpoint in the format
projects/*/locations/*/namespaces/*/services/*/endpoints/*.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Immutable. The resource name for the endpoint in the format
projects/*/locations/*/namespaces/*/services/*/endpoints/*.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
getPort()
Optional. Service Directory will reject values outside of [0, 65535].
int32 port = 3 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| int | The port.
|
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(Endpoint other)
public Endpoint.Builder mergeFrom(Endpoint other)
Parameter
Returns
public Endpoint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Endpoint.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Endpoint.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
putAllAnnotations(Map<String,String> values)
public Endpoint.Builder putAllAnnotations(Map<String,String> values)
Optional. Annotations for the endpoint. This data can be consumed by
service clients. Restrictions:
- The entire annotations dictionary may contain up to 512 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
putAnnotations(String key, String value)
public Endpoint.Builder putAnnotations(String key, String value)
Optional. Annotations for the endpoint. This data can be consumed by
service clients. Restrictions:
- The entire annotations dictionary may contain up to 512 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
removeAnnotations(String key)
public Endpoint.Builder removeAnnotations(String key)
Optional. Annotations for the endpoint. This data can be consumed by
service clients. Restrictions:
- The entire annotations dictionary may contain up to 512 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 = 5 [(.google.api.field_behavior) = OPTIONAL];
setAddress(String value)
public Endpoint.Builder setAddress(String value)
Optional. An IPv4 or IPv6 address. Service Directory will reject bad
addresses like:
"8.8.8"
"8.8.8.8:53"
"test:bad:address"
"[::1]"
"[::1]:8080"
Limited to 45 characters.
string address = 2 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | String
The address to set.
|
Returns
setAddressBytes(ByteString value)
public Endpoint.Builder setAddressBytes(ByteString value)
Optional. An IPv4 or IPv6 address. Service Directory will reject bad
addresses like:
"8.8.8"
"8.8.8.8:53"
"test:bad:address"
"[::1]"
"[::1]:8080"
Limited to 45 characters.
string address = 2 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | ByteString
The bytes for address to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public Endpoint.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setName(String value)
public Endpoint.Builder setName(String value)
Immutable. The resource name for the endpoint in the format
projects/*/locations/*/namespaces/*/services/*/endpoints/*.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Name | Description |
| value | String
The name to set.
|
Returns
setNameBytes(ByteString value)
public Endpoint.Builder setNameBytes(ByteString value)
Immutable. The resource name for the endpoint in the format
projects/*/locations/*/namespaces/*/services/*/endpoints/*.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Name | Description |
| value | ByteString
The bytes for name to set.
|
Returns
setPort(int value)
public Endpoint.Builder setPort(int value)
Optional. Service Directory will reject values outside of [0, 65535].
int32 port = 3 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | int
The port to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Endpoint.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Endpoint.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
