Storage Transfer v1 API - Class StorageTransferServiceClientImpl (2.9.0) 

public sealed class StorageTransferServiceClientImpl : StorageTransferServiceClient

Reference documentation and code samples for the Storage Transfer v1 API class StorageTransferServiceClientImpl.

StorageTransferService client wrapper implementation, for convenient use.

Inheritance

object > StorageTransferServiceClient > StorageTransferServiceClientImpl

Namespace

Google.Cloud.StorageTransfer.V1

Assembly

Google.Cloud.StorageTransfer.V1.dll

Remarks

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.

Constructors

StorageTransferServiceClientImpl(StorageTransferServiceClient, StorageTransferServiceSettings, ILogger)

public StorageTransferServiceClientImpl(StorageTransferService.StorageTransferServiceClient grpcClient, StorageTransferServiceSettings settings, ILogger logger)

Constructs a client wrapper for the StorageTransferService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient StorageTransferServiceStorageTransferServiceClient

The underlying gRPC client.
settings StorageTransferServiceSettings

The base StorageTransferServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override StorageTransferService.StorageTransferServiceClient GrpcClient { get; }

The underlying gRPC StorageTransferService client

Property Value
Type Description
StorageTransferServiceStorageTransferServiceClient
Overrides

RunTransferJobOperationsClient

public override OperationsClient RunTransferJobOperationsClient { get; }

The long-running operations client for RunTransferJob.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateAgentPool(CreateAgentPoolRequest, CallSettings)

public override AgentPool CreateAgentPool(CreateAgentPoolRequest request, CallSettings callSettings = null)

Creates an agent pool resource.

Parameters
Name Description
request CreateAgentPoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AgentPool

The RPC response.
Overrides

CreateAgentPoolAsync(CreateAgentPoolRequest, CallSettings)

public override Task<AgentPool> CreateAgentPoolAsync(CreateAgentPoolRequest request, CallSettings callSettings = null)

Creates an agent pool resource.

Parameters
Name Description
request CreateAgentPoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAgentPool

A Task containing the RPC response.
Overrides

CreateTransferJob(CreateTransferJobRequest, CallSettings)

public override TransferJob CreateTransferJob(CreateTransferJobRequest request, CallSettings callSettings = null)

Creates a transfer job that runs periodically.

Parameters
Name Description
request CreateTransferJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TransferJob

The RPC response.
Overrides

CreateTransferJobAsync(CreateTransferJobRequest, CallSettings)

public override Task<TransferJob> CreateTransferJobAsync(CreateTransferJobRequest request, CallSettings callSettings = null)

Creates a transfer job that runs periodically.

Parameters
Name Description
request CreateTransferJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTransferJob

A Task containing the RPC response.
Overrides

DeleteAgentPool(DeleteAgentPoolRequest, CallSettings)

public override void DeleteAgentPool(DeleteAgentPoolRequest request, CallSettings callSettings = null)

Deletes an agent pool.

Parameters
Name Description
request DeleteAgentPoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteAgentPoolAsync(DeleteAgentPoolRequest, CallSettings)

public override Task DeleteAgentPoolAsync(DeleteAgentPoolRequest request, CallSettings callSettings = null)

Deletes an agent pool.

Parameters
Name Description
request DeleteAgentPoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteTransferJob(DeleteTransferJobRequest, CallSettings)

