Reference documentation and code samples for the Google Cloud Service Directory V1beta1 Client class Service.
An individual service. A service contains a name and optional metadata.
A service must exist before endpoints can be added to it.
Generated from protobuf message google.cloud.servicedirectory.v1beta1.Service
Namespace
Google \ Cloud \ ServiceDirectory \ V1beta1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Immutable. The resource name for the service in the format projects/*/locations/*/namespaces/*/services/*
.
↳ metadata
array| Google\Protobuf\Internal\MapField
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.
↳ endpoints
array< Google\Cloud\ServiceDirectory\V1beta1\Endpoint
>
Output only. Endpoints associated with this service. Returned on LookupService.ResolveService . Control plane clients should use RegistrationService.ListEndpoints .
↳ create_time
↳ update_time
Google\Protobuf\Timestamp
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.
getName
Immutable. The resource name for the service in the format projects/*/locations/*/namespaces/*/services/*
.
string
setName
Immutable. The resource name for the service in the format projects/*/locations/*/namespaces/*/services/*
.
var
string
$this
getMetadata
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 theannotationsfield in the v1 API. They have the same syntax and read/write to the same location in Service Directory.
setMetadata
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 theannotationsfield in the v1 API. They have the same syntax and read/write to the same location in Service Directory.
$this
getEndpoints
Output only. Endpoints associated with this service. Returned on LookupService.ResolveService . Control plane clients should use RegistrationService.ListEndpoints .
setEndpoints
Output only. Endpoints associated with this service. Returned on LookupService.ResolveService . Control plane clients should use RegistrationService.ListEndpoints .
$this
getCreateTime
Output only. The timestamp when the service was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when the service was created.
$this
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.
hasUpdateTime
clearUpdateTime
setUpdateTime
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.
$this
