FoldersClient - Documentation

Constructor

new FoldersClient(optionsopt)

Construct an instance of FoldersClient.

Parameters:

Name Type Attributes Description

options

object

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

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

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

The port on which to connect to the remote host.

projectId

string

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

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

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) checkCreateFolderProgress(name) → {Promise}

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

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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The folder being created, only the display name and parent will be
   *  consulted. All other fields will be ignored.
   */
  // const folder = {}

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

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

  async function callCreateFolder() {
    // Construct request
    const request = {
      folder,
    };

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

  callCreateFolder();

(async) checkDeleteFolderProgress(name) → {Promise}

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

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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the folder to be deleted.
   *  Must be of the form `folders/{folder_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteFolder();

(async) checkMoveFolderProgress(name) → {Promise}

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

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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the Folder to move.
   *  Must be of the form folders/{folder_id}
   */
  // const name = 'abc123'
  /**
   *  Required. The resource name of the folder or organization which should be the
   *  folder's new parent.
   *  Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
   */
  // const destinationParent = 'abc123'

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

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

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

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

  callMoveFolder();

(async) checkUndeleteFolderProgress(name) → {Promise}

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

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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the folder to undelete.
   *  Must be of the form `folders/{folder_id}`.
   */
  // const name = 'abc123'

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

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

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

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

  callUndeleteFolder();

(async) checkUpdateFolderProgress(name) → {Promise}

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

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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The new definition of the Folder. It must include the `name` field, which
   *  cannot be changed.
   */
  // const folder = {}
  /**
   *  Required. Fields to be updated.
   *  Only the `display_name` can be updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateFolder() {
    // Construct request
    const request = {
      folder,
      updateMask,
    };

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

  callUpdateFolder();

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.

listFoldersAsync(request, optionsopt) → {Object}

Equivalent to listFolders, 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 resource name of the organization or folder whose folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`.
`pageSize`	number	<optional>	Optional. The maximum number of folders to return in the response. If unspecified, server picks an appropriate default.
`pageToken`	string	<optional>	Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from.
`showDeleted`	boolean	<optional>	Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.

options

object

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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the organization or folder whose folders are
   *  being listed.
   *  Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
   *  Access to this method is controlled by checking the
   *  `resourcemanager.folders.list` permission on the `parent`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of folders to return in the response.
   *  If unspecified, server picks an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A pagination token returned from a previous call to `ListFolders`
   *  that indicates where this listing should continue from.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Controls whether folders in the
   *  DELETE_REQUESTED google.cloud.resourcemanager.v3.Folder.State.DELETE_REQUESTED 
   *  state should be returned. Defaults to false.
   */
  // const showDeleted = true

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

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

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

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

  callListFolders();

listFoldersStream(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 resource name of the organization or folder whose folders are being listed. Must be of the form `folders/{folder_id}` or `organizations/{org_id}`. Access to this method is controlled by checking the `resourcemanager.folders.list` permission on the `parent`.
`pageSize`	number	<optional>	Optional. The maximum number of folders to return in the response. If unspecified, server picks an appropriate default.
`pageToken`	string	<optional>	Optional. A pagination token returned from a previous call to `ListFolders` that indicates where this listing should continue from.
`showDeleted`	boolean	<optional>	Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Folder 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 `listFoldersAsync()` 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.

searchFoldersAsync(request, optionsopt) → {Object}

Equivalent to searchFolders, 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. The maximum number of folders to return in the response. If unspecified, server picks an appropriate default.

pageToken

string

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

query

string

Optional. Search criteria used to select the folders to return. If no search criteria is specified then all accessible folders will be returned.

Query expressions can be used to restrict results based upon displayName, state and parent, where the operators = (:) NOT, AND and OR can be used along with the suffix wildcard symbol *.

The displayName field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior.

| Field                   | Description                            |
|-------------------------|----------------------------------------|
| displayName             | Filters by displayName.                |
| parent                  | Filters by parent (for example: folders/123). |
| state, lifecycleState   | Filters by state.                      |

Some example queries are:

Query displayName=Test* returns Folder resources whose display name starts with "Test".
Query state=ACTIVE returns Folder resources with state set to ACTIVE.
Query parent=folders/123 returns Folder resources that have folders/123 as a parent resource.
Query parent=folders/123 AND state=ACTIVE returns active Folder resources that have folders/123 as a parent resource.
Query displayName=\\"Test String\\" returns Folder resources with display names that include both "Test" and "String".

options

object

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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Optional. The maximum number of folders to return in the response.
   *  If unspecified, server picks an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. A pagination token returned from a previous call to `SearchFolders`
   *  that indicates from where search should continue.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Search criteria used to select the folders to return.
   *  If no search criteria is specified then all accessible folders will be
   *  returned.
   *  Query expressions can be used to restrict results based upon displayName,
   *  state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR`
   *  can be used along with the suffix wildcard symbol `*`.
   *  The `displayName` field in a query expression should use escaped quotes
   *  for values that include whitespace to prevent unexpected behavior.
   *  ```
   *  | Field                   | Description                            |
   *  |-------------------------|----------------------------------------|
   *  | displayName             | Filters by displayName.                |
   *  | parent                  | Filters by parent (for example: folders/123). |
   *  | state, lifecycleState   | Filters by state.                      |
   *  ```
   *  Some example queries are:
   *  * Query `displayName=Test*` returns Folder resources whose display name
   *  starts with "Test".
   *  * Query `state=ACTIVE` returns Folder resources with
   *  `state` set to `ACTIVE`.
   *  * Query `parent=folders/123` returns Folder resources that have
   *  `folders/123` as a parent resource.
   *  * Query `parent=folders/123 AND state=ACTIVE` returns active
   *  Folder resources that have `folders/123` as a parent resource.
   *  * Query `displayName=\\"Test String\\"` returns Folder resources with
   *  display names that include both "Test" and "String".
   */
  // const query = 'abc123'

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

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

  async function callSearchFolders() {
    // Construct request
    const request = {
    };

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

  callSearchFolders();

searchFoldersStream(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. The maximum number of folders to return in the response. If unspecified, server picks an appropriate default.

pageToken

string

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

query

string

Optional. Search criteria used to select the folders to return. If no search criteria is specified then all accessible folders will be returned.

Query expressions can be used to restrict results based upon displayName, state and parent, where the operators = (:) NOT, AND and OR can be used along with the suffix wildcard symbol *.

The displayName field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior.

| Field                   | Description                            |
|-------------------------|----------------------------------------|
| displayName             | Filters by displayName.                |
| parent                  | Filters by parent (for example: folders/123). |
| state, lifecycleState   | Filters by state.                      |

Some example queries are:

Query displayName=Test* returns Folder resources whose display name starts with "Test".
Query state=ACTIVE returns Folder resources with state set to ACTIVE.
Query parent=folders/123 returns Folder resources that have folders/123 as a parent resource.
Query parent=folders/123 AND state=ACTIVE returns active Folder resources that have folders/123 as a parent resource.
Query displayName=\\"Test String\\" returns Folder resources with display names that include both "Test" and "String".

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Folder 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 `searchFoldersAsync()` 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.

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.