- 2.54.0 (latest)
- 2.53.0
- 2.52.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.5
- 2.2.7
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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Endpoint.BuilderImplements
EndpointOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Endpoint.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
build()
public Endpoint build()
Returns | |
---|---|
Type | Description |
Endpoint |
buildPartial()
public Endpoint buildPartial()
Returns | |
---|---|
Type | Description |
Endpoint |
clear()
public Endpoint.Builder clear()
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
clearAddress()
public Endpoint.Builder clearAddress()
Optional. An IPv4 or IPv6 address. Service Directory rejects 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 |
Endpoint.Builder | This builder for chaining. |
clearAnnotations()
public Endpoint.Builder clearAnnotations()
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
clearField(Descriptors.FieldDescriptor field)
public Endpoint.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
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 | |
---|---|
Type | Description |
Endpoint.Builder | This builder for chaining. |
clearNetwork()
public Endpoint.Builder clearNetwork()
Immutable. The Google Compute Engine network (VPC) of the endpoint in the
format projects/<project number>/locations/global/networks/*
.
The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.
string network = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
Endpoint.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Endpoint.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
clearPort()
public Endpoint.Builder clearPort()
Optional. Service Directory rejects values outside of [0, 65535]
.
int32 port = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Endpoint.Builder | This builder for chaining. |
clearUid()
public Endpoint.Builder clearUid()
Output only. The globally unique identifier of the endpoint in the UUID4 format.
string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Endpoint.Builder | This builder for chaining. |
clone()
public Endpoint.Builder clone()
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
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 go beyond this limit are 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 are rejected.
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 |
Returns | |
---|---|
Type | Description |
boolean |
getAddress()
public String getAddress()
Optional. An IPv4 or IPv6 address. Service Directory rejects 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 rejects 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() (deprecated)
public Map<String,String> getAnnotations()
Use #getAnnotationsMap() instead.
Returns | |
---|---|
Type | Description |
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 go beyond this limit are 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 are rejected.
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 go beyond this limit are 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 are rejected.
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 |
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 go beyond this limit are 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 are rejected.
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 | |
---|---|
Name | Description |
key | String |
defaultValue | String |
Returns | |
---|---|
Type | Description |
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 go beyond this limit are 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 are rejected.
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 |
Returns | |
---|---|
Type | Description |
String |
getDefaultInstanceForType()
public Endpoint getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Endpoint |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getMutableAnnotations() (deprecated)
public Map<String,String> getMutableAnnotations()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
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 | |
---|---|
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. |
getNetwork()
public String getNetwork()
Immutable. The Google Compute Engine network (VPC) of the endpoint in the
format projects/<project number>/locations/global/networks/*
.
The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.
string network = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String | The network. |
getNetworkBytes()
public ByteString getNetworkBytes()
Immutable. The Google Compute Engine network (VPC) of the endpoint in the
format projects/<project number>/locations/global/networks/*
.
The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.
string network = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for network. |
getPort()
public int getPort()
Optional. Service Directory rejects values outside of [0, 65535]
.
int32 port = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int | The port. |
getUid()
public String getUid()
Output only. The globally unique identifier of the endpoint in the UUID4 format.
string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String | The uid. |
getUidBytes()
public ByteString getUidBytes()
Output only. The globally unique identifier of the endpoint in the UUID4 format.
string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for uid. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(Endpoint other)
public Endpoint.Builder mergeFrom(Endpoint other)
Parameter | |
---|---|
Name | Description |
other | Endpoint |
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Endpoint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Endpoint.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Endpoint.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
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 go beyond this limit are 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 are rejected.
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 |
values | Map<String,String> |
Returns | |
---|---|
Type | Description |
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 go beyond this limit are 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 are rejected.
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 | |
---|---|
Name | Description |
key | String |
value | String |
Returns | |
---|---|
Type | Description |
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 go beyond this limit are 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 are rejected.
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 |
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
setAddress(String value)
public Endpoint.Builder setAddress(String value)
Optional. An IPv4 or IPv6 address. Service Directory rejects 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 | |
---|---|
Name | Description |
value | String The address to set. |
Returns | |
---|---|
Type | Description |
Endpoint.Builder | This builder for chaining. |
setAddressBytes(ByteString value)
public Endpoint.Builder setAddressBytes(ByteString value)
Optional. An IPv4 or IPv6 address. Service Directory rejects 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 | |
---|---|
Name | Description |
value | ByteString The bytes for address to set. |
Returns | |
---|---|
Type | Description |
Endpoint.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Endpoint.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
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 | |
---|---|
Name | Description |
value | String The name to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
Endpoint.Builder | This builder for chaining. |
setNetwork(String value)
public Endpoint.Builder setNetwork(String value)
Immutable. The Google Compute Engine network (VPC) of the endpoint in the
format projects/<project number>/locations/global/networks/*
.
The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.
string network = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value | String The network to set. |
Returns | |
---|---|
Type | Description |
Endpoint.Builder | This builder for chaining. |
setNetworkBytes(ByteString value)
public Endpoint.Builder setNetworkBytes(ByteString value)
Immutable. The Google Compute Engine network (VPC) of the endpoint in the
format projects/<project number>/locations/global/networks/*
.
The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.
string network = 8 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for network to set. |
Returns | |
---|---|
Type | Description |
Endpoint.Builder | This builder for chaining. |
setPort(int value)
public Endpoint.Builder setPort(int value)
Optional. Service Directory rejects values outside of [0, 65535]
.
int32 port = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | int The port to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
setUid(String value)
public Endpoint.Builder setUid(String value)
Output only. The globally unique identifier of the endpoint in the UUID4 format.
string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | String The uid to set. |
Returns | |
---|---|
Type | Description |
Endpoint.Builder | This builder for chaining. |
setUidBytes(ByteString value)
public Endpoint.Builder setUidBytes(ByteString value)
Output only. The globally unique identifier of the endpoint in the UUID4 format.
string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for uid to set. |
Returns | |
---|---|
Type | Description |
Endpoint.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Endpoint.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Endpoint.Builder |