public final class Service extends GeneratedMessageV3 implements ServiceOrBuilder
An individual service. A service contains a name and optional metadata.
A service must exist before
endpoints can be
added to it.
Protobuf type google.cloud.servicedirectory.v1beta1.Service
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENDPOINTS_FIELD_NUMBER
public static final int ENDPOINTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int METADATA_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Service getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Service.Builder newBuilder()
newBuilder(Service prototype)
public static Service.Builder newBuilder(Service prototype)
| Parameter |
|---|
| Name | Description |
prototype | Service
|
public static Service parseDelimitedFrom(InputStream input)
public static Service parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Service parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Service parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(CodedInputStream input)
public static Service parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(InputStream input)
public static Service parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Service parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Service> parser()
Methods
public boolean containsMetadata(String key)
Optional. Metadata for the service. This data can be consumed by service
clients.
Restrictions:
- The entire metadata dictionary may contain up to 2000 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
- The
(.)google.com/ and (.)googleapis.com/ prefixes are reserved
for system metadata managed by Service Directory. If the user tries
to write to these keyspaces, those entries are silently ignored by
the system
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 = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. The timestamp when the service was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when the service was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Service getDefaultInstanceForType()
getEndpoints(int index)
public Endpoint getEndpoints(int index)
Output only. Endpoints associated with this service. Returned on
LookupService.ResolveService. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
|
getEndpointsCount()
public int getEndpointsCount()
Output only. Endpoints associated with this service. Returned on
LookupService.ResolveService. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | |
getEndpointsList()
public List<Endpoint> getEndpointsList()
Output only. Endpoints associated with this service. Returned on
LookupService.ResolveService. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEndpointsOrBuilder(int index)
public EndpointOrBuilder getEndpointsOrBuilder(int index)
Output only. Endpoints associated with this service. Returned on
LookupService.ResolveService. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
|
getEndpointsOrBuilderList()
public List<? extends EndpointOrBuilder> getEndpointsOrBuilderList()
Output only. Endpoints associated with this service. Returned on
LookupService.ResolveService. Control plane clients should use
RegistrationService.ListEndpoints.
repeated .google.cloud.servicedirectory.v1beta1.Endpoint endpoints = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.servicedirectory.v1beta1.EndpointOrBuilder> | |
public Map<String,String> getMetadata()
public int getMetadataCount()
Optional. Metadata for the service. This data can be consumed by service
clients.
Restrictions:
- The entire metadata dictionary may contain up to 2000 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
- The
(.)google.com/ and (.)googleapis.com/ prefixes are reserved
for system metadata managed by Service Directory. If the user tries
to write to these keyspaces, those entries are silently ignored by
the system
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 = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | |
public Map<String,String> getMetadataMap()
Optional. Metadata for the service. This data can be consumed by service
clients.
Restrictions:
- The entire metadata dictionary may contain up to 2000 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
- The
(.)google.com/ and (.)googleapis.com/ prefixes are reserved
for system metadata managed by Service Directory. If the user tries
to write to these keyspaces, those entries are silently ignored by
the system
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 = 2 [(.google.api.field_behavior) = OPTIONAL];
public String getMetadataOrDefault(String key, String defaultValue)
Optional. Metadata for the service. This data can be consumed by service
clients.
Restrictions:
- The entire metadata dictionary may contain up to 2000 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
- The
(.)google.com/ and (.)googleapis.com/ prefixes are reserved
for system metadata managed by Service Directory. If the user tries
to write to these keyspaces, those entries are silently ignored by
the system
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 = 2 [(.google.api.field_behavior) = OPTIONAL];
public String getMetadataOrThrow(String key)
Optional. Metadata for the service. This data can be consumed by service
clients.
Restrictions:
- The entire metadata dictionary may contain up to 2000 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
- The
(.)google.com/ and (.)googleapis.com/ prefixes are reserved
for system metadata managed by Service Directory. If the user tries
to write to these keyspaces, those entries are silently ignored by
the system
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 = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | String
|
getName()
Immutable. The resource name for the service in the format
projects/*/locations/*/namespaces/*/services/*.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Immutable. The resource name for the service in the format
projects/*/locations/*/namespaces/*/services/*.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Service> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The timestamp when the service was last updated. Note: endpoints being
created/deleted/updated within the service are not considered service
updates for the purpose of this timestamp.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
