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
ENDPOINTS_FIELD_NUMBER
public static final int ENDPOINTS_FIELD_NUMBER
Field Value
public static final int METADATA_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Service getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Service.Builder newBuilder()
Returns
newBuilder(Service prototype)
public static Service.Builder newBuilder(Service prototype)
Parameter
Returns
public static Service parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Service parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Service parseFrom(byte[] data)
Parameter
| Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Service parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Service parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Service parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Service parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Service parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Service parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Service> parser()
Returns
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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];
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()
Returns
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];
| Name |
Description |
index |
int
|
Returns
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];
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];
| Name |
Description |
index |
int
|
Returns
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];
| Type |
Description |
List<? extends com.google.cloud.servicedirectory.v1beta1.EndpointOrBuilder> |
|
public Map<String,String> getMetadata()
Returns
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];
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];
getName()
Immutable. The resource name for the service in the format
projects/*/locations/*/namespaces/*/services/*.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| 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];
getParserForType()
public Parser<Service> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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];
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
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];
hasCreateTime()
public boolean hasCreateTime()
Output only. The timestamp when the service was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
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];
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
| Name |
Description |
number |
int
|
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Service.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Service.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Service.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
