Package com.google.storagetransfer.v1.proto

Interface StorageTransferServiceGrpc.AsyncService

All Known Implementing Classes:

StorageTransferServiceGrpc.StorageTransferServiceImplBase

Enclosing class:

StorageTransferServiceGrpc

public static interface StorageTransferServiceGrpc.AsyncService

 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.
 

Method Summary

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

Method Detail

getGoogleServiceAccount

default void getGoogleServiceAccount(TransferProto.GetGoogleServiceAccountRequest request,
                                     io.grpc.stub.StreamObserver<TransferTypes.GoogleServiceAccount> responseObserver)

 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

default void createTransferJob(TransferProto.CreateTransferJobRequest request,
                               io.grpc.stub.StreamObserver<TransferTypes.TransferJob> responseObserver)

 Creates a transfer job that runs periodically.
 

updateTransferJob

default void updateTransferJob(TransferProto.UpdateTransferJobRequest request,
                               io.grpc.stub.StreamObserver<TransferTypes.TransferJob> responseObserver)

 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

default void getTransferJob(TransferProto.GetTransferJobRequest request,
                            io.grpc.stub.StreamObserver<TransferTypes.TransferJob> responseObserver)

 Gets a transfer job.
 

listTransferJobs

default void listTransferJobs(TransferProto.ListTransferJobsRequest request,
                              io.grpc.stub.StreamObserver<TransferProto.ListTransferJobsResponse> responseObserver)

 Lists transfer jobs.
 

pauseTransferOperation

default void pauseTransferOperation(TransferProto.PauseTransferOperationRequest request,
                                    io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

 Pauses a transfer operation.
 

resumeTransferOperation

default void resumeTransferOperation(TransferProto.ResumeTransferOperationRequest request,
                                     io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

 Resumes a transfer operation that is paused.
 

runTransferJob

default void runTransferJob(TransferProto.RunTransferJobRequest request,
                            io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 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

default void deleteTransferJob(TransferProto.DeleteTransferJobRequest request,
                               io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

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

createAgentPool

default void createAgentPool(TransferProto.CreateAgentPoolRequest request,
                             io.grpc.stub.StreamObserver<TransferTypes.AgentPool> responseObserver)

 Creates an agent pool resource.
 

updateAgentPool

default void updateAgentPool(TransferProto.UpdateAgentPoolRequest request,
                             io.grpc.stub.StreamObserver<TransferTypes.AgentPool> responseObserver)

 Updates an existing agent pool resource.
 

getAgentPool

default void getAgentPool(TransferProto.GetAgentPoolRequest request,
                          io.grpc.stub.StreamObserver<TransferTypes.AgentPool> responseObserver)

 Gets an agent pool.
 

listAgentPools

default void listAgentPools(TransferProto.ListAgentPoolsRequest request,
                            io.grpc.stub.StreamObserver<TransferProto.ListAgentPoolsResponse> responseObserver)

 Lists agent pools.
 

deleteAgentPool

default void deleteAgentPool(TransferProto.DeleteAgentPoolRequest request,
                             io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)

 Deletes an agent pool.