Google API Common Protos Client - Class Resource (4.8.1)

Reference documentation and code samples for the Google API Common Protos Client class Resource.

This message defines core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a file stored on a network storage service.

Generated from protobuf message google.rpc.context.AttributeContext.Resource

Namespace

Google \ Rpc \ Context \ AttributeContext

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ service`	`string` The name of the service that this resource belongs to, such as `pubsub.googleapis.com`. The service may be different from the DNS hostname that actually serves the request.
`↳ name`	`string` The stable identifier (name) of a resource on the `service`. A resource can be logically identified as "//{resource.service}/{resource.name}". The differences between a resource name and a URI are: * Resource name is a logical identifier, independent of network protocol and API version. For example, `//pubsub.googleapis.com/projects/123/topics/news-feed`. * URI often includes protocol and version information, so it can be used directly by applications. For example, `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`. See https://cloud.google.com/apis/design/resource_names for details.
`↳ type`	`string` The type of the resource. The syntax is platform-specific because different platforms define their resources differently. For Google APIs, the type format must be "{service}/{kind}", such as "pubsub.googleapis.com/Topic".
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.
`↳ uid`	`string` The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
`↳ annotations`	`array\|Google\Protobuf\Internal\MapField` Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
`↳ display_name`	`string` Mutable. The display name set by clients. Must be <= 63 characters.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The timestamp when the resource was created. This may be either the time creation was initiated or when it was completed.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
`↳ delete_time`	`Google\Protobuf\Timestamp` Output only. The timestamp when the resource was deleted. If the resource is not deleted, this must be empty.
`↳ etag`	`string` Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
`↳ location`	`string` Immutable. The location of the resource. The location encoding is specific to the service provider, and new encoding may be introduced as the service evolves. For Google Cloud products, the encoding is what is used by Google Cloud APIs, such as `us-east1`, `aws-us-east-1`, and `azure-eastus2`. The semantics of `location` is identical to the `cloud.googleapis.com/location` label used by some Google Cloud APIs.

getService

The name of the service that this resource belongs to, such as pubsub.googleapis.com. The service may be different from the DNS hostname that actually serves the request.

Returns
Type	Description
`string`

setService

The name of the service that this resource belongs to, such as pubsub.googleapis.com. The service may be different from the DNS hostname that actually serves the request.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getName

The stable identifier (name) of a resource on the service. A resource can be logically identified as "//{resource.service}/{resource.name}".

The differences between a resource name and a URI are:

Resource name is a logical identifier, independent of network protocol and API version. For example, //pubsub.googleapis.com/projects/123/topics/news-feed.
URI often includes protocol and version information, so it can be used directly by applications. For example, https://pubsub.googleapis.com/v1/projects/123/topics/news-feed. See https://cloud.google.com/apis/design/resource_names for details.

Returns
Type	Description
`string`

setName

The stable identifier (name) of a resource on the service. A resource can be logically identified as "//{resource.service}/{resource.name}".

The differences between a resource name and a URI are:

Resource name is a logical identifier, independent of network protocol and API version. For example, //pubsub.googleapis.com/projects/123/topics/news-feed.
URI often includes protocol and version information, so it can be used directly by applications. For example, https://pubsub.googleapis.com/v1/projects/123/topics/news-feed. See https://cloud.google.com/apis/design/resource_names for details.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getType

The type of the resource. The syntax is platform-specific because different platforms define their resources differently.

For Google APIs, the type format must be "{service}/{kind}", such as "pubsub.googleapis.com/Topic".

Returns
Type	Description
`string`

setType

The type of the resource. The syntax is platform-specific because different platforms define their resources differently.

For Google APIs, the type format must be "{service}/{kind}", such as "pubsub.googleapis.com/Topic".

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLabels

The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getUid

The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

Returns
Type	Description
`string`

setUid

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAnnotations

Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.

They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setAnnotations

Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.

They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getDisplayName

Mutable. The display name set by clients. Must be <= 63 characters.

Returns
Type	Description
`string`

setDisplayName

Mutable. The display name set by clients. Must be <= 63 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. The timestamp when the resource was created. This may be either the time creation was initiated or when it was completed.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when the resource was created. This may be either the time creation was initiated or when it was completed.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value.

Changes to a resource made by the service should refresh this value.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value.

Changes to a resource made by the service should refresh this value.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getDeleteTime

Output only. The timestamp when the resource was deleted.

If the resource is not deleted, this must be empty.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. The timestamp when the resource was deleted.

If the resource is not deleted, this must be empty.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getEtag

Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

Returns
Type	Description
`string`

setEtag

Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLocation

Immutable. The location of the resource. The location encoding is specific to the service provider, and new encoding may be introduced as the service evolves.

For Google Cloud products, the encoding is what is used by Google Cloud APIs, such as us-east1, aws-us-east-1, and azure-eastus2. The semantics of location is identical to the cloud.googleapis.com/location label used by some Google Cloud APIs.

Returns
Type	Description
`string`

setLocation

Immutable. The location of the resource. The location encoding is specific to the service provider, and new encoding may be introduced as the service evolves.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`