StorageTransferService

google.storagetransfer.v1. StorageTransferService

Represents a StorageTransferService

Constructor

new StorageTransferService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new StorageTransferService service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {StorageTransferService}

Creates new StorageTransferService service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
StorageTransferService

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

createAgentPool(request, callback) → {undefined}

Calls CreateAgentPool.

Parameters:
Name Type Description
request google.storagetransfer.v1.ICreateAgentPoolRequest

CreateAgentPoolRequest message or plain object

callback google.storagetransfer.v1.StorageTransferService.CreateAgentPoolCallback

Node-style callback called with the error, if any, and AgentPool

Returns:
Type Description
undefined

createAgentPool(request) → {Promise.<google.storagetransfer.v1.AgentPool>}

Calls CreateAgentPool.

Parameters:
Name Type Description
request google.storagetransfer.v1.ICreateAgentPoolRequest

CreateAgentPoolRequest message or plain object

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

Promise

createTransferJob(request, callback) → {undefined}

Calls CreateTransferJob.

Parameters:
Name Type 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
undefined

createTransferJob(request) → {Promise.<google.storagetransfer.v1.TransferJob>}

Calls CreateTransferJob.

Parameters:
Name Type Description
request google.storagetransfer.v1.ICreateTransferJobRequest

CreateTransferJobRequest message or plain object

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

Promise

deleteAgentPool(request, callback) → {undefined}

Calls DeleteAgentPool.

Parameters:
Name Type Description
request google.storagetransfer.v1.IDeleteAgentPoolRequest

DeleteAgentPoolRequest message or plain object

