class TagValues extends Resource (View source)

The "tagValues" collection of methods.

Typical usage is:

 $cloudresourcemanagerService = new Google\Service\CloudResourceManager(...);
 $tagValues = $cloudresourcemanagerService->tagValues;

Methods

create(TagValue $postBody, array $optParams = [])

Creates a TagValue as a child of the specified TagKey. If a another request with the same parameters is sent while the original request is in process the second request will receive an error. A maximum of 1000 TagValues can exist under a TagKey at any given time. (tagValues.create)

delete(string $name, array $optParams = [])

Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.

get(string $name, array $optParams = [])

Retrieves a TagValue. This method will return PERMISSION_DENIED if the value does not exist or the user does not have permission to view it.

getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the access control policy for a TagValue. The returned policy may be empty if no such policy or resource exists. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have the cloudresourcemanager.googleapis.com/tagValues.getIamPolicy permission on the identified TagValue to get the access control policy.

getNamespaced(array $optParams = [])

Retrieves a TagValue by its namespaced name. This method will return PERMISSION_DENIED if the value does not exist or the user does not have permission to view it. (tagValues.getNamespaced)

listTagValues(array $optParams = [])

Lists all TagValues for a specific TagKey. (tagValues.listTagValues)

patch(string $name, TagValue $postBody, array $optParams = [])

Updates the attributes of the TagValue resource. (tagValues.patch)

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on a TagValue, replacing any existing policy.

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified TagValue. The resource field should be the TagValue's resource name. For example: tagValues/1234. There are no permissions required for making this API call.

Details

Operation create(TagValue $postBody, array $optParams = [])

Creates a TagValue as a child of the specified TagKey. If a another request with the same parameters is sent while the original request is in process the second request will receive an error. A maximum of 1000 TagValues can exist under a TagKey at any given time. (tagValues.create)

Parameters

TagValue $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation delete(string $name, array $optParams = [])

Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.

(tagValues.delete)

Parameters

string $name

Required. Resource name for TagValue to be deleted in the format tagValues/456.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

TagValue get(string $name, array $optParams = [])

Retrieves a TagValue. This method will return PERMISSION_DENIED if the value does not exist or the user does not have permission to view it.

(tagValues.get)

Parameters

string $name

Required. Resource name for TagValue to be fetched in the format tagValues/456.

array $optParams

Optional parameters.

Return Value

TagValue

Exceptions

Exception

Policy getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the access control policy for a TagValue. The returned policy may be empty if no such policy or resource exists. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have the cloudresourcemanager.googleapis.com/tagValues.getIamPolicy permission on the identified TagValue to get the access control policy.

(tagValues.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

GetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TagValue getNamespaced(array $optParams = [])

Retrieves a TagValue by its namespaced name. This method will return PERMISSION_DENIED if the value does not exist or the user does not have permission to view it. (tagValues.getNamespaced)

Parameters

array $optParams

Optional parameters.

Return Value

TagValue

Exceptions

Exception

ListTagValuesResponse listTagValues(array $optParams = [])

Lists all TagValues for a specific TagKey. (tagValues.listTagValues)

Parameters

array $optParams

Optional parameters.

Return Value

ListTagValuesResponse

Exceptions

Exception

Operation patch(string $name, TagValue $postBody, array $optParams = [])

Updates the attributes of the TagValue resource. (tagValues.patch)

Parameters

string $name

Immutable. Resource name for TagValue in the format tagValues/456.

TagValue $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on a TagValue, replacing any existing policy.

The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have resourcemanager.tagValues.setIamPolicy permission on the identified tagValue. (tagValues.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified TagValue. The resource field should be the TagValue's resource name. For example: tagValues/1234. There are no permissions required for making this API call.

(tagValues.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception