Class v3.TagKeysClient (3.1.0)

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Properties

apiEndpoint

static get apiEndpoint(): string;

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;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

tagKeysStub

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

warn

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

Methods

checkCreateTagKeyProgress(name)

checkCreateTagKeyProgress(name: string): Promise<LROperation<protos.google.cloud.resourcemanager.v3.TagKey, protos.google.cloud.resourcemanager.v3.CreateTagKeyMetadata>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The TagKey to be created. Only fields `short_name`, `description`,
   *  and `parent` are considered during the creation request.
   */
  // const tagKey = {}
  /**
   *  Optional. Set to true to perform validations necessary for creating the resource, but
   *  not actually perform the action.
   */
  // const validateOnly = true

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

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

  async function callCreateTagKey() {
    // Construct request
    const request = {
      tagKey,
    };

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

  callCreateTagKey();

checkDeleteTagKeyProgress(name)

checkDeleteTagKeyProgress(name: string): Promise<LROperation<protos.google.cloud.resourcemanager.v3.TagKey, protos.google.cloud.resourcemanager.v3.DeleteTagKeyMetadata>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of a TagKey to be deleted in the format `tagKeys/123`.
   *  The TagKey cannot be a parent of any existing TagValues or it will not be
   *  deleted successfully.
   */
  // const name = 'abc123'
  /**
   *  Optional. Set as true to perform 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 TagKey. This is
   *  to be used for optimistic concurrency.
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteTagKey();

checkUpdateTagKeyProgress(name)

checkUpdateTagKeyProgress(name: string): Promise<LROperation<protos.google.cloud.resourcemanager.v3.TagKey, protos.google.cloud.resourcemanager.v3.UpdateTagKeyMetadata>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The new definition of the TagKey. Only the `description` and `etag` fields
   *  can be updated by this request. If the `etag` field is not empty, it
   *  must match the `etag` field of the existing tag key. Otherwise,
   *  `FAILED_PRECONDITION` will be returned.
   */
  // const tagKey = {}
  /**
   *  Fields to be updated. The mask may only contain `description` or
   *  `etag`. If omitted entirely, both `description` and `etag` are assumed to
   *  be significant.
   */
  // const updateMask = {}
  /**
   *  Set as true to perform validations necessary for updating the resource, but
   *  not actually perform the action.
   */
  // const validateOnly = true

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

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

  async function callUpdateTagKey() {
    // Construct request
    const request = {
      tagKey,
    };

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

  callUpdateTagKey();

close()

close(): Promise<void>;

createTagKey(request, options)

createTagKey(request?: protos.google.cloud.resourcemanager.v3.ICreateTagKeyRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.resourcemanager.v3.ITagKey, protos.google.cloud.resourcemanager.v3.ICreateTagKeyMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The TagKey to be created. Only fields `short_name`, `description`,
   *  and `parent` are considered during the creation request.
   */
  // const tagKey = {}
  /**
   *  Optional. Set to true to perform validations necessary for creating the resource, but
   *  not actually perform the action.
   */
  // const validateOnly = true

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

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

  async function callCreateTagKey() {
    // Construct request
    const request = {
      tagKey,
    };

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

  callCreateTagKey();

createTagKey(request, options, callback)

createTagKey(request: protos.google.cloud.resourcemanager.v3.ICreateTagKeyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagKey, protos.google.cloud.resourcemanager.v3.ICreateTagKeyMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

createTagKey(request, callback)

createTagKey(request: protos.google.cloud.resourcemanager.v3.ICreateTagKeyRequest, callback: Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagKey, protos.google.cloud.resourcemanager.v3.ICreateTagKeyMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

deleteTagKey(request, options)

deleteTagKey(request?: protos.google.cloud.resourcemanager.v3.IDeleteTagKeyRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.resourcemanager.v3.ITagKey, protos.google.cloud.resourcemanager.v3.IDeleteTagKeyMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of a TagKey to be deleted in the format `tagKeys/123`.
   *  The TagKey cannot be a parent of any existing TagValues or it will not be
   *  deleted successfully.
   */
  // const name = 'abc123'
  /**
   *  Optional. Set as true to perform 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 TagKey. This is
   *  to be used for optimistic concurrency.
   */
  // const etag = 'abc123'

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

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

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

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

  callDeleteTagKey();

deleteTagKey(request, options, callback)

deleteTagKey(request: protos.google.cloud.resourcemanager.v3.IDeleteTagKeyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagKey, protos.google.cloud.resourcemanager.v3.IDeleteTagKeyMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

deleteTagKey(request, callback)

deleteTagKey(request: protos.google.cloud.resourcemanager.v3.IDeleteTagKeyRequest, callback: Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagKey, protos.google.cloud.resourcemanager.v3.IDeleteTagKeyMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

folderPath(folder)

folderPath(folder: string): 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]>;

  /**
   * 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`. This field is only used by Cloud IAM.
   */
  // const options = {}

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

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

  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;

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;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

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

getTagKey(request, options)

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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. A resource name in the format `tagKeys/{id}`, such as
   *  `tagKeys/123`.
   */
  // const name = 'abc123'

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

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

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

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

  callGetTagKey();

getTagKey(request, options, callback)

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

getTagKey(request, callback)

getTagKey(request: protos.google.cloud.resourcemanager.v3.IGetTagKeyRequest, callback: Callback<protos.google.cloud.resourcemanager.v3.ITagKey, protos.google.cloud.resourcemanager.v3.IGetTagKeyRequest | null | undefined, {} | null | undefined>): void;

initialize()

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

listTagKeys(request, options)

listTagKeys(request?: protos.google.cloud.resourcemanager.v3.IListTagKeysRequest, options?: CallOptions): Promise<[protos.google.cloud.resourcemanager.v3.ITagKey[], protos.google.cloud.resourcemanager.v3.IListTagKeysRequest | null, protos.google.cloud.resourcemanager.v3.IListTagKeysResponse]>;

listTagKeys(request, options, callback)

listTagKeys(request: protos.google.cloud.resourcemanager.v3.IListTagKeysRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.resourcemanager.v3.IListTagKeysRequest, protos.google.cloud.resourcemanager.v3.IListTagKeysResponse | null | undefined, protos.google.cloud.resourcemanager.v3.ITagKey>): void;

listTagKeys(request, callback)

listTagKeys(request: protos.google.cloud.resourcemanager.v3.IListTagKeysRequest, callback: PaginationCallback<protos.google.cloud.resourcemanager.v3.IListTagKeysRequest, protos.google.cloud.resourcemanager.v3.IListTagKeysResponse | null | undefined, protos.google.cloud.resourcemanager.v3.ITagKey>): void;

listTagKeysAsync(request, options)

listTagKeysAsync(request?: protos.google.cloud.resourcemanager.v3.IListTagKeysRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.resourcemanager.v3.ITagKey>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the new TagKey's parent.
   *  Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of TagKeys to return in the response. The server allows
   *  a maximum of 300 TagKeys 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 `ListTagKey`
   *  that indicates where this listing should continue from.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListTagKeys();

listTagKeysStream(request, options)

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

matchFolderFromFolderName(folderName)

matchFolderFromFolderName(folderName: string): string | number;

matchOrganizationFromOrganizationName(organizationName)

matchOrganizationFromOrganizationName(organizationName: string): string | number;

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

matchTagBindingFromTagBindingName(tagBindingName)

matchTagBindingFromTagBindingName(tagBindingName: string): string | number;

matchTagKeyFromTagKeyName(tagKeyName)

matchTagKeyFromTagKeyName(tagKeyName: string): string | number;

matchTagValueFromTagValueName(tagValueName)

matchTagValueFromTagValueName(tagValueName: string): string | number;

organizationPath(organization)

organizationPath(organization: string): string;

projectPath(project)

projectPath(project: string): 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]>;

  /**
   * 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 = {}

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

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

  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;

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;

tagBindingPath(tagBinding)

tagBindingPath(tagBinding: string): string;

tagKeyPath(tagKey)

tagKeyPath(tagKey: string): string;

tagValuePath(tagValue)

tagValuePath(tagValue: string): 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]>;

  /**
   * 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 = 'abc123'

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

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

  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;

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;

updateTagKey(request, options)

updateTagKey(request?: protos.google.cloud.resourcemanager.v3.IUpdateTagKeyRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.resourcemanager.v3.ITagKey, protos.google.cloud.resourcemanager.v3.IUpdateTagKeyMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The new definition of the TagKey. Only the `description` and `etag` fields
   *  can be updated by this request. If the `etag` field is not empty, it
   *  must match the `etag` field of the existing tag key. Otherwise,
   *  `FAILED_PRECONDITION` will be returned.
   */
  // const tagKey = {}
  /**
   *  Fields to be updated. The mask may only contain `description` or
   *  `etag`. If omitted entirely, both `description` and `etag` are assumed to
   *  be significant.
   */
  // const updateMask = {}
  /**
   *  Set as true to perform validations necessary for updating the resource, but
   *  not actually perform the action.
   */
  // const validateOnly = true

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

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

  async function callUpdateTagKey() {
    // Construct request
    const request = {
      tagKey,
    };

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

  callUpdateTagKey();

updateTagKey(request, options, callback)

updateTagKey(request: protos.google.cloud.resourcemanager.v3.IUpdateTagKeyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagKey, protos.google.cloud.resourcemanager.v3.IUpdateTagKeyMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

updateTagKey(request, callback)

updateTagKey(request: protos.google.cloud.resourcemanager.v3.IUpdateTagKeyRequest, callback: Callback<LROperation<protos.google.cloud.resourcemanager.v3.ITagKey, protos.google.cloud.resourcemanager.v3.IUpdateTagKeyMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;