Class v3.TagValuesClient (6.1.0)

Version latest

• 6.1.0 (latest)
• 4.3.0
• 4.2.1
• 4.1.3
• 3.2.0
• 3.1.0
• 3.0.0
• 2.0.1

Allow users to create and manage tag values. v3

Package

@google-cloud/resource-manager

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of TagValuesClient.

Parameters
Name	Description
opts	ClientOptions
gaxInstance	typeof gax | typeof fallback : loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new TagValuesClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

tagValuesStub

tagValuesStub?: Promise<{
        [name: string]: Function;
    }>;

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

cancelOperation(request, optionsOrCallback, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
request	CancelOperationRequest The request object that will be sent.
optionsOrCallback	CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
callback	Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null> The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<protos.google.protobuf.Empty>

Example

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkCreateTagValueProgress(name)

checkCreateTagValueProgress(name: string): Promise<LROperation<protos.google.cloud.resourcemanager.v3.TagValue, protos.google.cloud.resourcemanager.v3.CreateTagValueMetadata>>;

Check the status of the long running operation returned by createTagValue().

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.resourcemanager.v3.TagValue, protos.google.cloud.resourcemanager.v3.CreateTagValueMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The TagValue to be created. Only fields `short_name`,
   *  `description`, and `parent` are considered during the creation request.
   */
  // const tagValue = {}
  /**
   *  Optional. Set as true to perform the validations necessary for creating the
   *  resource, but not actually perform the action.
   */
  // const validateOnly = true

  // Imports the Resourcemanager library
  const {TagValuesClient} = require('@google-cloud/resource-manager').v3;

  // Instantiates a client
  const resourcemanagerClient = new TagValuesClient();

  async function callCreateTagValue() {
    // Construct request
    const request = {
      tagValue,
    };

    // Run request
    const [operation] = await resourcemanagerClient.createTagValue(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateTagValue();

checkDeleteTagValueProgress(name)

checkDeleteTagValueProgress(name: string): Promise<LROperation<protos.google.cloud.resourcemanager.v3.TagValue, protos.google.cloud.resourcemanager.v3.DeleteTagValueMetadata>>;

Check the status of the long running operation returned by deleteTagValue().

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.resourcemanager.v3.TagValue, protos.google.cloud.resourcemanager.v3.DeleteTagValueMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name for TagValue to be deleted in the format
   *  tagValues/456.
   */
  // const name = 'abc123'
  /**
   *  Optional. Set as true to perform the validations necessary for deletion,
   *  but not actually perform the action.
   */
  // const validateOnly = true
  /**
   *  Optional. The etag known to the client for the expected state of the
   *  TagValue. This is to be used for optimistic concurrency.
   */
  // const etag = 'abc123'

  // Imports the Resourcemanager library
  const {TagValuesClient} = require('@google-cloud/resource-manager').v3;

  // Instantiates a client
  const resourcemanagerClient = new TagValuesClient();

  async function callDeleteTagValue() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await resourcemanagerClient.deleteTagValue(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteTagValue();

checkUpdateTagValueProgress(name)

checkUpdateTagValueProgress(name: string): Promise<LROperation<protos.google.cloud.resourcemanager.v3.TagValue, protos.google.cloud.resourcemanager.v3.UpdateTagValueMetadata>>;

Check the status of the long running operation returned by updateTagValue().

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.resourcemanager.v3.TagValue, protos.google.cloud.resourcemanager.v3.UpdateTagValueMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The new definition of the TagValue. Only fields `description` and
   *  `etag` fields can be updated by this request. If the `etag` field is
   *  nonempty, it must match the `etag` field of the existing ControlGroup.
   *  Otherwise, `ABORTED` will be returned.
   */
  // const tagValue = {}
  /**
   *  Optional. Fields to be updated.
   */
  // const updateMask = {}
  /**
   *  Optional. True to perform validations necessary for updating the resource,
   *  but not actually perform the action.
   */
  // const validateOnly = true

  // Imports the Resourcemanager library
  const {TagValuesClient} = require('@google-cloud/resource-manager').v3;

  // Instantiates a client
  const resourcemanagerClient = new TagValuesClient();

  async function callUpdateTagValue() {
    // Construct request
    const request = {
      tagValue,
    };

    // Run request
    const [operation] = await resourcemanagerClient.updateTagValue(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateTagValue();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

createTagValue(request, options)

createTagValue(request?: protos.google.cloud.resourcemanager.v3.ICreateTagValueRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.ICreateTagValueMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

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.

Parameters
Name	Description
request	ICreateTagValueRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.ICreateTagValueMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The TagValue to be created. Only fields `short_name`,
   *  `description`, and `parent` are considered during the creation request.
   */
  // const tagValue = {}
  /**
   *  Optional. Set as true to perform the validations necessary for creating the
   *  resource, but not actually perform the action.
   */
  // const validateOnly = true

  // Imports the Resourcemanager library
  const {TagValuesClient} = require('@google-cloud/resource-manager').v3;

  // Instantiates a client
  const resourcemanagerClient = new TagValuesClient();

  async function callCreateTagValue() {
    // Construct request
    const request = {
      tagValue,
    };

    // Run request
    const [operation] = await resourcemanagerClient.createTagValue(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateTagValue();

createTagValue(request, options, callback)

createTagValue(request: protos.google.cloud.resourcemanager.v3.ICreateTagValueRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.ICreateTagValueMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateTagValueRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.ICreateTagValueMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createTagValue(request, callback)

createTagValue(request: protos.google.cloud.resourcemanager.v3.ICreateTagValueRequest, callback: Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.ICreateTagValueMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateTagValueRequest
callback	Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.ICreateTagValueMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteOperation(request, optionsOrCallback, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
request	DeleteOperationRequest The request object that will be sent.
optionsOrCallback	CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
callback	Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined> The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<protos.google.protobuf.Empty>

Example

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

deleteTagValue(request, options)

deleteTagValue(request?: protos.google.cloud.resourcemanager.v3.IDeleteTagValueRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IDeleteTagValueMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

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

Parameters
Name	Description
request	IDeleteTagValueRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IDeleteTagValueMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name for TagValue to be deleted in the format
   *  tagValues/456.
   */
  // const name = 'abc123'
  /**
   *  Optional. Set as true to perform the validations necessary for deletion,
   *  but not actually perform the action.
   */
  // const validateOnly = true
  /**
   *  Optional. The etag known to the client for the expected state of the
   *  TagValue. This is to be used for optimistic concurrency.
   */
  // const etag = 'abc123'

  // Imports the Resourcemanager library
  const {TagValuesClient} = require('@google-cloud/resource-manager').v3;

  // Instantiates a client
  const resourcemanagerClient = new TagValuesClient();

  async function callDeleteTagValue() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await resourcemanagerClient.deleteTagValue(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteTagValue();

deleteTagValue(request, options, callback)

deleteTagValue(request: protos.google.cloud.resourcemanager.v3.IDeleteTagValueRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IDeleteTagValueMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteTagValueRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IDeleteTagValueMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteTagValue(request, callback)

deleteTagValue(request: protos.google.cloud.resourcemanager.v3.IDeleteTagValueRequest, callback: Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IDeleteTagValueMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteTagValueRequest
callback	Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IDeleteTagValueMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

folderPath(folder)

folderPath(folder: string): string;

Return a fully-qualified folder resource name string.

Parameter
Name	Description
folder	string

Returns
Type	Description
string	{string} Resource name string.

getIamPolicy(request, options)

getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.IPolicy,
        protos.google.iam.v1.IGetIamPolicyRequest | undefined,
        {} | undefined
    ]>;

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.

Parameters
Name	Description
request	IGetIamPolicyRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Policy. Please see the documentation for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  REQUIRED: The resource for which the policy is being requested.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  OPTIONAL: A `GetPolicyOptions` object for specifying options to
   *  `GetIamPolicy`.
   */
  // const options = {}

  // Imports the Resourcemanager library
  const {TagValuesClient} = require('@google-cloud/resource-manager').v3;

  // Instantiates a client
  const resourcemanagerClient = new TagValuesClient();

  async function callGetIamPolicy() {
    // Construct request
    const request = {
      resource,
    };

    // Run request
    const response = await resourcemanagerClient.getIamPolicy(request);
    console.log(response);
  }

  callGetIamPolicy();

getIamPolicy(request, options, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetIamPolicyRequest
options	CallOptions
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getIamPolicy(request, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetIamPolicyRequest
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getNamespacedTagValue(request, options)

getNamespacedTagValue(request?: protos.google.cloud.resourcemanager.v3.IGetNamespacedTagValueRequest, options?: CallOptions): Promise<[
        protos.google.cloud.resourcemanager.v3.ITagValue,
        (protos.google.cloud.resourcemanager.v3.IGetNamespacedTagValueRequest | undefined),
        {} | undefined
    ]>;

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.

Parameters
Name	Description
request	IGetNamespacedTagValueRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.resourcemanager.v3.ITagValue, (protos.google.cloud.resourcemanager.v3.IGetNamespacedTagValueRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TagValue. Please see the documentation for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. 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"
   */
  // const name = 'abc123'

  // Imports the Resourcemanager library
  const {TagValuesClient} = require('@google-cloud/resource-manager').v3;

  // Instantiates a client
  const resourcemanagerClient = new TagValuesClient();

  async function callGetNamespacedTagValue() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await resourcemanagerClient.getNamespacedTagValue(request);
    console.log(response);
  }

  callGetNamespacedTagValue();

getNamespacedTagValue(request, options, callback)

getNamespacedTagValue(request: protos.google.cloud.resourcemanager.v3.IGetNamespacedTagValueRequest, options: CallOptions, callback: Callback<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IGetNamespacedTagValueRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetNamespacedTagValueRequest
options	CallOptions
callback	Callback<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IGetNamespacedTagValueRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getNamespacedTagValue(request, callback)

getNamespacedTagValue(request: protos.google.cloud.resourcemanager.v3.IGetNamespacedTagValueRequest, callback: Callback<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IGetNamespacedTagValueRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetNamespacedTagValueRequest
callback	Callback<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IGetNamespacedTagValueRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getOperation(request, optionsOrCallback, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
request	GetOperationRequest The request object that will be sent.
optionsOrCallback	CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
callback	Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<[protos.google.longrunning.Operation]>

Example

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
callback	Callback<string, undefined, undefined>

Returns
Type	Description
void

getTagValue(request, options)

getTagValue(request?: protos.google.cloud.resourcemanager.v3.IGetTagValueRequest, options?: CallOptions): Promise<[
        protos.google.cloud.resourcemanager.v3.ITagValue,
        protos.google.cloud.resourcemanager.v3.IGetTagValueRequest | undefined,
        {} | undefined
    ]>;

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.

Parameters
Name	Description
request	IGetTagValueRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IGetTagValueRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TagValue. Please see the documentation for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name for TagValue to be fetched in the format
   *  `tagValues/456`.
   */
  // const name = 'abc123'

  // Imports the Resourcemanager library
  const {TagValuesClient} = require('@google-cloud/resource-manager').v3;

  // Instantiates a client
  const resourcemanagerClient = new TagValuesClient();

  async function callGetTagValue() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await resourcemanagerClient.getTagValue(request);
    console.log(response);
  }

  callGetTagValue();

getTagValue(request, options, callback)

getTagValue(request: protos.google.cloud.resourcemanager.v3.IGetTagValueRequest, options: CallOptions, callback: Callback<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IGetTagValueRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetTagValueRequest
options	CallOptions
callback	Callback<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IGetTagValueRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getTagValue(request, callback)

getTagValue(request: protos.google.cloud.resourcemanager.v3.IGetTagValueRequest, callback: Callback<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IGetTagValueRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetTagValueRequest
callback	Callback<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IGetTagValueRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
Name	Description
request	ListOperationsRequest The request object that will be sent.
options	CallOptions Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type	Description
AsyncIterable<protos.google.longrunning.IOperation>	{Object} An iterable Object that conforms to iteration protocols.

Example

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

listTagValues(request, options)

listTagValues(request?: protos.google.cloud.resourcemanager.v3.IListTagValuesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.resourcemanager.v3.ITagValue[],
        protos.google.cloud.resourcemanager.v3.IListTagValuesRequest | null,
        protos.google.cloud.resourcemanager.v3.IListTagValuesResponse
    ]>;

Lists all TagValues for a specific TagKey.

Parameters
Name	Description
request	IListTagValuesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.resourcemanager.v3.ITagValue[], protos.google.cloud.resourcemanager.v3.IListTagValuesRequest | null, protos.google.cloud.resourcemanager.v3.IListTagValuesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of TagValue. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listTagValuesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTagValues(request, options, callback)

listTagValues(request: protos.google.cloud.resourcemanager.v3.IListTagValuesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.resourcemanager.v3.IListTagValuesRequest, protos.google.cloud.resourcemanager.v3.IListTagValuesResponse | null | undefined, protos.google.cloud.resourcemanager.v3.ITagValue>): void;

Parameters
Name	Description
request	IListTagValuesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.resourcemanager.v3.IListTagValuesRequest, protos.google.cloud.resourcemanager.v3.IListTagValuesResponse | null | undefined, protos.google.cloud.resourcemanager.v3.ITagValue>

Returns
Type	Description
void

listTagValues(request, callback)

listTagValues(request: protos.google.cloud.resourcemanager.v3.IListTagValuesRequest, callback: PaginationCallback<protos.google.cloud.resourcemanager.v3.IListTagValuesRequest, protos.google.cloud.resourcemanager.v3.IListTagValuesResponse | null | undefined, protos.google.cloud.resourcemanager.v3.ITagValue>): void;

Parameters
Name	Description
request	IListTagValuesRequest
callback	PaginationCallback<protos.google.cloud.resourcemanager.v3.IListTagValuesRequest, protos.google.cloud.resourcemanager.v3.IListTagValuesResponse | null | undefined, protos.google.cloud.resourcemanager.v3.ITagValue>

Returns
Type	Description
void

listTagValuesAsync(request, options)

listTagValuesAsync(request?: protos.google.cloud.resourcemanager.v3.IListTagValuesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.resourcemanager.v3.ITagValue>;

Equivalent to listTagValues, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListTagValuesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.resourcemanager.v3.ITagValue>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing TagValue. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of TagValues to return in the response. The
   *  server allows a maximum of 300 TagValues to return. If unspecified, the
   *  server will use 100 as the default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A pagination token returned from a previous call to
   *  `ListTagValues` that indicates where this listing should continue from.
   */
  // const pageToken = 'abc123'

  // Imports the Resourcemanager library
  const {TagValuesClient} = require('@google-cloud/resource-manager').v3;

  // Instantiates a client
  const resourcemanagerClient = new TagValuesClient();

  async function callListTagValues() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = resourcemanagerClient.listTagValuesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListTagValues();

listTagValuesStream(request, options)

listTagValuesStream(request?: protos.google.cloud.resourcemanager.v3.IListTagValuesRequest, options?: CallOptions): Transform;

Equivalent to listTagValues, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListTagValuesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing TagValue on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTagValuesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchFolderFromFolderName(folderName)

matchFolderFromFolderName(folderName: string): string | number;

Parse the folder from Folder resource.

Parameter
Name	Description
folderName	string A fully-qualified path representing Folder resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchOrganizationFromOrganizationName(organizationName)

matchOrganizationFromOrganizationName(organizationName: string): string | number;

Parse the organization from Organization resource.

Parameter
Name	Description
organizationName	string A fully-qualified path representing Organization resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name	Description
projectName	string A fully-qualified path representing Project resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchTagBindingFromTagBindingName(tagBindingName)

matchTagBindingFromTagBindingName(tagBindingName: string): string | number;

Parse the tag_binding from TagBinding resource.

Parameter
Name	Description
tagBindingName	string A fully-qualified path representing TagBinding resource.

Returns
Type	Description
string | number	{string} A string representing the tag_binding.

matchTagHoldFromTagHoldName(tagHoldName)

matchTagHoldFromTagHoldName(tagHoldName: string): string | number;

Parse the tag_hold from TagHold resource.

Parameter
Name	Description
tagHoldName	string A fully-qualified path representing TagHold resource.

Returns
Type	Description
string | number	{string} A string representing the tag_hold.

matchTagKeyFromTagKeyName(tagKeyName)

matchTagKeyFromTagKeyName(tagKeyName: string): string | number;

Parse the tag_key from TagKey resource.

Parameter
Name	Description
tagKeyName	string A fully-qualified path representing TagKey resource.

Returns
Type	Description
string | number	{string} A string representing the tag_key.

matchTagValueFromTagHoldName(tagHoldName)

matchTagValueFromTagHoldName(tagHoldName: string): string | number;

Parse the tag_value from TagHold resource.

Parameter
Name	Description
tagHoldName	string A fully-qualified path representing TagHold resource.

Returns
Type	Description
string | number	{string} A string representing the tag_value.

matchTagValueFromTagValueName(tagValueName)

matchTagValueFromTagValueName(tagValueName: string): string | number;

Parse the tag_value from TagValue resource.

Parameter
Name	Description
tagValueName	string A fully-qualified path representing TagValue resource.

Returns
Type	Description
string | number	{string} A string representing the tag_value.

organizationPath(organization)

organizationPath(organization: string): string;

Return a fully-qualified organization resource name string.

Parameter
Name	Description
organization	string

Returns
Type	Description
string	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name	Description
project	string

Returns
Type	Description
string	{string} Resource name string.

setIamPolicy(request, options)

setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.IPolicy,
        protos.google.iam.v1.ISetIamPolicyRequest | undefined,
        {} | undefined
    ]>;

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.

Parameters
Name	Description
request	ISetIamPolicyRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Policy. Please see the documentation for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  REQUIRED: The resource for which the policy is being specified.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  REQUIRED: The complete policy to be applied to the `resource`. The size of
   *  the policy is limited to a few 10s of KB. An empty policy is a
   *  valid policy but certain Cloud Platform services (such as Projects)
   *  might reject them.
   */
  // const policy = {}
  /**
   *  OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
   *  the fields in the mask will be modified. If no mask is provided, the
   *  following default mask is used:
   *  `paths: "bindings, etag"`
   */
  // const updateMask = {}

  // Imports the Resourcemanager library
  const {TagValuesClient} = require('@google-cloud/resource-manager').v3;

  // Instantiates a client
  const resourcemanagerClient = new TagValuesClient();

  async function callSetIamPolicy() {
    // Construct request
    const request = {
      resource,
      policy,
    };

    // Run request
    const response = await resourcemanagerClient.setIamPolicy(request);
    console.log(response);
  }

  callSetIamPolicy();

setIamPolicy(request, options, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ISetIamPolicyRequest
options	CallOptions
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

setIamPolicy(request, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ISetIamPolicyRequest
callback	Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

tagBindingPath(tagBinding)

tagBindingPath(tagBinding: string): string;

Return a fully-qualified tagBinding resource name string.

Parameter
Name	Description
tagBinding	string

Returns
Type	Description
string	{string} Resource name string.

tagHoldPath(tagValue, tagHold)

tagHoldPath(tagValue: string, tagHold: string): string;

Return a fully-qualified tagHold resource name string.

Parameters
Name	Description
tagValue	string
tagHold	string

Returns
Type	Description
string	{string} Resource name string.

tagKeyPath(tagKey)

tagKeyPath(tagKey: string): string;

Return a fully-qualified tagKey resource name string.

Parameter
Name	Description
tagKey	string

Returns
Type	Description
string	{string} Resource name string.

tagValuePath(tagValue)

tagValuePath(tagValue: string): string;

Return a fully-qualified tagValue resource name string.

Parameter
Name	Description
tagValue	string

Returns
Type	Description
string	{string} Resource name string.

testIamPermissions(request, options)

testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.ITestIamPermissionsResponse,
        protos.google.iam.v1.ITestIamPermissionsRequest | undefined,
        {} | undefined
    ]>;

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.

Parameters
Name	Description
request	ITestIamPermissionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  REQUIRED: The resource for which the policy detail is being requested.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  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).
   */
  // const permissions = ['abc','def']

  // Imports the Resourcemanager library
  const {TagValuesClient} = require('@google-cloud/resource-manager').v3;

  // Instantiates a client
  const resourcemanagerClient = new TagValuesClient();

  async function callTestIamPermissions() {
    // Construct request
    const request = {
      resource,
      permissions,
    };

    // Run request
    const response = await resourcemanagerClient.testIamPermissions(request);
    console.log(response);
  }

  callTestIamPermissions();

testIamPermissions(request, options, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ITestIamPermissionsRequest
options	CallOptions
callback	Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

testIamPermissions(request, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ITestIamPermissionsRequest
callback	Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateTagValue(request, options)

updateTagValue(request?: protos.google.cloud.resourcemanager.v3.IUpdateTagValueRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IUpdateTagValueMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the attributes of the TagValue resource.

Parameters
Name	Description
request	IUpdateTagValueRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IUpdateTagValueMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The new definition of the TagValue. Only fields `description` and
   *  `etag` fields can be updated by this request. If the `etag` field is
   *  nonempty, it must match the `etag` field of the existing ControlGroup.
   *  Otherwise, `ABORTED` will be returned.
   */
  // const tagValue = {}
  /**
   *  Optional. Fields to be updated.
   */
  // const updateMask = {}
  /**
   *  Optional. True to perform validations necessary for updating the resource,
   *  but not actually perform the action.
   */
  // const validateOnly = true

  // Imports the Resourcemanager library
  const {TagValuesClient} = require('@google-cloud/resource-manager').v3;

  // Instantiates a client
  const resourcemanagerClient = new TagValuesClient();

  async function callUpdateTagValue() {
    // Construct request
    const request = {
      tagValue,
    };

    // Run request
    const [operation] = await resourcemanagerClient.updateTagValue(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateTagValue();

updateTagValue(request, options, callback)

updateTagValue(request: protos.google.cloud.resourcemanager.v3.IUpdateTagValueRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IUpdateTagValueMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateTagValueRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IUpdateTagValueMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateTagValue(request, callback)

updateTagValue(request: protos.google.cloud.resourcemanager.v3.IUpdateTagValueRequest, callback: Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IUpdateTagValueMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateTagValueRequest
callback	Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagValue, protos.google.cloud.resourcemanager.v3.IUpdateTagValueMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void