Constructor
new ProjectsClient(optionsopt)
Construct an instance of ProjectsClient.
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
|
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) 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 |
|
Example
/**
* 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 Organziation, 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 |
|
Example
/**
* 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 |
|
Example
/**
* 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 |
|
Example
/**
* 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 |
|
Example
/**
* 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. |
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. |
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
|
|||||||||||||||||||||
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 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
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource to list projects under.
* For example, setting this field to 'folders/1234' would list all projects
* directly under that folder.
*/
// 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
|
|||||||||||||||||||||
options |
object |
<optional> |
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 |
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. |
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
|
|||||||||||||||||
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 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
/**
* 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, the 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` and 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
|
|||||||||||||||||
options |
object |
<optional> |
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 |
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. |