TagBindingsClient

TagBindingsClient

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

Constructor

new TagBindingsClient(optionsopt)

Construct an instance of TagBindingsClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

(async) checkCreateTagBindingProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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
const decodedOperation = await checkCreateTagBindingProgress(name);
console.log(decodedOperation.result);
console.log(decodedOperation.done);
console.log(decodedOperation.metadata);

(async) checkDeleteTagBindingProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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
const decodedOperation = await checkDeleteTagBindingProgress(name);
console.log(decodedOperation.result);
console.log(decodedOperation.done);
console.log(decodedOperation.metadata);

close() → {Promise}

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

A promise that resolves when the client is closed.

createTagBinding(request, optionsopt) → {Promise}

Creates a TagBinding between a TagValue and a cloud resource (currently project, folder, or organization).

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
tagBinding google.cloud.resourcemanager.v3.TagBinding

Required. The TagBinding to be created.
validateOnly boolean <optional>

Optional. Set to true to perform the validations necessary for creating the resource, but not actually perform the action.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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
const [operation] = await client.createTagBinding(request);
const [response] = await operation.promise();

deleteTagBinding(request, optionsopt) → {Promise}

Deletes a TagBinding.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

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).
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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
const [operation] = await client.deleteTagBinding(request);
const [response] = await operation.promise();

folderPath(folder) → {string}

Return a fully-qualified folder resource name string.

Parameters:
Name Type Description
folder string
Returns:
Type Description
string

Resource name string.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

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

A promise that resolves to an authenticated service stub.

listTagBindings(request, optionsopt) → {Promise}

Lists the TagBindings for the given 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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The full resource name of a resource for which you want to list existing TagBindings. E.g. "//cloudresourcemanager.googleapis.com/projects/123"
pageSize number <optional>

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.
pageToken string <optional>

Optional. A pagination token returned from a previous call to ListTagBindings that indicates where this listing should continue from.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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.

listTagBindingsAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The full resource name of a resource for which you want to list existing TagBindings. E.g. "//cloudresourcemanager.googleapis.com/projects/123"
pageSize number <optional>

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.
pageToken string <optional>

Optional. A pagination token returned from a previous call to ListTagBindings that indicates where this listing should continue from.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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
const iterable = client.listTagBindingsAsync(request);
for await (const response of iterable) {
  // process response
}

listTagBindingsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The full resource name of a resource for which you want to list existing TagBindings. E.g. "//cloudresourcemanager.googleapis.com/projects/123"
pageSize number <optional>

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.
pageToken string <optional>

Optional. A pagination token returned from a previous call to ListTagBindings that indicates where this listing should continue from.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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) → {string}

Parse the folder from Folder resource.

Parameters:
Name Type Description
folderName string

A fully-qualified path representing Folder resource.
Returns:
Type Description
string

A string representing the folder.

matchOrganizationFromOrganizationName(organizationName) → {string}

Parse the organization from Organization resource.

Parameters:
Name Type Description
organizationName string

A fully-qualified path representing Organization resource.
Returns:
Type Description
string

A string representing the organization.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:
Name Type Description
projectName string

A fully-qualified path representing Project resource.
Returns:
Type Description
string

A string representing the project.

matchTagBindingFromTagBindingName(tagBindingName) → {string}

Parse the tag_binding from TagBinding resource.

Parameters:
Name Type Description
tagBindingName string

A fully-qualified path representing TagBinding resource.
Returns:
Type Description
string

A string representing the tag_binding.

matchTagKeyFromTagKeyName(tagKeyName) → {string}

Parse the tag_key from TagKey resource.

Parameters:
Name Type Description
tagKeyName string

A fully-qualified path representing TagKey resource.
Returns:
Type Description
string

A string representing the tag_key.

matchTagValueFromTagValueName(tagValueName) → {string}

Parse the tag_value from TagValue resource.

Parameters:
Name Type Description
tagValueName string

A fully-qualified path representing TagValue resource.
Returns:
Type Description
string

A string representing the tag_value.

organizationPath(organization) → {string}

Return a fully-qualified organization resource name string.

Parameters:
Name Type Description
organization string
Returns:
Type Description
string

Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project string
Returns:
Type Description
string

Resource name string.

tagBindingPath(tag_binding) → {string}

Return a fully-qualified tagBinding resource name string.

Parameters:
Name Type Description
tag_binding string
Returns:
Type Description
string

Resource name string.

tagKeyPath(tag_key) → {string}

Return a fully-qualified tagKey resource name string.

Parameters:
Name Type Description
tag_key string
Returns:
Type Description
string

Resource name string.

tagValuePath(tag_value) → {string}

Return a fully-qualified tagValue resource name string.

Parameters:
Name Type Description
tag_value string
Returns:
Type Description
string

Resource name string.