Class protos.google.storage.control.v2.StorageControl (0.1.1)

Version latest

• 0.1.1 (latest)
• 0.1.0

Represents a StorageControl

Inheritance

$protobuf.rpc.Service > protos.google.storage.control.v2.StorageControl

Package

@google-cloud/storage-control

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

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

Creates new StorageControl 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
StorageControl	RPC service. Useful where requests and/or responses are streamed.

createFolder(request, callback)

public createFolder(request: google.storage.control.v2.ICreateFolderRequest, callback: google.storage.control.v2.StorageControl.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 Folder

Returns
Type	Description
void

createFolder(request)

public createFolder(request: google.storage.control.v2.ICreateFolderRequest): Promise<google.storage.control.v2.Folder>;

Calls CreateFolder.

Parameter
Name	Description
request	ICreateFolderRequest CreateFolderRequest message or plain object

Returns
Type	Description
Promise<google.storage.control.v2.Folder>	Promise

createManagedFolder(request, callback)

public createManagedFolder(request: google.storage.control.v2.ICreateManagedFolderRequest, callback: google.storage.control.v2.StorageControl.CreateManagedFolderCallback): void;

Calls CreateManagedFolder.

Parameters
Name	Description
request	ICreateManagedFolderRequest CreateManagedFolderRequest message or plain object
callback	CreateManagedFolderCallback Node-style callback called with the error, if any, and ManagedFolder

Returns
Type	Description
void

createManagedFolder(request)

public createManagedFolder(request: google.storage.control.v2.ICreateManagedFolderRequest): Promise<google.storage.control.v2.ManagedFolder>;

Calls CreateManagedFolder.

Parameter
Name	Description
request	ICreateManagedFolderRequest CreateManagedFolderRequest message or plain object

Returns
Type	Description
Promise<google.storage.control.v2.ManagedFolder>	Promise

deleteFolder(request, callback)

public deleteFolder(request: google.storage.control.v2.IDeleteFolderRequest, callback: google.storage.control.v2.StorageControl.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 Empty

Returns
Type	Description
void

deleteFolder(request)

public deleteFolder(request: google.storage.control.v2.IDeleteFolderRequest): Promise<google.protobuf.Empty>;

Calls DeleteFolder.

Parameter
Name	Description
request	IDeleteFolderRequest DeleteFolderRequest message or plain object

Returns
Type	Description
Promise<google.protobuf.Empty>	Promise

deleteManagedFolder(request, callback)

public deleteManagedFolder(request: google.storage.control.v2.IDeleteManagedFolderRequest, callback: google.storage.control.v2.StorageControl.DeleteManagedFolderCallback): void;

Calls DeleteManagedFolder.

Parameters
Name	Description
request	IDeleteManagedFolderRequest DeleteManagedFolderRequest message or plain object
callback	DeleteManagedFolderCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deleteManagedFolder(request)

public deleteManagedFolder(request: google.storage.control.v2.IDeleteManagedFolderRequest): Promise<google.protobuf.Empty>;

Calls DeleteManagedFolder.

Parameter
Name	Description
request	IDeleteManagedFolderRequest DeleteManagedFolderRequest message or plain object

Returns
Type	Description
Promise<google.protobuf.Empty>	Promise

getFolder(request, callback)

public getFolder(request: google.storage.control.v2.IGetFolderRequest, callback: google.storage.control.v2.StorageControl.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.storage.control.v2.IGetFolderRequest): Promise<google.storage.control.v2.Folder>;

Calls GetFolder.

Parameter
Name	Description
request	IGetFolderRequest GetFolderRequest message or plain object

Returns
Type	Description
Promise<google.storage.control.v2.Folder>	Promise

getManagedFolder(request, callback)

public getManagedFolder(request: google.storage.control.v2.IGetManagedFolderRequest, callback: google.storage.control.v2.StorageControl.GetManagedFolderCallback): void;

Calls GetManagedFolder.

Parameters
Name	Description
request	IGetManagedFolderRequest GetManagedFolderRequest message or plain object
callback	GetManagedFolderCallback Node-style callback called with the error, if any, and ManagedFolder

Returns
Type	Description
void

getManagedFolder(request)

public getManagedFolder(request: google.storage.control.v2.IGetManagedFolderRequest): Promise<google.storage.control.v2.ManagedFolder>;

Calls GetManagedFolder.

Parameter
Name	Description
request	IGetManagedFolderRequest GetManagedFolderRequest message or plain object

Returns
Type	Description
Promise<google.storage.control.v2.ManagedFolder>	Promise

getStorageLayout(request, callback)

public getStorageLayout(request: google.storage.control.v2.IGetStorageLayoutRequest, callback: google.storage.control.v2.StorageControl.GetStorageLayoutCallback): void;

Calls GetStorageLayout.

Parameters
Name	Description
request	IGetStorageLayoutRequest GetStorageLayoutRequest message or plain object
callback	GetStorageLayoutCallback Node-style callback called with the error, if any, and StorageLayout

Returns
Type	Description
void

getStorageLayout(request)

public getStorageLayout(request: google.storage.control.v2.IGetStorageLayoutRequest): Promise<google.storage.control.v2.StorageLayout>;

Calls GetStorageLayout.

Parameter
Name	Description
request	IGetStorageLayoutRequest GetStorageLayoutRequest message or plain object

Returns
Type	Description
Promise<google.storage.control.v2.StorageLayout>	Promise

listFolders(request, callback)

public listFolders(request: google.storage.control.v2.IListFoldersRequest, callback: google.storage.control.v2.StorageControl.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.storage.control.v2.IListFoldersRequest): Promise<google.storage.control.v2.ListFoldersResponse>;

Calls ListFolders.

Parameter
Name	Description
request	IListFoldersRequest ListFoldersRequest message or plain object

Returns
Type	Description
Promise<google.storage.control.v2.ListFoldersResponse>	Promise

listManagedFolders(request, callback)

public listManagedFolders(request: google.storage.control.v2.IListManagedFoldersRequest, callback: google.storage.control.v2.StorageControl.ListManagedFoldersCallback): void;

Calls ListManagedFolders.

Parameters
Name	Description
request	IListManagedFoldersRequest ListManagedFoldersRequest message or plain object
callback	ListManagedFoldersCallback Node-style callback called with the error, if any, and ListManagedFoldersResponse

Returns
Type	Description
void

listManagedFolders(request)

public listManagedFolders(request: google.storage.control.v2.IListManagedFoldersRequest): Promise<google.storage.control.v2.ListManagedFoldersResponse>;

Calls ListManagedFolders.

Parameter
Name	Description
request	IListManagedFoldersRequest ListManagedFoldersRequest message or plain object

Returns
Type	Description
Promise<google.storage.control.v2.ListManagedFoldersResponse>	Promise

renameFolder(request, callback)

public renameFolder(request: google.storage.control.v2.IRenameFolderRequest, callback: google.storage.control.v2.StorageControl.RenameFolderCallback): void;

Calls RenameFolder.

Parameters
Name	Description
request	IRenameFolderRequest RenameFolderRequest message or plain object
callback	RenameFolderCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

renameFolder(request)

public renameFolder(request: google.storage.control.v2.IRenameFolderRequest): Promise<google.longrunning.Operation>;

Calls RenameFolder.

Parameter
Name	Description
request	IRenameFolderRequest RenameFolderRequest message or plain object

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