Class StorageTransferServiceGrpc.StorageTransferServiceBlockingStub (1.35.0)

public static final class StorageTransferServiceGrpc.StorageTransferServiceBlockingStub extends AbstractBlockingStub<StorageTransferServiceGrpc.StorageTransferServiceBlockingStub>

A stub to allow clients to do synchronous rpc calls to service StorageTransferService.

Storage Transfer Service and its protos. Transfers data between between Google Cloud Storage buckets or from a data source external to Google to a Cloud Storage bucket.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > StorageTransferServiceGrpc.StorageTransferServiceBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected StorageTransferServiceGrpc.StorageTransferServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
StorageTransferServiceGrpc.StorageTransferServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createAgentPool(TransferProto.CreateAgentPoolRequest request)

public TransferTypes.AgentPool createAgentPool(TransferProto.CreateAgentPoolRequest request)

Creates an agent pool resource.

Parameter
Name Description
request TransferProto.CreateAgentPoolRequest
Returns
Type Description
TransferTypes.AgentPool

createTransferJob(TransferProto.CreateTransferJobRequest request)

public TransferTypes.TransferJob createTransferJob(TransferProto.CreateTransferJobRequest request)

Creates a transfer job that runs periodically.

Parameter
Name Description
request TransferProto.CreateTransferJobRequest
Returns
Type Description
TransferTypes.TransferJob

deleteAgentPool(TransferProto.DeleteAgentPoolRequest request)

public Empty deleteAgentPool(TransferProto.DeleteAgentPoolRequest request)

Deletes an agent pool.

Parameter
Name Description
request TransferProto.DeleteAgentPoolRequest
Returns
Type Description
Empty

deleteTransferJob(TransferProto.DeleteTransferJobRequest request)

public Empty deleteTransferJob(TransferProto.DeleteTransferJobRequest request)

Deletes a transfer job. Deleting a transfer job sets its status to DELETED.

Parameter
Name Description
request TransferProto.DeleteTransferJobRequest
Returns
Type Description
Empty

getAgentPool(TransferProto.GetAgentPoolRequest request)

public TransferTypes.AgentPool getAgentPool(TransferProto.GetAgentPoolRequest request)

Gets an agent pool.

Parameter
Name Description
request TransferProto.GetAgentPoolRequest
Returns
Type Description
TransferTypes.AgentPool

getGoogleServiceAccount(TransferProto.GetGoogleServiceAccountRequest request)

public TransferTypes.GoogleServiceAccount getGoogleServiceAccount(TransferProto.GetGoogleServiceAccountRequest request)

Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Cloud project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.

Parameter
Name Description
request TransferProto.GetGoogleServiceAccountRequest
Returns
Type Description
TransferTypes.GoogleServiceAccount

getTransferJob(TransferProto.GetTransferJobRequest request)

public TransferTypes.TransferJob getTransferJob(TransferProto.GetTransferJobRequest request)

Gets a transfer job.

Parameter
Name Description
request TransferProto.GetTransferJobRequest
Returns
Type Description
TransferTypes.TransferJob

listAgentPools(TransferProto.ListAgentPoolsRequest request)

public TransferProto.ListAgentPoolsResponse listAgentPools(TransferProto.ListAgentPoolsRequest request)

Lists agent pools.

Parameter
Name Description
request TransferProto.ListAgentPoolsRequest
Returns
Type Description
TransferProto.ListAgentPoolsResponse

listTransferJobs(TransferProto.ListTransferJobsRequest request)

public TransferProto.ListTransferJobsResponse listTransferJobs(TransferProto.ListTransferJobsRequest request)

Lists transfer jobs.

Parameter
Name Description
request TransferProto.ListTransferJobsRequest
Returns
Type Description
TransferProto.ListTransferJobsResponse

pauseTransferOperation(TransferProto.PauseTransferOperationRequest request)

public Empty pauseTransferOperation(TransferProto.PauseTransferOperationRequest request)

Pauses a transfer operation.

Parameter
Name Description
request TransferProto.PauseTransferOperationRequest
Returns
Type Description
Empty

resumeTransferOperation(TransferProto.ResumeTransferOperationRequest request)

public Empty resumeTransferOperation(TransferProto.ResumeTransferOperationRequest request)

Resumes a transfer operation that is paused.

Parameter
Name Description
request TransferProto.ResumeTransferOperationRequest
Returns
Type Description
Empty

runTransferJob(TransferProto.RunTransferJobRequest request)

public Operation runTransferJob(TransferProto.RunTransferJobRequest request)

Starts a new operation for the specified transfer job. A TransferJob has a maximum of one active TransferOperation. If this method is called while a TransferOperation is active, an error is returned.

Parameter
Name Description
request TransferProto.RunTransferJobRequest
Returns
Type Description
Operation

updateAgentPool(TransferProto.UpdateAgentPoolRequest request)

public TransferTypes.AgentPool updateAgentPool(TransferProto.UpdateAgentPoolRequest request)

Updates an existing agent pool resource.

Parameter
Name Description
request TransferProto.UpdateAgentPoolRequest
Returns
Type Description
TransferTypes.AgentPool

updateTransferJob(TransferProto.UpdateTransferJobRequest request)

public TransferTypes.TransferJob updateTransferJob(TransferProto.UpdateTransferJobRequest request)

Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Note: The job's status field can be modified using this RPC (for example, to set a job's status to DELETED, DISABLED, or ENABLED).

Parameter
Name Description
request TransferProto.UpdateTransferJobRequest
Returns
Type Description
TransferTypes.TransferJob