Class protos.google.cloud.resourcemanager.v3.Projects (4.3.0)

Version latest

• 4.3.0 (latest)
• 4.2.1
• 4.1.3
• 3.2.0
• 3.1.0
• 3.0.0
• 2.0.1

Represents a Projects

Inheritance

$protobuf.rpc.Service > protos.google.cloud.resourcemanager.v3.Projects

Package

@google-cloud/resource-manager

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Projects service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Projects;

Creates new Projects service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
Type	Description
Projects	RPC service. Useful where requests and/or responses are streamed.

createProject(request, callback)

public createProject(request: google.cloud.resourcemanager.v3.ICreateProjectRequest, callback: google.cloud.resourcemanager.v3.Projects.CreateProjectCallback): void;

Calls CreateProject.

Parameters
Name	Description
request	ICreateProjectRequest CreateProjectRequest message or plain object
callback	google.cloud.resourcemanager.v3.Projects.CreateProjectCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createProject(request)

public createProject(request: google.cloud.resourcemanager.v3.ICreateProjectRequest): Promise<google.longrunning.Operation>;

Calls CreateProject.

Parameter
Name	Description
request	ICreateProjectRequest CreateProjectRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteProject(request, callback)

public deleteProject(request: google.cloud.resourcemanager.v3.IDeleteProjectRequest, callback: google.cloud.resourcemanager.v3.Projects.DeleteProjectCallback): void;

Calls DeleteProject.

Parameters
Name	Description
request	IDeleteProjectRequest DeleteProjectRequest message or plain object
callback	google.cloud.resourcemanager.v3.Projects.DeleteProjectCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteProject(request)

public deleteProject(request: google.cloud.resourcemanager.v3.IDeleteProjectRequest): Promise<google.longrunning.Operation>;

Calls DeleteProject.

Parameter
Name	Description
request	IDeleteProjectRequest DeleteProjectRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

getIamPolicy(request, callback)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest, callback: google.cloud.resourcemanager.v3.Projects.GetIamPolicyCallback): void;

Calls GetIamPolicy.

Parameters
Name	Description
request	IGetIamPolicyRequest GetIamPolicyRequest message or plain object
callback	google.cloud.resourcemanager.v3.Projects.GetIamPolicyCallback Node-style callback called with the error, if any, and Policy

Returns
Type	Description
void

getIamPolicy(request)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls GetIamPolicy.

Parameter
Name	Description
request	IGetIamPolicyRequest GetIamPolicyRequest message or plain object

Returns
Type	Description
Promise<google.iam.v1.Policy>	Promise

getProject(request, callback)

public getProject(request: google.cloud.resourcemanager.v3.IGetProjectRequest, callback: google.cloud.resourcemanager.v3.Projects.GetProjectCallback): void;

Calls GetProject.

Parameters
Name	Description
request	IGetProjectRequest GetProjectRequest message or plain object
callback	google.cloud.resourcemanager.v3.Projects.GetProjectCallback Node-style callback called with the error, if any, and Project

Returns
Type	Description
void

getProject(request)

public getProject(request: google.cloud.resourcemanager.v3.IGetProjectRequest): Promise<google.cloud.resourcemanager.v3.Project>;

Calls GetProject.

Parameter
Name	Description
request	IGetProjectRequest GetProjectRequest message or plain object

Returns
Type	Description
Promise<google.cloud.resourcemanager.v3.Project>	Promise

listProjects(request, callback)

public listProjects(request: google.cloud.resourcemanager.v3.IListProjectsRequest, callback: google.cloud.resourcemanager.v3.Projects.ListProjectsCallback): void;

Calls ListProjects.

Parameters
Name	Description
request	IListProjectsRequest ListProjectsRequest message or plain object
callback	google.cloud.resourcemanager.v3.Projects.ListProjectsCallback Node-style callback called with the error, if any, and ListProjectsResponse

Returns
Type	Description
void

listProjects(request)

public listProjects(request: google.cloud.resourcemanager.v3.IListProjectsRequest): Promise<google.cloud.resourcemanager.v3.ListProjectsResponse>;

Calls ListProjects.

Parameter
Name	Description
request	IListProjectsRequest ListProjectsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.resourcemanager.v3.ListProjectsResponse>	Promise

moveProject(request, callback)

public moveProject(request: google.cloud.resourcemanager.v3.IMoveProjectRequest, callback: google.cloud.resourcemanager.v3.Projects.MoveProjectCallback): void;

