Class protos.google.storagetransfer.v1.StorageTransferService (1.0.1)

Represents a StorageTransferService

Inheritance

$protobuf.rpc.Service > protos.google.storagetransfer.v1.StorageTransferService

Package

@google-cloud/storage-transfer!

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

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

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

createTransferJob(request, callback)

public createTransferJob(request: google.storagetransfer.v1.ICreateTransferJobRequest, callback: google.storagetransfer.v1.StorageTransferService.CreateTransferJobCallback): void;

Calls CreateTransferJob.

Parameters

Name	Description
request	`google.storagetransfer.v1.ICreateTransferJobRequest` CreateTransferJobRequest message or plain object
callback	`google.storagetransfer.v1.StorageTransferService.CreateTransferJobCallback` Node-style callback called with the error, if any, and TransferJob

Returns

Type	Description
void

createTransferJob(request)

public createTransferJob(request: google.storagetransfer.v1.ICreateTransferJobRequest): Promise<google.storagetransfer.v1.TransferJob>;

Calls CreateTransferJob.

Parameter

Name	Description
request	`google.storagetransfer.v1.ICreateTransferJobRequest` CreateTransferJobRequest message or plain object

Returns

Type	Description
Promise<google.storagetransfer.v1.TransferJob>	Promise

getGoogleServiceAccount(request, callback)

public getGoogleServiceAccount(request: google.storagetransfer.v1.IGetGoogleServiceAccountRequest, callback: google.storagetransfer.v1.StorageTransferService.GetGoogleServiceAccountCallback): void;

Calls GetGoogleServiceAccount.

Parameters

Name	Description
request	`google.storagetransfer.v1.IGetGoogleServiceAccountRequest` GetGoogleServiceAccountRequest message or plain object
callback	`google.storagetransfer.v1.StorageTransferService.GetGoogleServiceAccountCallback` Node-style callback called with the error, if any, and GoogleServiceAccount

Returns

Type	Description
void

getGoogleServiceAccount(request)

public getGoogleServiceAccount(request: google.storagetransfer.v1.IGetGoogleServiceAccountRequest): Promise<google.storagetransfer.v1.GoogleServiceAccount>;

Calls GetGoogleServiceAccount.

Parameter

Name	Description
request	`google.storagetransfer.v1.IGetGoogleServiceAccountRequest` GetGoogleServiceAccountRequest message or plain object

Returns

Type	Description
Promise<google.storagetransfer.v1.GoogleServiceAccount>	Promise

getTransferJob(request, callback)

public getTransferJob(request: google.storagetransfer.v1.IGetTransferJobRequest, callback: google.storagetransfer.v1.StorageTransferService.GetTransferJobCallback): void;

Calls GetTransferJob.

Parameters

Name	Description
request	`google.storagetransfer.v1.IGetTransferJobRequest` GetTransferJobRequest message or plain object
callback	`google.storagetransfer.v1.StorageTransferService.GetTransferJobCallback` Node-style callback called with the error, if any, and TransferJob

Returns

Type	Description
void

getTransferJob(request)

public getTransferJob(request: google.storagetransfer.v1.IGetTransferJobRequest): Promise<google.storagetransfer.v1.TransferJob>;

Calls GetTransferJob.

Parameter

Name	Description
request	`google.storagetransfer.v1.IGetTransferJobRequest` GetTransferJobRequest message or plain object

Returns

Type	Description
Promise<google.storagetransfer.v1.TransferJob>	Promise

listTransferJobs(request, callback)

public listTransferJobs(request: google.storagetransfer.v1.IListTransferJobsRequest, callback: google.storagetransfer.v1.StorageTransferService.ListTransferJobsCallback): void;

Calls ListTransferJobs.

Parameters

Name	Description
request	`google.storagetransfer.v1.IListTransferJobsRequest` ListTransferJobsRequest message or plain object
callback	`google.storagetransfer.v1.StorageTransferService.ListTransferJobsCallback` Node-style callback called with the error, if any, and ListTransferJobsResponse

Returns

Type	Description
void

listTransferJobs(request)

public listTransferJobs(request: google.storagetransfer.v1.IListTransferJobsRequest): Promise<google.storagetransfer.v1.ListTransferJobsResponse>;

