Class protos.google.cloud.storagebatchoperations.v1.StorageBatchOperations (0.5.0)

Represents a StorageBatchOperations

Inheritance

$protobuf.rpc.Service > protos.google.cloud.storagebatchoperations.v1.StorageBatchOperations

Package

@google-cloud/storagebatchoperations

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new StorageBatchOperations service.

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

Methods

cancelJob(request, callback)

public cancelJob(request: google.cloud.storagebatchoperations.v1.ICancelJobRequest, callback: google.cloud.storagebatchoperations.v1.StorageBatchOperations.CancelJobCallback): void;

Calls CancelJob.

Parameters
Name	Description
request	ICancelJobRequest CancelJobRequest message or plain object
callback	CancelJobCallback Node-style callback called with the error, if any, and CancelJobResponse

Returns
Type	Description
void

cancelJob(request)

public cancelJob(request: google.cloud.storagebatchoperations.v1.ICancelJobRequest): Promise<google.cloud.storagebatchoperations.v1.CancelJobResponse>;

Calls CancelJob.

Parameter
Name	Description
request	ICancelJobRequest CancelJobRequest message or plain object

Returns
Type	Description
Promise<google.cloud.storagebatchoperations.v1.CancelJobResponse>	Promise

create(rpcImpl, requestDelimited, responseDelimited)

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

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

createJob(request, callback)

public createJob(request: google.cloud.storagebatchoperations.v1.ICreateJobRequest, callback: google.cloud.storagebatchoperations.v1.StorageBatchOperations.CreateJobCallback): void;

Calls CreateJob.

Parameters
Name	Description
request	ICreateJobRequest CreateJobRequest message or plain object
callback	CreateJobCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createJob(request)

public createJob(request: google.cloud.storagebatchoperations.v1.ICreateJobRequest): Promise<google.longrunning.Operation>;

Calls CreateJob.

Parameter
Name	Description
request	ICreateJobRequest CreateJobRequest message or plain object

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

deleteJob(request, callback)

public deleteJob(request: google.cloud.storagebatchoperations.v1.IDeleteJobRequest, callback: google.cloud.storagebatchoperations.v1.StorageBatchOperations.DeleteJobCallback): void;

Calls DeleteJob.

Parameters
Name	Description
request	IDeleteJobRequest DeleteJobRequest message or plain object
callback	DeleteJobCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deleteJob(request)

public deleteJob(request: google.cloud.storagebatchoperations.v1.IDeleteJobRequest): Promise<google.protobuf.Empty>;

Calls DeleteJob.

Parameter
Name	Description
request	IDeleteJobRequest DeleteJobRequest message or plain object

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

getBucketOperation(request, callback)

public getBucketOperation(request: google.cloud.storagebatchoperations.v1.IGetBucketOperationRequest, callback: google.cloud.storagebatchoperations.v1.StorageBatchOperations.GetBucketOperationCallback): void;

Calls GetBucketOperation.

Parameters
Name	Description
request	IGetBucketOperationRequest GetBucketOperationRequest message or plain object
callback	GetBucketOperationCallback Node-style callback called with the error, if any, and BucketOperation

Returns
Type	Description
void

getBucketOperation(request)

public getBucketOperation(request: google.cloud.storagebatchoperations.v1.IGetBucketOperationRequest): Promise<google.cloud.storagebatchoperations.v1.BucketOperation>;

Calls GetBucketOperation.

Parameter
Name	Description
request	IGetBucketOperationRequest GetBucketOperationRequest message or plain object

Returns
Type	Description
Promise<google.cloud.storagebatchoperations.v1.BucketOperation>	Promise

getJob(request, callback)

public getJob(request: google.cloud.storagebatchoperations.v1.IGetJobRequest, callback: google.cloud.storagebatchoperations.v1.StorageBatchOperations.GetJobCallback): void;

Calls GetJob.

Parameters
Name	Description
request	IGetJobRequest GetJobRequest message or plain object
callback	GetJobCallback Node-style callback called with the error, if any, and Job

Returns
Type	Description
void

getJob(request)

public getJob(request: google.cloud.storagebatchoperations.v1.IGetJobRequest): Promise<google.cloud.storagebatchoperations.v1.Job>;

Calls GetJob.

Parameter
Name	Description
request	IGetJobRequest GetJobRequest message or plain object

Returns
Type	Description
Promise<google.cloud.storagebatchoperations.v1.Job>	Promise

listBucketOperations(request, callback)

public listBucketOperations(request: google.cloud.storagebatchoperations.v1.IListBucketOperationsRequest, callback: google.cloud.storagebatchoperations.v1.StorageBatchOperations.ListBucketOperationsCallback): void;

Calls ListBucketOperations.

Parameters
Name	Description
request	IListBucketOperationsRequest ListBucketOperationsRequest message or plain object
callback	ListBucketOperationsCallback Node-style callback called with the error, if any, and ListBucketOperationsResponse

Returns
Type	Description
void

listBucketOperations(request)

public listBucketOperations(request: google.cloud.storagebatchoperations.v1.IListBucketOperationsRequest): Promise<google.cloud.storagebatchoperations.v1.ListBucketOperationsResponse>;

Calls ListBucketOperations.

Parameter
Name	Description
request	IListBucketOperationsRequest ListBucketOperationsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.storagebatchoperations.v1.ListBucketOperationsResponse>	Promise

listJobs(request, callback)

public listJobs(request: google.cloud.storagebatchoperations.v1.IListJobsRequest, callback: google.cloud.storagebatchoperations.v1.StorageBatchOperations.ListJobsCallback): void;

Calls ListJobs.

Parameters
Name	Description
request	IListJobsRequest ListJobsRequest message or plain object
callback	ListJobsCallback Node-style callback called with the error, if any, and ListJobsResponse

Returns
Type	Description
void

listJobs(request)

public listJobs(request: google.cloud.storagebatchoperations.v1.IListJobsRequest): Promise<google.cloud.storagebatchoperations.v1.ListJobsResponse>;

Calls ListJobs.

Parameter
Name	Description
request	IListJobsRequest ListJobsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.storagebatchoperations.v1.ListJobsResponse>	Promise