Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class TagKeysClient.
Service Description: Allow users to create and manage tag keys.
This class is currently experimental and may be subject to changes.
Methods
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
tagKeyName
Formats a string containing the fully-qualified path to represent a tag_key resource.
tagKey
string
string
parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- tagKey: tagKeys/{tag_key}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
__construct
Constructor.
options
array
Optional. Options for configuring the service API wrapper.
↳ apiEndpoint
string
The address of the API remote host. May optionally include the port, formatted as "
↳ credentials
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage : In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to false
.
↳ clientConfig
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport
string|TransportInterface
The transport used for executing network requests. May be either the string rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
__call
Handles execution of the async variants for each documented method.
method
mixed
args
mixed
createTagKey
Creates a new TagKey. If 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 TagKeys can exist under a parent at any given time.
The async variant is Google\Cloud\ResourceManager\V3\Client\BaseClient\self::createTagKeyAsync() .
request
Google\Cloud\ResourceManager\V3\CreateTagKeyRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
deleteTagKey
Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.
The async variant is Google\Cloud\ResourceManager\V3\Client\BaseClient\self::deleteTagKeyAsync() .
request
Google\Cloud\ResourceManager\V3\DeleteTagKeyRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getIamPolicy
Gets the access control policy for a TagKey. The returned policy may be
empty if no such policy or resource exists. The resource
field should
be the TagKey's resource name. For example, "tagKeys/1234".
The caller must have cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy
permission on
the specified TagKey.
The async variant is Google\Cloud\ResourceManager\V3\Client\BaseClient\self::getIamPolicyAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getNamespacedTagKey
Retrieves a TagKey by its namespaced name.
This method will return PERMISSION_DENIED
if the key does not exist
or the user does not have permission to view it.
The async variant is Google\Cloud\ResourceManager\V3\Client\BaseClient\self::getNamespacedTagKeyAsync() .
request
Google\Cloud\ResourceManager\V3\GetNamespacedTagKeyRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
getTagKey
Retrieves a TagKey. This method will return PERMISSION_DENIED
if the
key does not exist or the user does not have permission to view it.
The async variant is Google\Cloud\ResourceManager\V3\Client\BaseClient\self::getTagKeyAsync() .
request
Google\Cloud\ResourceManager\V3\GetTagKeyRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
listTagKeys
Lists all TagKeys for a parent resource.
The async variant is Google\Cloud\ResourceManager\V3\Client\BaseClient\self::listTagKeysAsync() .
request
Google\Cloud\ResourceManager\V3\ListTagKeysRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
setIamPolicy
Sets the access control policy on a TagKey, replacing any existing
policy. The resource
field should be the TagKey's resource name.
For example, "tagKeys/1234".
The caller must have resourcemanager.tagKeys.setIamPolicy
permission
on the identified tagValue.
The async variant is Google\Cloud\ResourceManager\V3\Client\BaseClient\self::setIamPolicyAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
testIamPermissions
Returns permissions that a caller has on the specified TagKey.
The resource
field should be the TagKey's resource name.
For example, "tagKeys/1234".
There are no permissions required for making this API call.
The async variant is Google\Cloud\ResourceManager\V3\Client\BaseClient\self::testIamPermissionsAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
updateTagKey
Updates the attributes of the TagKey resource.
The async variant is Google\Cloud\ResourceManager\V3\Client\BaseClient\self::updateTagKeyAsync() .
request
Google\Cloud\ResourceManager\V3\UpdateTagKeyRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
