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.v1beta1.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. |
clearCreateTime()
public Endpoint.Builder clearCreateTime()
Output only. The timestamp when the endpoint was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
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 |
clearMetadata()
public Endpoint.Builder clearMetadata()
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, but no other validation is performed on this field (ex. network or project existence, reachability, or permissions).
string network = 5 [(.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. A globally unique identifier (in UUID4 format) for this endpoint.
string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Endpoint.Builder | This builder for chaining. |
clearUpdateTime()
public Endpoint.Builder clearUpdateTime()
Output only. The timestamp when the endpoint was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
clone()
public Endpoint.Builder clone()
Returns | |
---|---|
Type | Description |
Endpoint.Builder |
containsMetadata(String key)
public boolean containsMetadata(String key)
Optional. Metadata for the endpoint. This data can be consumed by service clients.
Restrictions:
- The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected
Valid metadata 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 (/). Metadata that fails to meet these requirements are rejected
Note: This field is equivalent to the
annotations
field in the v1 API. They have the same syntax and read/write to the same location in Service Directory.
map<string, string> metadata = 4 [(.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. |
getCreateTime()
public Timestamp getCreateTime()
Output only. The timestamp when the endpoint was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp | The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Output only. The timestamp when the endpoint was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when the endpoint was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public Endpoint getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Endpoint |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getMetadata()
public Map<String,String> getMetadata()
Use #getMetadataMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getMetadataCount()
public int getMetadataCount()
Optional. Metadata for the endpoint. This data can be consumed by service clients.
Restrictions:
- The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected
Valid metadata 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 (/). Metadata that fails to meet these requirements are rejected
Note: This field is equivalent to the
annotations
field in the v1 API. They have the same syntax and read/write to the same location in Service Directory.
map<string, string> metadata = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getMetadataMap()
public Map<String,String> getMetadataMap()
Optional. Metadata for the endpoint. This data can be consumed by service clients.
Restrictions:
- The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected
Valid metadata 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 (/). Metadata that fails to meet these requirements are rejected
Note: This field is equivalent to the
annotations
field in the v1 API. They have the same syntax and read/write to the same location in Service Directory.
map<string, string> metadata = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Map<String,String> |
getMetadataOrDefault(String key, String defaultValue)
public String getMetadataOrDefault(String key, String defaultValue)
Optional. Metadata for the endpoint. This data can be consumed by service clients.
Restrictions:
- The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected
Valid metadata 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 (/). Metadata that fails to meet these requirements are rejected
Note: This field is equivalent to the
annotations
field in the v1 API. They have the same syntax and read/write to the same location in Service Directory.
map<string, string> metadata = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
key | String |
defaultValue | String |
Returns | |
---|---|
Type | Description |
String |
getMetadataOrThrow(String key)
public String getMetadataOrThrow(String key)
Optional. Metadata for the endpoint. This data can be consumed by service clients.
Restrictions:
- The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected
Valid metadata 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 (/). Metadata that fails to meet these requirements are rejected
Note: This field is equivalent to the
annotations
field in the v1 API. They have the same syntax and read/write to the same location in Service Directory.
map<string, string> metadata = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
String |
getMutableMetadata()
public Map<String,String> getMutableMetadata()
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, but no other validation is performed on this field (ex. network or project existence, reachability, or permissions).
string network = 5 [(.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, but no other validation is performed on this field (ex. network or project existence, reachability, or permissions).
string network = 5 [(.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. A globally unique identifier (in UUID4 format) for this endpoint.
string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String | The uid. |
getUidBytes()
public ByteString getUidBytes()
Output only. A globally unique identifier (in UUID4 format) for this endpoint.
string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for uid. |
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The timestamp when the endpoint was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp | The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()
Output only. The timestamp when the endpoint was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The timestamp when the endpoint was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
hasCreateTime()
public boolean hasCreateTime()
Output only. The timestamp when the endpoint was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean | Whether the createTime field is set. |
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The timestamp when the endpoint was last updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |