public final class Endpoint extends GeneratedMessageV3 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 Fields
ADDRESS_FIELD_NUMBER
public static final int ADDRESS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PORT_FIELD_NUMBER
public static final int PORT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Endpoint getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Endpoint.Builder newBuilder()
newBuilder(Endpoint prototype)
public static Endpoint.Builder newBuilder(Endpoint prototype)
| Parameter |
|---|
| Name | Description |
prototype | Endpoint
|
public static Endpoint parseDelimitedFrom(InputStream input)
public static Endpoint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Endpoint parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Endpoint parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(CodedInputStream input)
public static Endpoint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(InputStream input)
public static Endpoint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Endpoint parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Endpoint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Endpoint> parser()
Methods
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 |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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 |
|---|
| 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for address.
|
getAnnotations()
public Map<String,String> getAnnotations()
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 |
|---|
| Type | Description |
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];
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];
| Parameter |
|---|
| Name | Description |
key | String
|
getDefaultInstanceForType()
public Endpoint getDefaultInstanceForType()
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 |
|---|
| 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Endpoint> getParserForType()
Overrides
getPort()
Optional. Service Directory will reject values outside of [0, 65535].
int32 port = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | The port.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Endpoint.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Endpoint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Endpoint.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
