Class StorageTransferServiceGrpc.StorageTransferServiceBlockingStub (1.0.4)

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

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
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
StorageTransferServiceGrpc.StorageTransferServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createTransferJob(TransferProto.CreateTransferJobRequest request)

public TransferTypes.TransferJob createTransferJob(TransferProto.CreateTransferJobRequest request)

Creates a transfer job that runs periodically.

Parameter
NameDescription
requestTransferProto.CreateTransferJobRequest
Returns
TypeDescription
TransferTypes.TransferJob

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 Platform Console 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
NameDescription
requestTransferProto.GetGoogleServiceAccountRequest
Returns
TypeDescription
TransferTypes.GoogleServiceAccount

getTransferJob(TransferProto.GetTransferJobRequest request)

public TransferTypes.TransferJob getTransferJob(TransferProto.GetTransferJobRequest request)

Gets a transfer job.

Parameter
NameDescription
requestTransferProto.GetTransferJobRequest
Returns
TypeDescription
TransferTypes.TransferJob

listTransferJobs(TransferProto.ListTransferJobsRequest request)

public TransferProto.ListTransferJobsResponse listTransferJobs(TransferProto.ListTransferJobsRequest request)

Lists transfer jobs.

Parameter
NameDescription
requestTransferProto.ListTransferJobsRequest
Returns
TypeDescription
TransferProto.ListTransferJobsResponse

pauseTransferOperation(TransferProto.PauseTransferOperationRequest request)

public Empty pauseTransferOperation(TransferProto.PauseTransferOperationRequest request)

Pauses a transfer operation.

Parameter
NameDescription
requestTransferProto.PauseTransferOperationRequest
Returns
TypeDescription
Empty

resumeTransferOperation(TransferProto.ResumeTransferOperationRequest request)

public Empty resumeTransferOperation(TransferProto.ResumeTransferOperationRequest request)

Resumes a transfer operation that is paused.

Parameter
NameDescription
requestTransferProto.ResumeTransferOperationRequest
Returns
TypeDescription
Empty

runTransferJob(TransferProto.RunTransferJobRequest request)

public 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 wil be returned.

Parameter
NameDescription
requestTransferProto.RunTransferJobRequest
Returns
TypeDescription
Operation

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
NameDescription
requestTransferProto.UpdateTransferJobRequest
Returns
TypeDescription
TransferTypes.TransferJob