Class v3.TagBindingsClient (6.1.0)

Allow users to create and manage TagBindings between TagValues and different Google Cloud resources throughout the GCP resource hierarchy. v3

Package

@google-cloud/resource-manager

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of TagBindingsClient.

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 TagBindingsClient({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.

tagBindingsStub

tagBindingsStub?: 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: ''});

checkCreateTagBindingProgress(name)

checkCreateTagBindingProgress(name: string): Promise<LROperation<protos.google.cloud.resourcemanager.v3.TagBinding, protos.google.cloud.resourcemanager.v3.CreateTagBindingMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.resourcemanager.v3.TagBinding, protos.google.cloud.resourcemanager.v3.CreateTagBindingMetadata>>

{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 TagBinding to be created.
   */
  // const tagBinding = {}
  /**
   *  Optional. Set to true to perform the validations necessary for creating the
   *  resource, but not actually perform the action.
   */
  // const validateOnly = true

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

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

  async function callCreateTagBinding() {
    // Construct request
    const request = {
      tagBinding,
    };

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

  callCreateTagBinding();

checkDeleteTagBindingProgress(name)

checkDeleteTagBindingProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.resourcemanager.v3.DeleteTagBindingMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.resourcemanager.v3.DeleteTagBindingMetadata>>

{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 name of the TagBinding. This is a String of the form:
   *  `tagBindings/{id}` (e.g.
   *  `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteTagBinding();

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.

createTagBinding(request, options)

createTagBinding(request?: protos.google.cloud.resourcemanager.v3.ICreateTagBindingRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.resourcemanager.v3.ITagBinding, protos.google.cloud.resourcemanager.v3.ICreateTagBindingMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a TagBinding between a TagValue and a Google Cloud resource.

Parameters
Name Description
request ICreateTagBindingRequest

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.ITagBinding, protos.google.cloud.resourcemanager.v3.ICreateTagBindingMetadata>, 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 TagBinding to be created.
   */
  // const tagBinding = {}
  /**
   *  Optional. Set to true to perform the validations necessary for creating the
   *  resource, but not actually perform the action.
   */
  // const validateOnly = true

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

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

  async function callCreateTagBinding() {
    // Construct request
    const request = {
      tagBinding,
    };

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

  callCreateTagBinding();

createTagBinding(request, options, callback)

createTagBinding(request: protos.google.cloud.resourcemanager.v3.ICreateTagBindingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagBinding, protos.google.cloud.resourcemanager.v3.ICreateTagBindingMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateTagBindingRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagBinding, protos.google.cloud.resourcemanager.v3.ICreateTagBindingMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createTagBinding(request, callback)

createTagBinding(request: protos.google.cloud.resourcemanager.v3.ICreateTagBindingRequest, callback: Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagBinding, protos.google.cloud.resourcemanager.v3.ICreateTagBindingMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateTagBindingRequest
callback Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagBinding, protos.google.cloud.resourcemanager.v3.ICreateTagBindingMetadata>, 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: ''});

deleteTagBinding(request, options)

deleteTagBinding(request?: protos.google.cloud.resourcemanager.v3.IDeleteTagBindingRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.resourcemanager.v3.IDeleteTagBindingMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a TagBinding.

Parameters
Name Description
request IDeleteTagBindingRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.resourcemanager.v3.IDeleteTagBindingMetadata>, 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 name of the TagBinding. This is a String of the form:
   *  `tagBindings/{id}` (e.g.
   *  `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteTagBinding();

deleteTagBinding(request, options, callback)

deleteTagBinding(request: protos.google.cloud.resourcemanager.v3.IDeleteTagBindingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.resourcemanager.v3.IDeleteTagBindingMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteTagBindingRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.resourcemanager.v3.IDeleteTagBindingMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteTagBinding(request, callback)

deleteTagBinding(request: protos.google.cloud.resourcemanager.v3.IDeleteTagBindingRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.resourcemanager.v3.IDeleteTagBindingMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteTagBindingRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.resourcemanager.v3.IDeleteTagBindingMetadata>, 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.

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

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.

listEffectiveTags(request, options)

listEffectiveTags(request?: protos.google.cloud.resourcemanager.v3.IListEffectiveTagsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.resourcemanager.v3.IEffectiveTag[],
        protos.google.cloud.resourcemanager.v3.IListEffectiveTagsRequest | null,
        protos.google.cloud.resourcemanager.v3.IListEffectiveTagsResponse
    ]>;

Return a list of effective tags for the given Google Cloud resource, as specified in parent.

Parameters
Name Description
request IListEffectiveTagsRequest

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.IEffectiveTag[], protos.google.cloud.resourcemanager.v3.IListEffectiveTagsRequest | null, protos.google.cloud.resourcemanager.v3.IListEffectiveTagsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of EffectiveTag. 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 listEffectiveTagsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEffectiveTags(request, options, callback)

listEffectiveTags(request: protos.google.cloud.resourcemanager.v3.IListEffectiveTagsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.resourcemanager.v3.IListEffectiveTagsRequest, protos.google.cloud.resourcemanager.v3.IListEffectiveTagsResponse | null | undefined, protos.google.cloud.resourcemanager.v3.IEffectiveTag>): void;
Parameters
Name Description
request IListEffectiveTagsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.resourcemanager.v3.IListEffectiveTagsRequest, protos.google.cloud.resourcemanager.v3.IListEffectiveTagsResponse | null | undefined, protos.google.cloud.resourcemanager.v3.IEffectiveTag>
Returns
Type Description
void

listEffectiveTags(request, callback)

listEffectiveTags(request: protos.google.cloud.resourcemanager.v3.IListEffectiveTagsRequest, callback: PaginationCallback<protos.google.cloud.resourcemanager.v3.IListEffectiveTagsRequest, protos.google.cloud.resourcemanager.v3.IListEffectiveTagsResponse | null | undefined, protos.google.cloud.resourcemanager.v3.IEffectiveTag>): void;
Parameters
Name Description
request IListEffectiveTagsRequest
callback PaginationCallback<protos.google.cloud.resourcemanager.v3.IListEffectiveTagsRequest, protos.google.cloud.resourcemanager.v3.IListEffectiveTagsResponse | null | undefined, protos.google.cloud.resourcemanager.v3.IEffectiveTag>
Returns
Type Description
void

listEffectiveTagsAsync(request, options)

listEffectiveTagsAsync(request?: protos.google.cloud.resourcemanager.v3.IListEffectiveTagsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.resourcemanager.v3.IEffectiveTag>;

Equivalent to listEffectiveTags, but returns an iterable object.

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

Parameters
Name Description
request IListEffectiveTagsRequest

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.IEffectiveTag>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing EffectiveTag. 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. The full resource name of a resource for which you want to list
   *  the effective tags. E.g.
   *  "//cloudresourcemanager.googleapis.com/projects/123"
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of effective tags to return in the response.
   *  The server allows a maximum of 300 effective tags to return in a single
   *  page. If unspecified, the server will use 100 as the default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A pagination token returned from a previous call to
   *  `ListEffectiveTags` that indicates from where this listing should continue.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListEffectiveTags();

listEffectiveTagsStream(request, options)

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

Equivalent to listEffectiveTags, but returns a NodeJS Stream object.

Parameters
Name Description
request IListEffectiveTagsRequest

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 EffectiveTag 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 listEffectiveTagsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

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)

listTagBindings(request, options)

listTagBindings(request?: protos.google.cloud.resourcemanager.v3.IListTagBindingsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.resourcemanager.v3.ITagBinding[],
        protos.google.cloud.resourcemanager.v3.IListTagBindingsRequest | null,
        protos.google.cloud.resourcemanager.v3.IListTagBindingsResponse
    ]>;

Lists the TagBindings for the given Google Cloud resource, as specified with parent.

NOTE: The parent field is expected to be a full resource name: https://cloud.google.com/apis/design/resource_names#full_resource_name

Parameters
Name Description
request IListTagBindingsRequest

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.ITagBinding[], protos.google.cloud.resourcemanager.v3.IListTagBindingsRequest | null, protos.google.cloud.resourcemanager.v3.IListTagBindingsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of TagBinding. 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 listTagBindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTagBindings(request, options, callback)

listTagBindings(request: protos.google.cloud.resourcemanager.v3.IListTagBindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.resourcemanager.v3.IListTagBindingsRequest, protos.google.cloud.resourcemanager.v3.IListTagBindingsResponse | null | undefined, protos.google.cloud.resourcemanager.v3.ITagBinding>): void;
Parameters
Name Description
request IListTagBindingsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.resourcemanager.v3.IListTagBindingsRequest, protos.google.cloud.resourcemanager.v3.IListTagBindingsResponse | null | undefined, protos.google.cloud.resourcemanager.v3.ITagBinding>
Returns
Type Description
void

listTagBindings(request, callback)

listTagBindings(request: protos.google.cloud.resourcemanager.v3.IListTagBindingsRequest, callback: PaginationCallback<protos.google.cloud.resourcemanager.v3.IListTagBindingsRequest, protos.google.cloud.resourcemanager.v3.IListTagBindingsResponse | null | undefined, protos.google.cloud.resourcemanager.v3.ITagBinding>): void;
Parameters
Name Description
request IListTagBindingsRequest
callback PaginationCallback<protos.google.cloud.resourcemanager.v3.IListTagBindingsRequest, protos.google.cloud.resourcemanager.v3.IListTagBindingsResponse | null | undefined, protos.google.cloud.resourcemanager.v3.ITagBinding>
Returns
Type Description
void

listTagBindingsAsync(request, options)

listTagBindingsAsync(request?: protos.google.cloud.resourcemanager.v3.IListTagBindingsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.resourcemanager.v3.ITagBinding>;

Equivalent to listTagBindings, but returns an iterable object.

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

Parameters
Name Description
request IListTagBindingsRequest

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.ITagBinding>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing TagBinding. 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. The full resource name of a resource for which you want to list
   *  existing TagBindings. E.g.
   *  "//cloudresourcemanager.googleapis.com/projects/123"
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of TagBindings to return in the response. The
   *  server allows a maximum of 300 TagBindings 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
   *  `ListTagBindings` that indicates where this listing should continue from.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListTagBindings();

listTagBindingsStream(request, options)

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

Equivalent to listTagBindings, but returns a NodeJS Stream object.

Parameters
Name Description
request IListTagBindingsRequest

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 TagBinding 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 listTagBindingsAsync() 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.

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.