Calls ListTransferJobs.

Parameter

Name	Description
request	`google.storagetransfer.v1.IListTransferJobsRequest` ListTransferJobsRequest message or plain object

Returns

Type	Description
Promise<google.storagetransfer.v1.ListTransferJobsResponse>	Promise

pauseTransferOperation(request, callback)

public pauseTransferOperation(request: google.storagetransfer.v1.IPauseTransferOperationRequest, callback: google.storagetransfer.v1.StorageTransferService.PauseTransferOperationCallback): void;

Calls PauseTransferOperation.

Parameters

Name	Description
request	`google.storagetransfer.v1.IPauseTransferOperationRequest` PauseTransferOperationRequest message or plain object
callback	`google.storagetransfer.v1.StorageTransferService.PauseTransferOperationCallback` Node-style callback called with the error, if any, and Empty

Returns

Type	Description
void

pauseTransferOperation(request)

public pauseTransferOperation(request: google.storagetransfer.v1.IPauseTransferOperationRequest): Promise<google.protobuf.Empty>;

Calls PauseTransferOperation.

Parameter

Name	Description
request	`google.storagetransfer.v1.IPauseTransferOperationRequest` PauseTransferOperationRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

resumeTransferOperation(request, callback)

public resumeTransferOperation(request: google.storagetransfer.v1.IResumeTransferOperationRequest, callback: google.storagetransfer.v1.StorageTransferService.ResumeTransferOperationCallback): void;

Calls ResumeTransferOperation.

Parameters

Name	Description
request	`google.storagetransfer.v1.IResumeTransferOperationRequest` ResumeTransferOperationRequest message or plain object
callback	`google.storagetransfer.v1.StorageTransferService.ResumeTransferOperationCallback` Node-style callback called with the error, if any, and Empty

Returns

Type	Description
void

resumeTransferOperation(request)

public resumeTransferOperation(request: google.storagetransfer.v1.IResumeTransferOperationRequest): Promise<google.protobuf.Empty>;

Calls ResumeTransferOperation.

Parameter

Name	Description
request	`google.storagetransfer.v1.IResumeTransferOperationRequest` ResumeTransferOperationRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

runTransferJob(request, callback)

public runTransferJob(request: google.storagetransfer.v1.IRunTransferJobRequest, callback: google.storagetransfer.v1.StorageTransferService.RunTransferJobCallback): void;

Calls RunTransferJob.

Parameters

Name	Description
request	`google.storagetransfer.v1.IRunTransferJobRequest` RunTransferJobRequest message or plain object
callback	`google.storagetransfer.v1.StorageTransferService.RunTransferJobCallback` Node-style callback called with the error, if any, and Operation

Returns

Type	Description
void

runTransferJob(request)

public runTransferJob(request: google.storagetransfer.v1.IRunTransferJobRequest): Promise<google.longrunning.Operation>;

Calls RunTransferJob.

Parameter

Name	Description
request	`google.storagetransfer.v1.IRunTransferJobRequest` RunTransferJobRequest message or plain object

Returns

Type	Description
Promise<google.longrunning.Operation>	Promise

updateTransferJob(request, callback)

public updateTransferJob(request: google.storagetransfer.v1.IUpdateTransferJobRequest, callback: google.storagetransfer.v1.StorageTransferService.UpdateTransferJobCallback): void;

Calls UpdateTransferJob.

Parameters

Name	Description
request	`google.storagetransfer.v1.IUpdateTransferJobRequest` UpdateTransferJobRequest message or plain object
callback	`google.storagetransfer.v1.StorageTransferService.UpdateTransferJobCallback` Node-style callback called with the error, if any, and TransferJob

Returns

Type	Description
void

updateTransferJob(request)

public updateTransferJob(request: google.storagetransfer.v1.IUpdateTransferJobRequest): Promise<google.storagetransfer.v1.TransferJob>;

Calls UpdateTransferJob.

Parameter

Name	Description
request	`google.storagetransfer.v1.IUpdateTransferJobRequest` UpdateTransferJobRequest message or plain object

Returns

Type	Description
Promise<google.storagetransfer.v1.TransferJob>	Promise