Projects

google.cloud.resourcemanager.v3. Projects

Represents a Projects

Constructor

new Projects(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Projects service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

createProject(request, callback) → {undefined}

Calls CreateProject.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.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
undefined

createProject(request) → {Promise.<google.longrunning.Operation>}

Calls CreateProject.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.ICreateProjectRequest

CreateProjectRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

deleteProject(request, callback) → {undefined}

Calls DeleteProject.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.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
undefined

deleteProject(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteProject.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.IDeleteProjectRequest

DeleteProjectRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.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
undefined

getIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object
Returns:
Type Description
Promise.<google.iam.v1.Policy>

Promise

getProject(request, callback) → {undefined}

Calls GetProject.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.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
undefined

getProject(request) → {Promise.<google.cloud.resourcemanager.v3.Project>}

Calls GetProject.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.IGetProjectRequest

GetProjectRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.resourcemanager.v3.Project>

Promise

listProjects(request, callback) → {undefined}

Calls ListProjects.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.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
undefined

listProjects(request) → {Promise.<google.cloud.resourcemanager.v3.ListProjectsResponse>}

Calls ListProjects.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.IListProjectsRequest

ListProjectsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.resourcemanager.v3.ListProjectsResponse>

Promise

moveProject(request, callback) → {undefined}

Calls MoveProject.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.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
undefined

moveProject(request) → {Promise.<google.longrunning.Operation>}

Calls MoveProject.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.IMoveProjectRequest

MoveProjectRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

searchProjects(request, callback) → {undefined}

Calls SearchProjects.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.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
undefined

searchProjects(request) → {Promise.<google.cloud.resourcemanager.v3.SearchProjectsResponse>}

Calls SearchProjects.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.ISearchProjectsRequest

SearchProjectsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.resourcemanager.v3.SearchProjectsResponse>

Promise

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.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
undefined

setIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object
Returns:
Type Description
Promise.<google.iam.v1.Policy>

Promise

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:
Name Type 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
undefined

testIamPermissions(request) → {Promise.<google.iam.v1.TestIamPermissionsResponse>}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object
Returns:
Type Description
Promise.<google.iam.v1.TestIamPermissionsResponse>

Promise

undeleteProject(request, callback) → {undefined}

Calls UndeleteProject.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.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
undefined

undeleteProject(request) → {Promise.<google.longrunning.Operation>}

Calls UndeleteProject.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.IUndeleteProjectRequest

UndeleteProjectRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

updateProject(request, callback) → {undefined}

Calls UpdateProject.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.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
undefined

updateProject(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateProject.

Parameters:
Name Type Description
request google.cloud.resourcemanager.v3.IUpdateProjectRequest

UpdateProjectRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Projects}

Creates new Projects service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited
Returns:
Type Description
Projects

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateProjectCallback(error, responseopt)

Callback as used by createProject.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

DeleteProjectCallback(error, responseopt)

Callback as used by deleteProject.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

GetIamPolicyCallback(error, responseopt)

Callback as used by getIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.iam.v1.Policy <optional>

Policy

GetProjectCallback(error, responseopt)

Callback as used by getProject.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.resourcemanager.v3.Project <optional>

Project

ListProjectsCallback(error, responseopt)

Callback as used by listProjects.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.resourcemanager.v3.ListProjectsResponse <optional>

ListProjectsResponse

MoveProjectCallback(error, responseopt)

Callback as used by moveProject.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

SearchProjectsCallback(error, responseopt)

Callback as used by searchProjects.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.resourcemanager.v3.SearchProjectsResponse <optional>

SearchProjectsResponse

SetIamPolicyCallback(error, responseopt)

Callback as used by setIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.iam.v1.Policy <optional>

Policy

TestIamPermissionsCallback(error, responseopt)

Callback as used by testIamPermissions.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.iam.v1.TestIamPermissionsResponse <optional>

TestIamPermissionsResponse

UndeleteProjectCallback(error, responseopt)

Callback as used by undeleteProject.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

UpdateProjectCallback(error, responseopt)

Callback as used by updateProject.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation