Class v3.OrganizationsClient (4.3.0)

Package

Constructors

(constructor)(opts, gaxInstance)

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

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

organizationsStub

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

pathTemplates

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

port

static get port(): number;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

warn

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

Methods

close()

close(): Promise<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
    ]>;

  /**
   * 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 {OrganizationsClient} = require('@google-cloud/resource-manager').v3;

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

  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;

getOrganization(request, options)

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

  /**
   * 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 name of the Organization to fetch. This is the
   *  organization's relative path in the API, formatted as
   *  "organizations/[organizationId]". For example, "organizations/1234".
   */
  // const name = 'abc123'

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

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

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

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

  callGetOrganization();

getOrganization(request, options, callback)

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

getOrganization(request, callback)

getOrganization(request: protos.google.cloud.resourcemanager.v3.IGetOrganizationRequest, callback: Callback<protos.google.cloud.resourcemanager.v3.IOrganization, protos.google.cloud.resourcemanager.v3.IGetOrganizationRequest | null | undefined, {} | null | undefined>): void;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

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

initialize()

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

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;

matchTagHoldFromTagHoldName(tagHoldName)

matchTagHoldFromTagHoldName(tagHoldName: string): string | number;

matchTagKeyFromTagKeyName(tagKeyName)

matchTagKeyFromTagKeyName(tagKeyName: string): string | number;

matchTagValueFromTagHoldName(tagHoldName)

matchTagValueFromTagHoldName(tagHoldName: string): string | number;

matchTagValueFromTagValueName(tagValueName)

matchTagValueFromTagValueName(tagValueName: string): string | number;

organizationPath(organization)

organizationPath(organization: string): string;

projectPath(project)

projectPath(project: string): string;

searchOrganizations(request, options)

searchOrganizations(request?: protos.google.cloud.resourcemanager.v3.ISearchOrganizationsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.resourcemanager.v3.IOrganization[],
        protos.google.cloud.resourcemanager.v3.ISearchOrganizationsRequest | null,
        protos.google.cloud.resourcemanager.v3.ISearchOrganizationsResponse
    ]>;

searchOrganizations(request, options, callback)

searchOrganizations(request: protos.google.cloud.resourcemanager.v3.ISearchOrganizationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.resourcemanager.v3.ISearchOrganizationsRequest, protos.google.cloud.resourcemanager.v3.ISearchOrganizationsResponse | null | undefined, protos.google.cloud.resourcemanager.v3.IOrganization>): void;

searchOrganizations(request, callback)

searchOrganizations(request: protos.google.cloud.resourcemanager.v3.ISearchOrganizationsRequest, callback: PaginationCallback<protos.google.cloud.resourcemanager.v3.ISearchOrganizationsRequest, protos.google.cloud.resourcemanager.v3.ISearchOrganizationsResponse | null | undefined, protos.google.cloud.resourcemanager.v3.IOrganization>): void;

searchOrganizationsAsync(request, options)

searchOrganizationsAsync(request?: protos.google.cloud.resourcemanager.v3.ISearchOrganizationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.resourcemanager.v3.IOrganization>;

  /**
   * 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.
   */
  /**
   *  Optional. The maximum number of organizations to return in the response.
   *  The server can return fewer organizations than requested. If unspecified,
   *  server picks an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A pagination token returned from a previous call to
   *  `SearchOrganizations` that indicates from where listing should continue.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. An optional query string used to filter the Organizations to
   *  return in the response. Query rules are case-insensitive.
   *  

   *  | Field            | Description                                |
   *  |------------------|--------------------------------------------|
   *  | directoryCustomerId, owner.directoryCustomerId | Filters by directory
   *  customer id. |
   *  | domain           | Filters by domain.                         |
   *  

Organizations may be queried by directoryCustomerId or by
domain, where the domain is a G Suite domain, for example:

Query directorycustomerid:123456789 returns Organization


resources with owner.directory_customer_id equal to 123456789.

Query domain:google.com returns Organization resources corresponding


to the domain google.com.
*/
// const query = 'abc123'
// Imports the Resourcemanager library
const {OrganizationsClient} = require('@google-cloud/resource-manager').v3;
// Instantiates a client
const resourcemanagerClient = new OrganizationsClient();
async function callSearchOrganizations() {
// Construct request
const request = {
};
// Run request
const iterable = await resourcemanagerClient.searchOrganizationsAsync(request);
for await (const response of iterable) {
  console.log(response);
}
}
callSearchOrganizations();

searchOrganizationsStream(request, options)

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

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
    ]>;

  /**
   * 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 {OrganizationsClient} = require('@google-cloud/resource-manager').v3;

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

  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;

tagHoldPath(tagValue, tagHold)

tagHoldPath(tagValue: string, tagHold: 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
    ]>;

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

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

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

  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;