OrganizationsClient

OrganizationsClient

Allows users to manage their organization resources.

Constructor

new OrganizationsClient(optionsopt, gaxInstanceopt)

Construct an instance of OrganizationsClient.

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 | "rest" <optional>

Use HTTP fallback mode. Pass "rest" to use HTTP/1.1 REST API instead of gRPC. For more information, please check the documentation.

gaxInstance gax <optional>

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 OrganizationsClient({fallback: 'rest'}, gax);

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

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.

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.

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.

matchTagHoldFromTagHoldName(tagHoldName) → {string}

Parse the tag_hold from TagHold resource.

Parameters:
Name Type Description
tagHoldName string

A fully-qualified path representing TagHold resource.

Returns:
Type Description
string

A string representing the tag_hold.

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.

matchTagValueFromTagHoldName(tagHoldName) → {string}

Parse the tag_value from TagHold resource.

Parameters:
Name Type Description
tagHoldName string

A fully-qualified path representing TagHold resource.

Returns:
Type Description
string

A string representing the tag_value.

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.

searchOrganizationsAsync(request, optionsopt) → {Object}

Equivalent to searchOrganizations, 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
pageSize number <optional>

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.

pageToken string <optional>

Optional. A pagination token returned from a previous call to SearchOrganizations that indicates from where listing should continue.

query string <optional>

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.
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 Organization. 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.
   */
  /**
   *  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, 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
pageSize number <optional>

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.

pageToken string <optional>

Optional. A pagination token returned from a previous call to SearchOrganizations that indicates from where listing should continue.

query string <optional>

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

Call options. See CallOptions for more details.

Returns:
Type Description
Stream

An object stream which emits an object representing Organization 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 searchOrganizationsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

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.

tagHoldPath(tag_value, tag_hold) → {string}

Return a fully-qualified tagHold resource name string.

Parameters:
Name Type Description
tag_value string
tag_hold 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.