Google Cloud Service Directory V1beta1 Client - Class Service (1.3.6)

Version latest

• 1.3.6 (latest)
• 1.3.5
• 1.2.1
• 1.1.2
• 1.0.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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 \ V1beta1

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/*.
↳ 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 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	Google\Protobuf\Timestamp Output only. The timestamp when the service was created.
↳ 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.
↳ uid	string Output only. A globally unique identifier (in UUID4 format) for this service.

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

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 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.

Returns
Type	Description
Google\Protobuf\Internal\MapField

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 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.

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\V1beta1\Endpoint>

Returns
Type	Description
$this

getCreateTime

Output only. The timestamp when the service was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when the service was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$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.

Returns
Type	Description
Google\Protobuf\Timestamp|null

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.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUid

Output only. A globally unique identifier (in UUID4 format) for this service.

Returns
Type	Description
string

setUid

Output only. A globally unique identifier (in UUID4 format) for this service.

Parameter
Name	Description
var	string

Returns
Type	Description
$this