Class StorageTransferServiceGrpc.StorageTransferServiceFutureStub (1.11.0)

public static final class StorageTransferServiceGrpc.StorageTransferServiceFutureStub extends AbstractFutureStub<StorageTransferServiceGrpc.StorageTransferServiceFutureStub>

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.AbstractFutureStub > StorageTransferServiceGrpc.StorageTransferServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

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

createAgentPool(TransferProto.CreateAgentPoolRequest request)

public ListenableFuture<TransferTypes.AgentPool> createAgentPool(TransferProto.CreateAgentPoolRequest request)

Creates an agent pool resource.

Parameter
Name Description
request TransferProto.CreateAgentPoolRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AgentPool>

createTransferJob(TransferProto.CreateTransferJobRequest request)

public ListenableFuture<TransferTypes.TransferJob> createTransferJob(TransferProto.CreateTransferJobRequest request)

Creates a transfer job that runs periodically.

Parameter
Name Description
request TransferProto.CreateTransferJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<TransferJob>

deleteAgentPool(TransferProto.DeleteAgentPoolRequest request)

public ListenableFuture<Empty> deleteAgentPool(TransferProto.DeleteAgentPoolRequest request)

Deletes an agent pool.

Parameter
Name Description
request TransferProto.DeleteAgentPoolRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteTransferJob(TransferProto.DeleteTransferJobRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Empty>

getAgentPool(TransferProto.GetAgentPoolRequest request)

public ListenableFuture<TransferTypes.AgentPool> getAgentPool(TransferProto.GetAgentPoolRequest request)

Gets an agent pool.

Parameter
Name Description
request TransferProto.GetAgentPoolRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AgentPool>

getGoogleServiceAccount(TransferProto.GetGoogleServiceAccountRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<GoogleServiceAccount>

getTransferJob(TransferProto.GetTransferJobRequest request)

public ListenableFuture<TransferTypes.TransferJob> getTransferJob(TransferProto.GetTransferJobRequest request)

Gets a transfer job.

Parameter
Name Description
request TransferProto.GetTransferJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<TransferJob>

listAgentPools(TransferProto.ListAgentPoolsRequest request)

public ListenableFuture<TransferProto.ListAgentPoolsResponse> listAgentPools(TransferProto.ListAgentPoolsRequest request)

Lists agent pools.

Parameter
Name Description
request TransferProto.ListAgentPoolsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListAgentPoolsResponse>

listTransferJobs(TransferProto.ListTransferJobsRequest request)

public ListenableFuture<TransferProto.ListTransferJobsResponse> listTransferJobs(TransferProto.ListTransferJobsRequest request)

Lists transfer jobs.

Parameter
Name Description
request TransferProto.ListTransferJobsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListTransferJobsResponse>

pauseTransferOperation(TransferProto.PauseTransferOperationRequest request)

public ListenableFuture<Empty> pauseTransferOperation(TransferProto.PauseTransferOperationRequest request)

Pauses a transfer operation.

Parameter
Name Description
request TransferProto.PauseTransferOperationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

resumeTransferOperation(TransferProto.ResumeTransferOperationRequest request)

public ListenableFuture<Empty> resumeTransferOperation(TransferProto.ResumeTransferOperationRequest request)

Resumes a transfer operation that is paused.

Parameter
Name Description
request TransferProto.ResumeTransferOperationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

runTransferJob(TransferProto.RunTransferJobRequest request)

public ListenableFuture<Operation> runTransferJob(TransferProto.RunTransferJobRequest request)

Attempts to start a new TransferOperation for the current TransferJob. A TransferJob has a maximum of one active TransferOperation. If this method is called while a TransferOperation is active, an error will be returned.

Parameter
Name Description
request TransferProto.RunTransferJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateAgentPool(TransferProto.UpdateAgentPoolRequest request)

public ListenableFuture<TransferTypes.AgentPool> updateAgentPool(TransferProto.UpdateAgentPoolRequest request)

Updates an existing agent pool resource.

Parameter
Name Description
request TransferProto.UpdateAgentPoolRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AgentPool>

updateTransferJob(TransferProto.UpdateTransferJobRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<TransferJob>