ProjectsClient - Documentation

Constructor

new ProjectsClient(optionsopt, gaxInstanceopt)

Construct an instance of ProjectsClient.

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

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

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 ProjectsClient({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

cancelOperation(request, optionsopt, callbackopt) → {Promise}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource to be cancelled.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

Returns:

Type	Description
Promise	The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

(async) checkCreateProjectProgress(name) → {Promise}

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

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

  /**
   * 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 Project to create.
   *  Project ID is required. If the requested ID is unavailable, the request
   *  fails.
   *  If the `parent` field is set, the `resourcemanager.projects.create`
   *  permission is checked on the parent resource. If no parent is set and
   *  the authorization credentials belong to an Organization, the parent
   *  will be set to that Organization.
   */
  // const project = 'my-project'

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

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

  async function callCreateProject() {
    // Construct request
    const request = {
      project,
    };

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

  callCreateProject();

(async) checkDeleteProjectProgress(name) → {Promise}

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

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

  /**
   * 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 name of the Project (for example, `projects/415104041262`).
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteProject();

(async) checkMoveProjectProgress(name) → {Promise}

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

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

  /**
   * 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 name of the project to move.
   */
  // const name = 'abc123'
  /**
   *  Required. The new parent to move the Project under.
   */
  // const destinationParent = 'abc123'

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

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

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

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

  callMoveProject();

(async) checkUndeleteProjectProgress(name) → {Promise}

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

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

  /**
   * 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 name of the project (for example, `projects/415104041262`).
   *  Required.
   */
  // const name = 'abc123'

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

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

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

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

  callUndeleteProject();

(async) checkUpdateProjectProgress(name) → {Promise}

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

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

  /**
   * 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 new definition of the project.
   */
  // const project = 'my-project'
  /**
   *  Optional. An update mask to selectively update fields.
   */
  // const updateMask = {}

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

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

  async function callUpdateProject() {
    // Construct request
    const request = {
      project,
    };

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

  callUpdateProject();

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.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource to be deleted.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

Returns:

Type	Description
Promise	The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

folderPath(folder) → {string}

Return a fully-qualified folder resource name string.

Parameters:

Name	Type	Description
`folder`	string

Returns:

Type	Description
string	Resource name string.

getOperation(request, optionsopt, callbackopt) → {Promise}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing google.longrunning.Operation.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.

Example

```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

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.

listOperationsAsync(request, optionsopt) → {Object}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`name`	string		The name of the operation collection.
`filter`	string		The standard list filter.
`pageSize`	number	<optional>	The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns:

Type	Description
Object	An iterable Object that conforms to iteration protocols.

Example

```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

listProjectsAsync(request, optionsopt) → {Object}

Equivalent to listProjects, 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 name of the parent resource whose projects are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value `folders/{folder_id}`. If the parent is an organization, use the value `organizations/{org_id}`.
`pageToken`	string	<optional>	Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.
`pageSize`	number	<optional>	Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.
`showDeleted`	boolean	<optional>	Optional. Indicate that projects in the `DELETE_REQUESTED` state should also be returned. Normally only `ACTIVE` projects are returned.

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 Project. 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.
   */
  /**
   *  Required. The name of the parent resource whose projects are being listed.
   *  Only children of this parent resource are listed; descendants are not
   *  listed.
   *  If the parent is a folder, use the value `folders/{folder_id}`. If the
   *  parent is an organization, use the value `organizations/{org_id}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. A pagination token returned from a previous call to
   *  ListProjects  google.cloud.resourcemanager.v3.Projects.ListProjects  that
   *  indicates from where listing should continue.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The maximum number of projects to return in the response.
   *  The server can return fewer projects than requested.
   *  If unspecified, server picks an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. Indicate that projects in the `DELETE_REQUESTED` state should
   *  also be returned. Normally only `ACTIVE` projects are returned.
   */
  // const showDeleted = true

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

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

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

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

  callListProjects();

listProjectsStream(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 name of the parent resource whose projects are being listed. Only children of this parent resource are listed; descendants are not listed. If the parent is a folder, use the value `folders/{folder_id}`. If the parent is an organization, use the value `organizations/{org_id}`.
`pageToken`	string	<optional>	Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.
`pageSize`	number	<optional>	Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.
`showDeleted`	boolean	<optional>	Optional. Indicate that projects in the `DELETE_REQUESTED` state should also be returned. Normally only `ACTIVE` projects are returned.

options

object

Call options. See CallOptions for more details.

Returns:

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

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.

searchProjectsAsync(request, optionsopt) → {Object}

Equivalent to searchProjects, 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

query

string

Optional. A query string for searching for projects that the caller has resourcemanager.projects.get permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are:

| Field                   | Description                                  |
|-------------------------|----------------------------------------------|
| displayName, name       | Filters by displayName.                      |
| parent                  | Project's parent (for example: folders/123,
organizations/*). Prefer parent field over parent.type and parent.id.| |
parent.type             | Parent's type: `folder` or `organization`.   | |
parent.id               | Parent's id number (for example: 123)        | |
id, projectId           | Filters by projectId.                        | |
state, lifecycleState   | Filters by state.                            | |
labels                  | Filters by label name or value.              | |
labels.\<key\> (where *key* is the name of a label) | Filters by label
name.|

Search expressions are case insensitive.

Some examples queries:

| Query            | Description                                         |
|------------------|-----------------------------------------------------|
| name:how*        | The project's name starts with "how".               |
| name:Howl        | The project's name is `Howl` or `howl`.             |
| name:HOWL        | Equivalent to above.                                |
| NAME:howl        | Equivalent to above.                                |
| labels.color:*   | The project has the label `color`.                  |
| labels.color:red | The project's label `color` has the value `red`.    |
| labels.color:red labels.size:big | The project's label `color` has the
value `red` or its label `size` has the value `big`.                     |

If no query is specified, the call will return projects for which the user has the resourcemanager.projects.get permission.

pageToken

string

Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.

pageSize

number

Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.

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 Project. 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. A query string for searching for projects that the caller has
   *  `resourcemanager.projects.get` permission to. If multiple fields are
   *  included in the query, then it will return results that match any of the
   *  fields. Some eligible fields are:
   *  ```
   *  | Field                   | Description                                  |
   *  |-------------------------|----------------------------------------------|
   *  | displayName, name       | Filters by displayName.                      |
   *  | parent                  | Project's parent (for example: folders/123,
   *  organizations/*). Prefer parent field over parent.type and parent.id.| |
   *  parent.type             | Parent's type: `folder` or `organization`.   | |
   *  parent.id               | Parent's id number (for example: 123)        | |
   *  id, projectId           | Filters by projectId.                        | |
   *  state, lifecycleState   | Filters by state.                            | |
   *  labels                  | Filters by label name or value.              | |
   *  labels.\<key\> (where *key* is the name of a label) | Filters by label
   *  name.|
   *  ```
   *  Search expressions are case insensitive.
   *  Some examples queries:
   *  ```
   *  | Query            | Description                                         |
   *  |------------------|-----------------------------------------------------|
   *  | name:how*        | The project's name starts with "how".               |
   *  | name:Howl        | The project's name is `Howl` or `howl`.             |
   *  | name:HOWL        | Equivalent to above.                                |
   *  | NAME:howl        | Equivalent to above.                                |
   *  | labels.color:*   | The project has the label `color`.                  |
   *  | labels.color:red | The project's label `color` has the value `red`.    |
   *  | labels.color:red labels.size:big | The project's label `color` has the
   *  value `red` or its label `size` has the value `big`.                     |
   *  ```
   *  If no query is specified, the call will return projects for which the user
   *  has the `resourcemanager.projects.get` permission.
   */
  // const query = 'abc123'
  /**
   *  Optional. A pagination token returned from a previous call to
   *  ListProjects  google.cloud.resourcemanager.v3.Projects.ListProjects  that
   *  indicates from where listing should continue.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The maximum number of projects to return in the response.
   *  The server can return fewer projects than requested.
   *  If unspecified, server picks an appropriate default.
   */
  // const pageSize = 1234

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

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

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

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

  callSearchProjects();

searchProjectsStream(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

query

string

| Field                   | Description                                  |
|-------------------------|----------------------------------------------|
| displayName, name       | Filters by displayName.                      |
| parent                  | Project's parent (for example: folders/123,
organizations/*). Prefer parent field over parent.type and parent.id.| |
parent.type             | Parent's type: `folder` or `organization`.   | |
parent.id               | Parent's id number (for example: 123)        | |
id, projectId           | Filters by projectId.                        | |
state, lifecycleState   | Filters by state.                            | |
labels                  | Filters by label name or value.              | |
labels.\<key\> (where *key* is the name of a label) | Filters by label
name.|

Search expressions are case insensitive.

Some examples queries:

| Query            | Description                                         |
|------------------|-----------------------------------------------------|
| name:how*        | The project's name starts with "how".               |
| name:Howl        | The project's name is `Howl` or `howl`.             |
| name:HOWL        | Equivalent to above.                                |
| NAME:howl        | Equivalent to above.                                |
| labels.color:*   | The project has the label `color`.                  |
| labels.color:red | The project's label `color` has the value `red`.    |
| labels.color:red labels.size:big | The project's label `color` has the
value `red` or its label `size` has the value `big`.                     |

If no query is specified, the call will return projects for which the user has the resourcemanager.projects.get permission.

pageToken

string

Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.

pageSize

number

Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.

options

object

Call options. See CallOptions for more details.

Returns:

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