Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class TagValuesClient.
Service Description: Allow users to create and manage tag values.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ ResourceManager \ V3 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
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 |
↳ 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 |
↳ 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. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
createTagValue
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.
The async variant is TagValuesClient::createTagValueAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\CreateTagValueRequest
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. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ResourceManager\V3\Client\TagValuesClient;
use Google\Cloud\ResourceManager\V3\CreateTagValueRequest;
use Google\Cloud\ResourceManager\V3\TagValue;
use Google\Rpc\Status;
/**
* @param string $tagValueShortName Immutable. User-assigned short name for TagValue. The short name
* should be unique for TagValues within the same parent TagKey.
*
* The short name must be 63 characters or less, beginning and ending with
* an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_),
* dots (.), and alphanumerics between.
*/
function create_tag_value_sample(string $tagValueShortName): void
{
// Create a client.
$tagValuesClient = new TagValuesClient();
// Prepare the request message.
$tagValue = (new TagValue())
->setShortName($tagValueShortName);
$request = (new CreateTagValueRequest())
->setTagValue($tagValue);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $tagValuesClient->createTagValue($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var TagValue $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$tagValueShortName = '[SHORT_NAME]';
create_tag_value_sample($tagValueShortName);
}
deleteTagValue
Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.
The async variant is TagValuesClient::deleteTagValueAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\DeleteTagValueRequest
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. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ResourceManager\V3\Client\TagValuesClient;
use Google\Cloud\ResourceManager\V3\DeleteTagValueRequest;
use Google\Cloud\ResourceManager\V3\TagValue;
use Google\Rpc\Status;
/**
* @param string $formattedName Resource name for TagValue to be deleted in the format
* tagValues/456. Please see
* {@see TagValuesClient::tagValueName()} for help formatting this field.
*/
function delete_tag_value_sample(string $formattedName): void
{
// Create a client.
$tagValuesClient = new TagValuesClient();
// Prepare the request message.
$request = (new DeleteTagValueRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $tagValuesClient->deleteTagValue($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var TagValue $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = TagValuesClient::tagValueName('[TAG_VALUE]');
delete_tag_value_sample($formattedName);
}
getIamPolicy
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.
The async variant is TagValuesClient::getIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\ResourceManager\V3\Client\TagValuesClient;
/**
* @param string $resource REQUIRED: The resource for which the policy is being requested.
* See the operation documentation for the appropriate value for this field.
*/
function get_iam_policy_sample(string $resource): void
{
// Create a client.
$tagValuesClient = new TagValuesClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $tagValuesClient->getIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
get_iam_policy_sample($resource);
}
getNamespacedTagValue
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.
The async variant is TagValuesClient::getNamespacedTagValueAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\GetNamespacedTagValueRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\ResourceManager\V3\TagValue |
use Google\ApiCore\ApiException;
use Google\Cloud\ResourceManager\V3\Client\TagValuesClient;
use Google\Cloud\ResourceManager\V3\GetNamespacedTagValueRequest;
use Google\Cloud\ResourceManager\V3\TagValue;
/**
* @param string $formattedName A namespaced tag value name in the following format:
*
* `{parentId}/{tagKeyShort}/{tagValueShort}`
*
* Examples:
* - `42/foo/abc` for a value with short name "abc" under the key with short
* name "foo" under the organization with ID 42
* - `r2-d2/bar/xyz` for a value with short name "xyz" under the key with
* short name "bar" under the project with ID "r2-d2"
* Please see {@see TagValuesClient::tagValueName()} for help formatting this field.
*/
function get_namespaced_tag_value_sample(string $formattedName): void
{
// Create a client.
$tagValuesClient = new TagValuesClient();
// Prepare the request message.
$request = (new GetNamespacedTagValueRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var TagValue $response */
$response = $tagValuesClient->getNamespacedTagValue($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = TagValuesClient::tagValueName('[TAG_VALUE]');
get_namespaced_tag_value_sample($formattedName);
}
getTagValue
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.
The async variant is TagValuesClient::getTagValueAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\GetTagValueRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\ResourceManager\V3\TagValue |
use Google\ApiCore\ApiException;
use Google\Cloud\ResourceManager\V3\Client\TagValuesClient;
use Google\Cloud\ResourceManager\V3\GetTagValueRequest;
use Google\Cloud\ResourceManager\V3\TagValue;
/**
* @param string $formattedName Resource name for TagValue to be fetched in the format
* `tagValues/456`. Please see
* {@see TagValuesClient::tagValueName()} for help formatting this field.
*/
function get_tag_value_sample(string $formattedName): void
{
// Create a client.
$tagValuesClient = new TagValuesClient();
// Prepare the request message.
$request = (new GetTagValueRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var TagValue $response */
$response = $tagValuesClient->getTagValue($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = TagValuesClient::tagValueName('[TAG_VALUE]');
get_tag_value_sample($formattedName);
}
listTagValues
Lists all TagValues for a specific TagKey.
The async variant is TagValuesClient::listTagValuesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\ListTagValuesRequest
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. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ResourceManager\V3\Client\TagValuesClient;
use Google\Cloud\ResourceManager\V3\ListTagValuesRequest;
use Google\Cloud\ResourceManager\V3\TagValue;
/**
* @param string $parent Required.
*/
function list_tag_values_sample(string $parent): void
{
// Create a client.
$tagValuesClient = new TagValuesClient();
// Prepare the request message.
$request = (new ListTagValuesRequest())
->setParent($parent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $tagValuesClient->listTagValues($request);
/** @var TagValue $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$parent = '[PARENT]';
list_tag_values_sample($parent);
}
setIamPolicy
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.
The async variant is TagValuesClient::setIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\ResourceManager\V3\Client\TagValuesClient;
/**
* @param string $resource REQUIRED: The resource for which the policy is being specified.
* See the operation documentation for the appropriate value for this field.
*/
function set_iam_policy_sample(string $resource): void
{
// Create a client.
$tagValuesClient = new TagValuesClient();
// Prepare the request message.
$policy = new Policy();
$request = (new SetIamPolicyRequest())
->setResource($resource)
->setPolicy($policy);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $tagValuesClient->setIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
set_iam_policy_sample($resource);
}
testIamPermissions
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.
The async variant is TagValuesClient::testIamPermissionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
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. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\ResourceManager\V3\Client\TagValuesClient;
/**
* @param string $resource REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
* @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more
* information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
// Create a client.
$tagValuesClient = new TagValuesClient();
// Prepare the request message.
$permissions = [$permissionsElement,];
$request = (new TestIamPermissionsRequest())
->setResource($resource)
->setPermissions($permissions);
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $tagValuesClient->testIamPermissions($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
$permissionsElement = '[PERMISSIONS]';
test_iam_permissions_sample($resource, $permissionsElement);
}
updateTagValue
Updates the attributes of the TagValue resource.
The async variant is TagValuesClient::updateTagValueAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\UpdateTagValueRequest
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. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ResourceManager\V3\Client\TagValuesClient;
use Google\Cloud\ResourceManager\V3\TagValue;
use Google\Cloud\ResourceManager\V3\UpdateTagValueRequest;
use Google\Rpc\Status;
/**
* @param string $tagValueShortName Immutable. User-assigned short name for TagValue. The short name
* should be unique for TagValues within the same parent TagKey.
*
* The short name must be 63 characters or less, beginning and ending with
* an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_),
* dots (.), and alphanumerics between.
*/
function update_tag_value_sample(string $tagValueShortName): void
{
// Create a client.
$tagValuesClient = new TagValuesClient();
// Prepare the request message.
$tagValue = (new TagValue())
->setShortName($tagValueShortName);
$request = (new UpdateTagValueRequest())
->setTagValue($tagValue);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $tagValuesClient->updateTagValue($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var TagValue $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$tagValueShortName = '[SHORT_NAME]';
update_tag_value_sample($tagValueShortName);
}
createTagValueAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\CreateTagValueRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
deleteTagValueAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\DeleteTagValueRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
getNamespacedTagValueAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\GetNamespacedTagValueRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\ResourceManager\V3\TagValue> |
getTagValueAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\GetTagValueRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\ResourceManager\V3\TagValue> |
listTagValuesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\ListTagValuesRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
setIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
testIamPermissionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\TestIamPermissionsResponse> |
updateTagValueAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\ResourceManager\V3\UpdateTagValueRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\LongRunning\Client\OperationsClient |
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.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
static::tagValueName
Formats a string containing the fully-qualified path to represent a tag_value resource.
Parameter | |
---|---|
Name | Description |
tagValue |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted tag_value resource. |
static::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
- tagValue: tagValues/{tag_value}
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.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
?string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array |
An associative array from name component IDs to component values. |