public override void DeleteTransferJob(DeleteTransferJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeleteTransferJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteTransferJobAsync(DeleteTransferJobRequest, CallSettings)

public override Task DeleteTransferJobAsync(DeleteTransferJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeleteTransferJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

GetAgentPool(GetAgentPoolRequest, CallSettings)

public override AgentPool GetAgentPool(GetAgentPoolRequest request, CallSettings callSettings = null)

Gets an agent pool.

Parameters
Name Description
request GetAgentPoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AgentPool

The RPC response.
Overrides

GetAgentPoolAsync(GetAgentPoolRequest, CallSettings)

public override Task<AgentPool> GetAgentPoolAsync(GetAgentPoolRequest request, CallSettings callSettings = null)

Gets an agent pool.

Parameters
Name Description
request GetAgentPoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAgentPool

A Task containing the RPC response.
Overrides

GetGoogleServiceAccount(GetGoogleServiceAccountRequest, CallSettings)

public override GoogleServiceAccount GetGoogleServiceAccount(GetGoogleServiceAccountRequest request, CallSettings callSettings = null)

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 GetGoogleServiceAccountRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GoogleServiceAccount

The RPC response.
Overrides

GetGoogleServiceAccountAsync(GetGoogleServiceAccountRequest, CallSettings)

public override Task<GoogleServiceAccount> GetGoogleServiceAccountAsync(GetGoogleServiceAccountRequest request, CallSettings callSettings = null)

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 GetGoogleServiceAccountRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskGoogleServiceAccount

A Task containing the RPC response.
Overrides

GetTransferJob(GetTransferJobRequest, CallSettings)

public override TransferJob GetTransferJob(GetTransferJobRequest request, CallSettings callSettings = null)

Gets a transfer job.

Parameters
Name Description
request GetTransferJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TransferJob

The RPC response.
Overrides

GetTransferJobAsync(GetTransferJobRequest, CallSettings)

public override Task<TransferJob> GetTransferJobAsync(GetTransferJobRequest request, CallSettings callSettings = null)

Gets a transfer job.

Parameters
Name Description
request GetTransferJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTransferJob

A Task containing the RPC response.
Overrides

ListAgentPools(ListAgentPoolsRequest, CallSettings)

public override PagedEnumerable<ListAgentPoolsResponse, AgentPool> ListAgentPools(ListAgentPoolsRequest request, CallSettings callSettings = null)

Lists agent pools.

Parameters
Name Description
request ListAgentPoolsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListAgentPoolsResponseAgentPool

A pageable sequence of AgentPool resources.
Overrides

ListAgentPoolsAsync(ListAgentPoolsRequest, CallSettings)

public override PagedAsyncEnumerable<ListAgentPoolsResponse, AgentPool> ListAgentPoolsAsync(ListAgentPoolsRequest request, CallSettings callSettings = null)

Lists agent pools.

Parameters
Name Description
request ListAgentPoolsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListAgentPoolsResponseAgentPool

A pageable asynchronous sequence of AgentPool resources.
Overrides

ListTransferJobs(ListTransferJobsRequest, CallSettings)

public override PagedEnumerable<ListTransferJobsResponse, TransferJob> ListTransferJobs(ListTransferJobsRequest request, CallSettings callSettings = null)

Lists transfer jobs.

Parameters
Name Description
request ListTransferJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTransferJobsResponseTransferJob

A pageable sequence of TransferJob resources.
Overrides

ListTransferJobsAsync(ListTransferJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListTransferJobsResponse, TransferJob> ListTransferJobsAsync(ListTransferJobsRequest request, CallSettings callSettings = null)

Lists transfer jobs.

Parameters
Name Description
request ListTransferJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTransferJobsResponseTransferJob

A pageable asynchronous sequence of TransferJob resources.
Overrides

PauseTransferOperation(PauseTransferOperationRequest, CallSettings)

public override void PauseTransferOperation(PauseTransferOperationRequest request, CallSettings callSettings = null)

Pauses a transfer operation.

Parameters
Name Description
request PauseTransferOperationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

PauseTransferOperationAsync(PauseTransferOperationRequest, CallSettings)

public override Task PauseTransferOperationAsync(PauseTransferOperationRequest request, CallSettings callSettings = null)

Pauses a transfer operation.

Parameters
Name Description
request PauseTransferOperationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

ResumeTransferOperation(ResumeTransferOperationRequest, CallSettings)

public override void ResumeTransferOperation(ResumeTransferOperationRequest request, CallSettings callSettings = null)

Resumes a transfer operation that is paused.

Parameters
Name Description
request ResumeTransferOperationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

ResumeTransferOperationAsync(ResumeTransferOperationRequest, CallSettings)

public override Task ResumeTransferOperationAsync(ResumeTransferOperationRequest request, CallSettings callSettings = null)

Resumes a transfer operation that is paused.

Parameters
Name Description
request ResumeTransferOperationRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

RunTransferJob(RunTransferJobRequest, CallSettings)

public override Operation<Empty, TransferOperation> RunTransferJob(RunTransferJobRequest request, CallSettings callSettings = null)

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 RunTransferJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyTransferOperation

The RPC response.
Overrides

RunTransferJobAsync(RunTransferJobRequest, CallSettings)

public override Task<Operation<Empty, TransferOperation>> RunTransferJobAsync(RunTransferJobRequest request, CallSettings callSettings = null)

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 RunTransferJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyTransferOperation

A Task containing the RPC response.
Overrides

UpdateAgentPool(UpdateAgentPoolRequest, CallSettings)

public override AgentPool UpdateAgentPool(UpdateAgentPoolRequest request, CallSettings callSettings = null)

Updates an existing agent pool resource.

Parameters
Name Description
request UpdateAgentPoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AgentPool

The RPC response.
Overrides

UpdateAgentPoolAsync(UpdateAgentPoolRequest, CallSettings)

public override Task<AgentPool> UpdateAgentPoolAsync(UpdateAgentPoolRequest request, CallSettings callSettings = null)

Updates an existing agent pool resource.

Parameters
Name Description
request UpdateAgentPoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAgentPool

A Task containing the RPC response.
Overrides

UpdateTransferJob(UpdateTransferJobRequest, CallSettings)

public override TransferJob UpdateTransferJob(UpdateTransferJobRequest request, CallSettings callSettings = null)

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]).

Parameters
Name Description
request UpdateTransferJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TransferJob

The RPC response.
Overrides

UpdateTransferJobAsync(UpdateTransferJobRequest, CallSettings)

public override Task<TransferJob> UpdateTransferJobAsync(UpdateTransferJobRequest request, CallSettings callSettings = null)

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]).

Parameters
Name Description
request UpdateTransferJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTransferJob

A Task containing the RPC response.
Overrides