callback google.storagetransfer.v1.StorageTransferService.DeleteAgentPoolCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deleteAgentPool(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteAgentPool.

Parameters:
Name Type Description
request google.storagetransfer.v1.IDeleteAgentPoolRequest

DeleteAgentPoolRequest message or plain object

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

Promise

getAgentPool(request, callback) → {undefined}

Calls GetAgentPool.

Parameters:
Name Type Description
request google.storagetransfer.v1.IGetAgentPoolRequest

GetAgentPoolRequest message or plain object

callback google.storagetransfer.v1.StorageTransferService.GetAgentPoolCallback

Node-style callback called with the error, if any, and AgentPool

Returns:
Type Description
undefined

getAgentPool(request) → {Promise.<google.storagetransfer.v1.AgentPool>}

Calls GetAgentPool.

Parameters:
Name Type Description
request google.storagetransfer.v1.IGetAgentPoolRequest

GetAgentPoolRequest message or plain object

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

Promise

getGoogleServiceAccount(request, callback) → {undefined}

Calls GetGoogleServiceAccount.

Parameters:
Name Type 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
undefined

getGoogleServiceAccount(request) → {Promise.<google.storagetransfer.v1.GoogleServiceAccount>}

Calls GetGoogleServiceAccount.

Parameters:
Name Type Description
request google.storagetransfer.v1.IGetGoogleServiceAccountRequest

GetGoogleServiceAccountRequest message or plain object

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

Promise

getTransferJob(request, callback) → {undefined}

Calls GetTransferJob.

Parameters:
Name Type 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
undefined

getTransferJob(request) → {Promise.<google.storagetransfer.v1.TransferJob>}

Calls GetTransferJob.

Parameters:
Name Type Description
request google.storagetransfer.v1.IGetTransferJobRequest

GetTransferJobRequest message or plain object

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

Promise

listAgentPools(request, callback) → {undefined}

Calls ListAgentPools.

Parameters:
Name Type Description
request google.storagetransfer.v1.IListAgentPoolsRequest

ListAgentPoolsRequest message or plain object

callback google.storagetransfer.v1.StorageTransferService.ListAgentPoolsCallback

Node-style callback called with the error, if any, and ListAgentPoolsResponse

Returns:
Type Description
undefined

listAgentPools(request) → {Promise.<google.storagetransfer.v1.ListAgentPoolsResponse>}

Calls ListAgentPools.

Parameters:
Name Type Description
request google.storagetransfer.v1.IListAgentPoolsRequest

ListAgentPoolsRequest message or plain object

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

Promise

listTransferJobs(request, callback) → {undefined}

Calls ListTransferJobs.

Parameters:
Name Type 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
undefined

listTransferJobs(request) → {Promise.<google.storagetransfer.v1.ListTransferJobsResponse>}

Calls ListTransferJobs.

Parameters:
Name Type Description
request google.storagetransfer.v1.IListTransferJobsRequest

ListTransferJobsRequest message or plain object

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

Promise

pauseTransferOperation(request, callback) → {undefined}

Calls PauseTransferOperation.

Parameters:
Name Type 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
undefined

pauseTransferOperation(request) → {Promise.<google.protobuf.Empty>}

Calls PauseTransferOperation.

Parameters:
Name Type Description
request google.storagetransfer.v1.IPauseTransferOperationRequest

PauseTransferOperationRequest message or plain object

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

Promise

resumeTransferOperation(request, callback) → {undefined}

Calls ResumeTransferOperation.

Parameters:
Name Type 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
undefined

resumeTransferOperation(request) → {Promise.<google.protobuf.Empty>}

Calls ResumeTransferOperation.

Parameters:
Name Type Description
request google.storagetransfer.v1.IResumeTransferOperationRequest

ResumeTransferOperationRequest message or plain object

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

Promise

runTransferJob(request, callback) → {undefined}

Calls RunTransferJob.

Parameters:
Name Type 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
undefined

runTransferJob(request) → {Promise.<google.longrunning.Operation>}

Calls RunTransferJob.

Parameters:
Name Type Description
request google.storagetransfer.v1.IRunTransferJobRequest

RunTransferJobRequest message or plain object

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

Promise

updateAgentPool(request, callback) → {undefined}

Calls UpdateAgentPool.

Parameters:
Name Type Description
request google.storagetransfer.v1.IUpdateAgentPoolRequest

UpdateAgentPoolRequest message or plain object

callback google.storagetransfer.v1.StorageTransferService.UpdateAgentPoolCallback

Node-style callback called with the error, if any, and AgentPool

Returns:
Type Description
undefined

updateAgentPool(request) → {Promise.<google.storagetransfer.v1.AgentPool>}

Calls UpdateAgentPool.

Parameters:
Name Type Description
request google.storagetransfer.v1.IUpdateAgentPoolRequest

UpdateAgentPoolRequest message or plain object

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

Promise

updateTransferJob(request, callback) → {undefined}

Calls UpdateTransferJob.

Parameters:
Name Type 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
undefined

updateTransferJob(request) → {Promise.<google.storagetransfer.v1.TransferJob>}

Calls UpdateTransferJob.

Parameters:
Name Type Description
request google.storagetransfer.v1.IUpdateTransferJobRequest

UpdateTransferJobRequest message or plain object

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

Promise

Type Definitions

CreateAgentPoolCallback(error, responseopt)

Callback as used by createAgentPool.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.storagetransfer.v1.AgentPool <optional>

AgentPool

CreateTransferJobCallback(error, responseopt)

Callback as used by createTransferJob.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.storagetransfer.v1.TransferJob <optional>

TransferJob

DeleteAgentPoolCallback(error, responseopt)

Callback as used by deleteAgentPool.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

GetAgentPoolCallback(error, responseopt)

Callback as used by getAgentPool.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.storagetransfer.v1.AgentPool <optional>

AgentPool

GetGoogleServiceAccountCallback(error, responseopt)

Callback as used by getGoogleServiceAccount.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.storagetransfer.v1.GoogleServiceAccount <optional>

GoogleServiceAccount

GetTransferJobCallback(error, responseopt)

Callback as used by getTransferJob.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.storagetransfer.v1.TransferJob <optional>

TransferJob

ListAgentPoolsCallback(error, responseopt)

Callback as used by listAgentPools.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.storagetransfer.v1.ListAgentPoolsResponse <optional>

ListAgentPoolsResponse

ListTransferJobsCallback(error, responseopt)

Callback as used by listTransferJobs.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.storagetransfer.v1.ListTransferJobsResponse <optional>

ListTransferJobsResponse

PauseTransferOperationCallback(error, responseopt)

Callback as used by pauseTransferOperation.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

ResumeTransferOperationCallback(error, responseopt)

Callback as used by resumeTransferOperation.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

RunTransferJobCallback(error, responseopt)

Callback as used by runTransferJob.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

UpdateAgentPoolCallback(error, responseopt)

Callback as used by updateAgentPool.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.storagetransfer.v1.AgentPool <optional>

AgentPool

UpdateTransferJobCallback(error, responseopt)

Callback as used by updateTransferJob.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.storagetransfer.v1.TransferJob <optional>

TransferJob