Folders

google.cloud.resourcemanager.v3. Folders

Represents a Folders

Constructor

new Folders(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Folders 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

createFolder(request, callback) → {undefined}

Calls CreateFolder.

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

CreateFolderRequest message or plain object
callback google.cloud.resourcemanager.v3.Folders.CreateFolderCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

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

Calls CreateFolder.

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

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

Promise

deleteFolder(request, callback) → {undefined}

Calls DeleteFolder.

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

DeleteFolderRequest message or plain object
callback google.cloud.resourcemanager.v3.Folders.DeleteFolderCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

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

Calls DeleteFolder.

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

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

Promise

getFolder(request, callback) → {undefined}

Calls GetFolder.

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

GetFolderRequest message or plain object
callback google.cloud.resourcemanager.v3.Folders.GetFolderCallback

Node-style callback called with the error, if any, and Folder
Returns:
Type Description
undefined

getFolder(request) → {Promise.<google.cloud.resourcemanager.v3.Folder>}

Calls GetFolder.

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

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

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

listFolders(request, callback) → {undefined}

Calls ListFolders.

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

ListFoldersRequest message or plain object
callback google.cloud.resourcemanager.v3.Folders.ListFoldersCallback

Node-style callback called with the error, if any, and ListFoldersResponse
Returns:
Type Description
undefined

listFolders(request) → {Promise.<google.cloud.resourcemanager.v3.ListFoldersResponse>}

Calls ListFolders.

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

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

Promise

moveFolder(request, callback) → {undefined}

Calls MoveFolder.

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

MoveFolderRequest message or plain object
callback google.cloud.resourcemanager.v3.Folders.MoveFolderCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

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

Calls MoveFolder.

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

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

Promise

searchFolders(request, callback) → {undefined}

Calls SearchFolders.

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

SearchFoldersRequest message or plain object
callback google.cloud.resourcemanager.v3.Folders.SearchFoldersCallback

Node-style callback called with the error, if any, and SearchFoldersResponse
Returns:
Type Description
undefined

searchFolders(request) → {Promise.<google.cloud.resourcemanager.v3.SearchFoldersResponse>}

Calls SearchFolders.

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

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

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

undeleteFolder(request, callback) → {undefined}

Calls UndeleteFolder.

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

UndeleteFolderRequest message or plain object
callback google.cloud.resourcemanager.v3.Folders.UndeleteFolderCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

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

Calls UndeleteFolder.

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

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

Promise

updateFolder(request, callback) → {undefined}

Calls UpdateFolder.

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

UpdateFolderRequest message or plain object
callback google.cloud.resourcemanager.v3.Folders.UpdateFolderCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

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

Calls UpdateFolder.

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

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

Promise

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

Creates new Folders 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
Folders

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

Type Definitions

CreateFolderCallback(error, responseopt)

Callback as used by createFolder.

Parameters:
Name Type Attributes Description
error Error | null

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

Operation

DeleteFolderCallback(error, responseopt)

Callback as used by deleteFolder.

Parameters:
Name Type Attributes Description
error Error | null

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

Operation

GetFolderCallback(error, responseopt)

Callback as used by getFolder.

Parameters:
Name Type Attributes Description
error Error | null

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

Folder

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

ListFoldersCallback(error, responseopt)

Callback as used by listFolders.

Parameters:
Name Type Attributes Description
error Error | null

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

ListFoldersResponse

MoveFolderCallback(error, responseopt)

Callback as used by moveFolder.

Parameters:
Name Type Attributes Description
error Error | null

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

Operation

SearchFoldersCallback(error, responseopt)

Callback as used by searchFolders.

Parameters:
Name Type Attributes Description
error Error | null

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

SearchFoldersResponse

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

UndeleteFolderCallback(error, responseopt)

Callback as used by undeleteFolder.

Parameters:
Name Type Attributes Description
error Error | null

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

Operation

UpdateFolderCallback(error, responseopt)

Callback as used by updateFolder.

Parameters:
Name Type Attributes Description
error Error | null

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

Operation