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

Represents a StorageTransferService

Inheritance

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

Package

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.

createAgentPool(request, callback)

public createAgentPool(request: google.storagetransfer.v1.ICreateAgentPoolRequest, callback: google.storagetransfer.v1.StorageTransferService.CreateAgentPoolCallback): void;

Calls CreateAgentPool.

Parameters
Name	Description
`request`	`ICreateAgentPoolRequest` CreateAgentPoolRequest message or plain object
`callback`	`CreateAgentPoolCallback` Node-style callback called with the error, if any, and AgentPool

Returns
Type	Description
`void`

createAgentPool(request)

public createAgentPool(request: google.storagetransfer.v1.ICreateAgentPoolRequest): Promise<google.storagetransfer.v1.AgentPool>;

Calls CreateAgentPool.

Parameter
Name	Description
`request`	`ICreateAgentPoolRequest` CreateAgentPoolRequest message or plain object

Returns
Type	Description
`Promise<google.storagetransfer.v1.AgentPool>`	Promise

createTransferJob(request, callback)

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

Calls CreateTransferJob.

Parameters
Name	Description
`request`	`ICreateTransferJobRequest` CreateTransferJobRequest message or plain object
`callback`	`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`	`ICreateTransferJobRequest` CreateTransferJobRequest message or plain object

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

deleteAgentPool(request, callback)

public deleteAgentPool(request: google.storagetransfer.v1.IDeleteAgentPoolRequest, callback: google.storagetransfer.v1.StorageTransferService.DeleteAgentPoolCallback): void;

Calls DeleteAgentPool.

Parameters
Name	Description
`request`	`IDeleteAgentPoolRequest` DeleteAgentPoolRequest message or plain object
`callback`	`DeleteAgentPoolCallback` Node-style callback called with the error, if any, and Empty

Returns
Type	Description
`void`

deleteAgentPool(request)

public deleteAgentPool(request: google.storagetransfer.v1.IDeleteAgentPoolRequest): Promise<google.protobuf.Empty>;

Calls DeleteAgentPool.

Parameter
Name	Description
`request`	`IDeleteAgentPoolRequest` DeleteAgentPoolRequest message or plain object

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

deleteTransferJob(request, callback)

public deleteTransferJob(request: google.storagetransfer.v1.IDeleteTransferJobRequest, callback: google.storagetransfer.v1.StorageTransferService.DeleteTransferJobCallback): void;

Calls DeleteTransferJob.

Parameters
Name	Description
`request`	`IDeleteTransferJobRequest` DeleteTransferJobRequest message or plain object
`callback`	`DeleteTransferJobCallback` Node-style callback called with the error, if any, and Empty

Returns
Type	Description
`void`

deleteTransferJob(request)

public deleteTransferJob(request: google.storagetransfer.v1.IDeleteTransferJobRequest): Promise<google.protobuf.Empty>;

Calls DeleteTransferJob.

Parameter
Name	Description
`request`	`IDeleteTransferJobRequest` DeleteTransferJobRequest message or plain object

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

getAgentPool(request, callback)

public getAgentPool(request: google.storagetransfer.v1.IGetAgentPoolRequest, callback: google.storagetransfer.v1.StorageTransferService.GetAgentPoolCallback): void;

Calls GetAgentPool.

Parameters
Name	Description
`request`	`IGetAgentPoolRequest` GetAgentPoolRequest message or plain object
`callback`	`GetAgentPoolCallback` Node-style callback called with the error, if any, and AgentPool

Returns
Type	Description
`void`

getAgentPool(request)

public getAgentPool(request: google.storagetransfer.v1.IGetAgentPoolRequest): Promise<google.storagetransfer.v1.AgentPool>;

Calls GetAgentPool.

Parameter
Name	Description
`request`	`IGetAgentPoolRequest` GetAgentPoolRequest message or plain object

Returns
Type	Description
`Promise<google.storagetransfer.v1.AgentPool>`	Promise

getGoogleServiceAccount(request, callback)

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

Calls GetGoogleServiceAccount.

Parameters
Name	Description
`request`	`IGetGoogleServiceAccountRequest` GetGoogleServiceAccountRequest message or plain object
`callback`	`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`	`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`	`IGetTransferJobRequest` GetTransferJobRequest message or plain object
`callback`	`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`	`IGetTransferJobRequest` GetTransferJobRequest message or plain object

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

listAgentPools(request, callback)

public listAgentPools(request: google.storagetransfer.v1.IListAgentPoolsRequest, callback: google.storagetransfer.v1.StorageTransferService.ListAgentPoolsCallback): void;

Calls ListAgentPools.

Parameters
Name	Description
`request`	`IListAgentPoolsRequest` ListAgentPoolsRequest message or plain object
`callback`	`ListAgentPoolsCallback` Node-style callback called with the error, if any, and ListAgentPoolsResponse

Returns
Type	Description
`void`

listAgentPools(request)

public listAgentPools(request: google.storagetransfer.v1.IListAgentPoolsRequest): Promise<google.storagetransfer.v1.ListAgentPoolsResponse>;

Calls ListAgentPools.

Parameter
Name	Description
`request`	`IListAgentPoolsRequest` ListAgentPoolsRequest message or plain object

Returns
Type	Description
`Promise<google.storagetransfer.v1.ListAgentPoolsResponse>`	Promise

listTransferJobs(request, callback)

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

Calls ListTransferJobs.

Parameters
Name	Description
`request`	`IListTransferJobsRequest` ListTransferJobsRequest message or plain object
`callback`	`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`	`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`	`IPauseTransferOperationRequest` PauseTransferOperationRequest message or plain object
`callback`	`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`	`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`	`IResumeTransferOperationRequest` ResumeTransferOperationRequest message or plain object
`callback`	`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`	`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`	`IRunTransferJobRequest` RunTransferJobRequest message or plain object
`callback`	`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`	`IRunTransferJobRequest` RunTransferJobRequest message or plain object

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

updateAgentPool(request, callback)

public updateAgentPool(request: google.storagetransfer.v1.IUpdateAgentPoolRequest, callback: google.storagetransfer.v1.StorageTransferService.UpdateAgentPoolCallback): void;

Calls UpdateAgentPool.

Parameters
Name	Description
`request`	`IUpdateAgentPoolRequest` UpdateAgentPoolRequest message or plain object
`callback`	`UpdateAgentPoolCallback` Node-style callback called with the error, if any, and AgentPool

Returns
Type	Description
`void`

updateAgentPool(request)

public updateAgentPool(request: google.storagetransfer.v1.IUpdateAgentPoolRequest): Promise<google.storagetransfer.v1.AgentPool>;

Calls UpdateAgentPool.

Parameter
Name	Description
`request`	`IUpdateAgentPoolRequest` UpdateAgentPoolRequest message or plain object

Returns
Type	Description
`Promise<google.storagetransfer.v1.AgentPool>`	Promise

updateTransferJob(request, callback)

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

Calls UpdateTransferJob.

Parameters
Name	Description
`request`	`IUpdateTransferJobRequest` UpdateTransferJobRequest message or plain object
`callback`	`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`	`IUpdateTransferJobRequest` UpdateTransferJobRequest message or plain object

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