Calls MoveProject.

Parameters
Name	Description
request	IMoveProjectRequest MoveProjectRequest message or plain object
callback	google.cloud.resourcemanager.v3.Projects.MoveProjectCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

moveProject(request)

public moveProject(request: google.cloud.resourcemanager.v3.IMoveProjectRequest): Promise<google.longrunning.Operation>;

Calls MoveProject.

Parameter
Name	Description
request	IMoveProjectRequest MoveProjectRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

searchProjects(request, callback)

public searchProjects(request: google.cloud.resourcemanager.v3.ISearchProjectsRequest, callback: google.cloud.resourcemanager.v3.Projects.SearchProjectsCallback): void;

Calls SearchProjects.

Parameters
Name	Description
request	ISearchProjectsRequest SearchProjectsRequest message or plain object
callback	google.cloud.resourcemanager.v3.Projects.SearchProjectsCallback Node-style callback called with the error, if any, and SearchProjectsResponse

Returns
Type	Description
void

searchProjects(request)

public searchProjects(request: google.cloud.resourcemanager.v3.ISearchProjectsRequest): Promise<google.cloud.resourcemanager.v3.SearchProjectsResponse>;

Calls SearchProjects.

Parameter
Name	Description
request	ISearchProjectsRequest SearchProjectsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.resourcemanager.v3.SearchProjectsResponse>	Promise

setIamPolicy(request, callback)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest, callback: google.cloud.resourcemanager.v3.Projects.SetIamPolicyCallback): void;

Calls SetIamPolicy.

Parameters
Name	Description
request	ISetIamPolicyRequest SetIamPolicyRequest message or plain object
callback	google.cloud.resourcemanager.v3.Projects.SetIamPolicyCallback Node-style callback called with the error, if any, and Policy

Returns
Type	Description
void

setIamPolicy(request)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls SetIamPolicy.

Parameter
Name	Description
request	ISetIamPolicyRequest SetIamPolicyRequest message or plain object

Returns
Type	Description
Promise<google.iam.v1.Policy>	Promise

testIamPermissions(request, callback)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest, callback: google.cloud.resourcemanager.v3.Projects.TestIamPermissionsCallback): void;

Calls TestIamPermissions.

Parameters
Name	Description
request	google.iam.v1.ITestIamPermissionsRequest TestIamPermissionsRequest message or plain object
callback	google.cloud.resourcemanager.v3.Projects.TestIamPermissionsCallback Node-style callback called with the error, if any, and TestIamPermissionsResponse

Returns
Type	Description
void

testIamPermissions(request)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest): Promise<google.iam.v1.TestIamPermissionsResponse>;

Calls TestIamPermissions.

Parameter
Name	Description
request	google.iam.v1.ITestIamPermissionsRequest TestIamPermissionsRequest message or plain object

Returns
Type	Description
Promise<google.iam.v1.TestIamPermissionsResponse>	Promise

undeleteProject(request, callback)

public undeleteProject(request: google.cloud.resourcemanager.v3.IUndeleteProjectRequest, callback: google.cloud.resourcemanager.v3.Projects.UndeleteProjectCallback): void;

Calls UndeleteProject.

Parameters
Name	Description
request	IUndeleteProjectRequest UndeleteProjectRequest message or plain object
callback	google.cloud.resourcemanager.v3.Projects.UndeleteProjectCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

undeleteProject(request)

public undeleteProject(request: google.cloud.resourcemanager.v3.IUndeleteProjectRequest): Promise<google.longrunning.Operation>;

Calls UndeleteProject.

Parameter
Name	Description
request	IUndeleteProjectRequest UndeleteProjectRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

updateProject(request, callback)

public updateProject(request: google.cloud.resourcemanager.v3.IUpdateProjectRequest, callback: google.cloud.resourcemanager.v3.Projects.UpdateProjectCallback): void;

Calls UpdateProject.

Parameters
Name	Description
request	IUpdateProjectRequest UpdateProjectRequest message or plain object
callback	google.cloud.resourcemanager.v3.Projects.UpdateProjectCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateProject(request)

public updateProject(request: google.cloud.resourcemanager.v3.IUpdateProjectRequest): Promise<google.longrunning.Operation>;

Calls UpdateProject.

Parameter
Name	Description
request	IUpdateProjectRequest UpdateProjectRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise