Package com.google.storagetransfer.v1.proto

Class StorageTransferServiceGrpc.StorageTransferServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<StorageTransferServiceGrpc.StorageTransferServiceFutureStub>

com.google.storagetransfer.v1.proto.StorageTransferServiceGrpc.StorageTransferServiceFutureStub

Enclosing class:

StorageTransferServiceGrpc

public static final class StorageTransferServiceGrpc.StorageTransferServiceFutureStub
extends io.grpc.stub.AbstractFutureStub<StorageTransferServiceGrpc.StorageTransferServiceFutureStub>

A stub to allow clients to do ListenableFuture-style 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.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
protected StorageTransferServiceGrpc.StorageTransferServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<TransferTypes.AgentPool>	createAgentPool(TransferProto.CreateAgentPoolRequest request)	Creates an agent pool resource.
com.google.common.util.concurrent.ListenableFuture<TransferTypes.TransferJob>	createTransferJob(TransferProto.CreateTransferJobRequest request)	Creates a transfer job that runs periodically.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteAgentPool(TransferProto.DeleteAgentPoolRequest request)	Deletes an agent pool.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteTransferJob(TransferProto.DeleteTransferJobRequest request)	Deletes a transfer job.
com.google.common.util.concurrent.ListenableFuture<TransferTypes.AgentPool>	getAgentPool(TransferProto.GetAgentPoolRequest request)	Gets an agent pool.
com.google.common.util.concurrent.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.
com.google.common.util.concurrent.ListenableFuture<TransferTypes.TransferJob>	getTransferJob(TransferProto.GetTransferJobRequest request)	Gets a transfer job.
com.google.common.util.concurrent.ListenableFuture<TransferProto.ListAgentPoolsResponse>	listAgentPools(TransferProto.ListAgentPoolsRequest request)	Lists agent pools.
com.google.common.util.concurrent.ListenableFuture<TransferProto.ListTransferJobsResponse>	listTransferJobs(TransferProto.ListTransferJobsRequest request)	Lists transfer jobs.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	pauseTransferOperation(TransferProto.PauseTransferOperationRequest request)	Pauses a transfer operation.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	resumeTransferOperation(TransferProto.ResumeTransferOperationRequest request)	Resumes a transfer operation that is paused.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	runTransferJob(TransferProto.RunTransferJobRequest request)	Starts a new operation for the specified transfer job.
com.google.common.util.concurrent.ListenableFuture<TransferTypes.AgentPool>	updateAgentPool(TransferProto.UpdateAgentPoolRequest request)	Updates an existing agent pool resource.
com.google.common.util.concurrent.ListenableFuture<TransferTypes.TransferJob>	updateTransferJob(TransferProto.UpdateTransferJobRequest request)	Updates a transfer job.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected StorageTransferServiceGrpc.StorageTransferServiceFutureStub build(io.grpc.Channel channel,
                                                                            io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<StorageTransferServiceGrpc.StorageTransferServiceFutureStub>

getGoogleServiceAccount

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

createTransferJob

public com.google.common.util.concurrent.ListenableFuture<TransferTypes.TransferJob> createTransferJob(TransferProto.CreateTransferJobRequest request)

 Creates a transfer job that runs periodically.
 

updateTransferJob

public com.google.common.util.concurrent.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][google.storagetransfer.v1.TransferJob.status]
 field can be modified using this RPC (for example, to set a job's status to
 [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED],
 [DISABLED][google.storagetransfer.v1.TransferJob.Status.DISABLED], or
 [ENABLED][google.storagetransfer.v1.TransferJob.Status.ENABLED]).
 

getTransferJob

public com.google.common.util.concurrent.ListenableFuture<TransferTypes.TransferJob> getTransferJob(TransferProto.GetTransferJobRequest request)

 Gets a transfer job.
 

listTransferJobs

public com.google.common.util.concurrent.ListenableFuture<TransferProto.ListTransferJobsResponse> listTransferJobs(TransferProto.ListTransferJobsRequest request)

 Lists transfer jobs.
 

pauseTransferOperation

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> pauseTransferOperation(TransferProto.PauseTransferOperationRequest request)

 Pauses a transfer operation.
 

resumeTransferOperation

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> resumeTransferOperation(TransferProto.ResumeTransferOperationRequest request)

 Resumes a transfer operation that is paused.
 

runTransferJob

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

deleteTransferJob

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteTransferJob(TransferProto.DeleteTransferJobRequest request)

 Deletes a transfer job. Deleting a transfer job sets its status to
 [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
 

createAgentPool

public com.google.common.util.concurrent.ListenableFuture<TransferTypes.AgentPool> createAgentPool(TransferProto.CreateAgentPoolRequest request)

 Creates an agent pool resource.
 

updateAgentPool

public com.google.common.util.concurrent.ListenableFuture<TransferTypes.AgentPool> updateAgentPool(TransferProto.UpdateAgentPoolRequest request)

 Updates an existing agent pool resource.
 

getAgentPool

public com.google.common.util.concurrent.ListenableFuture<TransferTypes.AgentPool> getAgentPool(TransferProto.GetAgentPoolRequest request)

 Gets an agent pool.
 

listAgentPools

public com.google.common.util.concurrent.ListenableFuture<TransferProto.ListAgentPoolsResponse> listAgentPools(TransferProto.ListAgentPoolsRequest request)

 Lists agent pools.
 

deleteAgentPool

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteAgentPool(TransferProto.DeleteAgentPoolRequest request)

 Deletes an agent pool.