Class protos.google.cloud.resourcemanager.v3.Folders (6.1.0)

Represents a Folders

Inheritance

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

Package

@google-cloud/resource-manager

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

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

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

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

createFolder(request, callback)

public createFolder(request: google.cloud.resourcemanager.v3.ICreateFolderRequest, callback: google.cloud.resourcemanager.v3.Folders.CreateFolderCallback): void;

Calls CreateFolder.

Parameters
Name Description
request ICreateFolderRequest

CreateFolderRequest message or plain object
callback CreateFolderCallback

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

createFolder(request)

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

Calls CreateFolder.

Parameter
Name Description
request ICreateFolderRequest

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

Promise

deleteFolder(request, callback)

public deleteFolder(request: google.cloud.resourcemanager.v3.IDeleteFolderRequest, callback: google.cloud.resourcemanager.v3.Folders.DeleteFolderCallback): void;

Calls DeleteFolder.

Parameters
Name Description
request IDeleteFolderRequest

DeleteFolderRequest message or plain object
callback DeleteFolderCallback

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

deleteFolder(request)

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

Calls DeleteFolder.

Parameter
Name Description
request IDeleteFolderRequest

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

Promise

getFolder(request, callback)

public getFolder(request: google.cloud.resourcemanager.v3.IGetFolderRequest, callback: google.cloud.resourcemanager.v3.Folders.GetFolderCallback): void;

Calls GetFolder.

Parameters
Name Description
request IGetFolderRequest

GetFolderRequest message or plain object
callback GetFolderCallback

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

getFolder(request)

public getFolder(request: google.cloud.resourcemanager.v3.IGetFolderRequest): Promise<google.cloud.resourcemanager.v3.Folder>;

Calls GetFolder.

Parameter
Name Description
request IGetFolderRequest

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

Promise

getIamPolicy(request, callback)

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

Calls GetIamPolicy.

Parameters
Name Description
request IGetIamPolicyRequest

GetIamPolicyRequest message or plain object
callback 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

listFolders(request, callback)

public listFolders(request: google.cloud.resourcemanager.v3.IListFoldersRequest, callback: google.cloud.resourcemanager.v3.Folders.ListFoldersCallback): void;

Calls ListFolders.

Parameters
Name Description
request IListFoldersRequest

ListFoldersRequest message or plain object
callback ListFoldersCallback

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

listFolders(request)

public listFolders(request: google.cloud.resourcemanager.v3.IListFoldersRequest): Promise<google.cloud.resourcemanager.v3.ListFoldersResponse>;

Calls ListFolders.

Parameter
Name Description
request IListFoldersRequest

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

Promise

moveFolder(request, callback)

public moveFolder(request: google.cloud.resourcemanager.v3.IMoveFolderRequest, callback: google.cloud.resourcemanager.v3.Folders.MoveFolderCallback): void;

Calls MoveFolder.

Parameters
Name Description
request IMoveFolderRequest

MoveFolderRequest message or plain object
callback MoveFolderCallback

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

moveFolder(request)

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

Calls MoveFolder.

Parameter
Name Description
request IMoveFolderRequest

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

Promise

searchFolders(request, callback)

public searchFolders(request: google.cloud.resourcemanager.v3.ISearchFoldersRequest, callback: google.cloud.resourcemanager.v3.Folders.SearchFoldersCallback): void;

Calls SearchFolders.

Parameters
Name Description
request ISearchFoldersRequest

SearchFoldersRequest message or plain object
callback SearchFoldersCallback

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

searchFolders(request)

public searchFolders(request: google.cloud.resourcemanager.v3.ISearchFoldersRequest): Promise<google.cloud.resourcemanager.v3.SearchFoldersResponse>;

Calls SearchFolders.

Parameter
Name Description
request ISearchFoldersRequest

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

Promise

setIamPolicy(request, callback)

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

Calls SetIamPolicy.

Parameters
Name Description
request ISetIamPolicyRequest

SetIamPolicyRequest message or plain object
callback 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.Folders.TestIamPermissionsCallback): void;

Calls TestIamPermissions.

Parameters
Name Description
request ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object
callback 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 ITestIamPermissionsRequest

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

Promise

undeleteFolder(request, callback)

public undeleteFolder(request: google.cloud.resourcemanager.v3.IUndeleteFolderRequest, callback: google.cloud.resourcemanager.v3.Folders.UndeleteFolderCallback): void;

Calls UndeleteFolder.

Parameters
Name Description
request IUndeleteFolderRequest

UndeleteFolderRequest message or plain object
callback UndeleteFolderCallback

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

undeleteFolder(request)

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

Calls UndeleteFolder.

Parameter
Name Description
request IUndeleteFolderRequest

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

Promise

updateFolder(request, callback)

public updateFolder(request: google.cloud.resourcemanager.v3.IUpdateFolderRequest, callback: google.cloud.resourcemanager.v3.Folders.UpdateFolderCallback): void;

Calls UpdateFolder.

Parameters
Name Description
request IUpdateFolderRequest

UpdateFolderRequest message or plain object
callback UpdateFolderCallback

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

updateFolder(request)

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

Calls UpdateFolder.

Parameter
Name Description
request IUpdateFolderRequest

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

Promise