Google Cloud Service Directory V1 Client - Class Service (1.3.5)

Reference documentation and code samples for the Google Cloud Service Directory V1 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.v1.Service

Namespace

Google \ Cloud \ ServiceDirectory \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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/*.

↳ annotations array|Google\Protobuf\Internal\MapField

Optional. Annotations for the service. This data can be consumed by service clients. Restrictions: * The entire annotations dictionary may contain up to 2000 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.

↳ endpoints array<Google\Cloud\ServiceDirectory\V1\Endpoint>

Output only. Endpoints associated with this service. Returned on LookupService.ResolveService. Control plane clients should use RegistrationService.ListEndpoints.

↳ uid string

Output only. The globally unique identifier of the service in the UUID4 format.

getName

Immutable. The resource name for the service in the format projects/*/locations/*/namespaces/*/services/*.

Returns
Type Description
string

setName

Immutable. The resource name for the service in the format projects/*/locations/*/namespaces/*/services/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getAnnotations

Optional. Annotations for the service. This data can be consumed by service clients.

Restrictions:

  • The entire annotations dictionary may contain up to 2000 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.
Returns
Type Description
Google\Protobuf\Internal\MapField

setAnnotations

Optional. Annotations for the service. This data can be consumed by service clients.

Restrictions:

  • The entire annotations dictionary may contain up to 2000 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.
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getEndpoints

Output only. Endpoints associated with this service. Returned on LookupService.ResolveService.

Control plane clients should use RegistrationService.ListEndpoints.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setEndpoints

Output only. Endpoints associated with this service. Returned on LookupService.ResolveService.

Control plane clients should use RegistrationService.ListEndpoints.

Parameter
Name Description
var array<Google\Cloud\ServiceDirectory\V1\Endpoint>
Returns
Type Description
$this

getUid

Output only. The globally unique identifier of the service in the UUID4 format.

Returns
Type Description
string

setUid

Output only. The globally unique identifier of the service in the UUID4 format.

Parameter
Name Description
var string
Returns
Type Description
$this