Interface StorageTransferServiceGrpc.AsyncService (1.27.0)

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.

Methods

createAgentPool(TransferProto.CreateAgentPoolRequest request, StreamObserver<TransferTypes.AgentPool> responseObserver)

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

Creates an agent pool resource.

Parameters
Name Description
request TransferProto.CreateAgentPoolRequest
responseObserver io.grpc.stub.StreamObserver<AgentPool>

createTransferJob(TransferProto.CreateTransferJobRequest request, StreamObserver<TransferTypes.TransferJob> responseObserver)

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

Creates a transfer job that runs periodically.

Parameters
Name Description
request TransferProto.CreateTransferJobRequest
responseObserver io.grpc.stub.StreamObserver<TransferJob>

deleteAgentPool(TransferProto.DeleteAgentPoolRequest request, StreamObserver<Empty> responseObserver)

public default void deleteAgentPool(TransferProto.DeleteAgentPoolRequest request, StreamObserver<Empty> responseObserver)

Deletes an agent pool.

Parameters
Name Description
request TransferProto.DeleteAgentPoolRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteTransferJob(TransferProto.DeleteTransferJobRequest request, StreamObserver<Empty> responseObserver)

public default void deleteTransferJob(TransferProto.DeleteTransferJobRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name Description
request TransferProto.DeleteTransferJobRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

getAgentPool(TransferProto.GetAgentPoolRequest request, StreamObserver<TransferTypes.AgentPool> responseObserver)

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

Gets an agent pool.

Parameters
Name Description
request TransferProto.GetAgentPoolRequest
responseObserver io.grpc.stub.StreamObserver<AgentPool>

getGoogleServiceAccount(TransferProto.GetGoogleServiceAccountRequest request, StreamObserver<TransferTypes.GoogleServiceAccount> responseObserver)

public default void getGoogleServiceAccount(TransferProto.GetGoogleServiceAccountRequest request, 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.

Parameters
Name Description
request TransferProto.GetGoogleServiceAccountRequest
responseObserver io.grpc.stub.StreamObserver<GoogleServiceAccount>

getTransferJob(TransferProto.GetTransferJobRequest request, StreamObserver<TransferTypes.TransferJob> responseObserver)

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

Gets a transfer job.

Parameters
Name Description
request TransferProto.GetTransferJobRequest
responseObserver io.grpc.stub.StreamObserver<TransferJob>

listAgentPools(TransferProto.ListAgentPoolsRequest request, StreamObserver<TransferProto.ListAgentPoolsResponse> responseObserver)

public default void listAgentPools(TransferProto.ListAgentPoolsRequest request, StreamObserver<TransferProto.ListAgentPoolsResponse> responseObserver)

Lists agent pools.

Parameters
Name Description
request TransferProto.ListAgentPoolsRequest
responseObserver io.grpc.stub.StreamObserver<ListAgentPoolsResponse>

listTransferJobs(TransferProto.ListTransferJobsRequest request, StreamObserver<TransferProto.ListTransferJobsResponse> responseObserver)

public default void listTransferJobs(TransferProto.ListTransferJobsRequest request, StreamObserver<TransferProto.ListTransferJobsResponse> responseObserver)

Lists transfer jobs.

Parameters
Name Description
request TransferProto.ListTransferJobsRequest
responseObserver io.grpc.stub.StreamObserver<ListTransferJobsResponse>

pauseTransferOperation(TransferProto.PauseTransferOperationRequest request, StreamObserver<Empty> responseObserver)

public default void pauseTransferOperation(TransferProto.PauseTransferOperationRequest request, StreamObserver<Empty> responseObserver)

Pauses a transfer operation.

Parameters
Name Description
request TransferProto.PauseTransferOperationRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

resumeTransferOperation(TransferProto.ResumeTransferOperationRequest request, StreamObserver<Empty> responseObserver)

public default void resumeTransferOperation(TransferProto.ResumeTransferOperationRequest request, StreamObserver<Empty> responseObserver)

Resumes a transfer operation that is paused.

Parameters
Name Description
request TransferProto.ResumeTransferOperationRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

runTransferJob(TransferProto.RunTransferJobRequest request, StreamObserver<Operation> responseObserver)

public default void runTransferJob(TransferProto.RunTransferJobRequest request, StreamObserver<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.

Parameters
Name Description
request TransferProto.RunTransferJobRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateAgentPool(TransferProto.UpdateAgentPoolRequest request, StreamObserver<TransferTypes.AgentPool> responseObserver)

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

Updates an existing agent pool resource.

Parameters
Name Description
request TransferProto.UpdateAgentPoolRequest
responseObserver io.grpc.stub.StreamObserver<AgentPool>

updateTransferJob(TransferProto.UpdateTransferJobRequest request, StreamObserver<TransferTypes.TransferJob> responseObserver)

public default void updateTransferJob(TransferProto.UpdateTransferJobRequest request, 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 field can be modified using this RPC (for example, to set a job's status to DELETED, DISABLED, or ENABLED).

Parameters
Name Description
request TransferProto.UpdateTransferJobRequest
responseObserver io.grpc.stub.StreamObserver<TransferJob>