Class Endpoint.Builder

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

Implements

EndpointOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Endpoint.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Endpoint.Builder
Overrides

build()

public Endpoint build()
Returns
TypeDescription
Endpoint

buildPartial()

public Endpoint buildPartial()
Returns
TypeDescription
Endpoint

clear()

public Endpoint.Builder clear()
Returns
TypeDescription
Endpoint.Builder
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];

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

clearAnnotations()

public Endpoint.Builder clearAnnotations()
Returns
TypeDescription
Endpoint.Builder

clearField(Descriptors.FieldDescriptor field)

public Endpoint.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Endpoint.Builder
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];

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Endpoint.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Endpoint.Builder
Overrides

clearPort()

public Endpoint.Builder clearPort()

Optional. Service Directory will reject values outside of [0, 65535].

int32 port = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

clone()

public Endpoint.Builder clone()
Returns
TypeDescription
Endpoint.Builder
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];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

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

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

Returns
TypeDescription
ByteString

The bytes for address.

getAnnotations()

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
Map<String,String>

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

Returns
TypeDescription
int

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

Returns
TypeDescription
Map<String,String>

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

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

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

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getDefaultInstanceForType()

public Endpoint getDefaultInstanceForType()
Returns
TypeDescription
Endpoint

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMutableAnnotations()

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

Immutable. The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

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

Returns
TypeDescription
ByteString

The bytes for name.

getPort()

public int getPort()

Optional. Service Directory will reject values outside of [0, 65535].

int32 port = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The port.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Endpoint other)

public Endpoint.Builder mergeFrom(Endpoint other)
Parameter
NameDescription
otherEndpoint
Returns
TypeDescription
Endpoint.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Endpoint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Endpoint.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Endpoint.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Endpoint.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Endpoint.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Endpoint.Builder
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];

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Endpoint.Builder

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

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Endpoint.Builder

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Endpoint.Builder

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

Parameter
NameDescription
valueString

The address to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

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

Parameter
NameDescription
valueByteString

The bytes for address to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Endpoint.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Endpoint.Builder
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];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

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

Parameter
NameDescription
valueint

The port to set.

Returns
TypeDescription
Endpoint.Builder

This builder for chaining.

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

public Endpoint.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Endpoint.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Endpoint.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Endpoint.Builder
Overrides