Storage Transfer v1 API - Class StorageTransferService.StorageTransferServiceBase (2.5.0)

Version latest

• 2.5.0 (latest)
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(StorageTransferService), "BindService")]
public abstract class StorageTransferService.StorageTransferServiceBase

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

Base class for server-side implementations of StorageTransferService

Inheritance

object > StorageTransferService.StorageTransferServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.StorageTransfer.V1

Assembly

Google.Cloud.StorageTransfer.V1.dll

Methods

CreateAgentPool(CreateAgentPoolRequest, ServerCallContext)

public virtual Task<AgentPool> CreateAgentPool(CreateAgentPoolRequest request, ServerCallContext context)

Creates an agent pool resource.

Parameters
Name	Description
request	CreateAgentPoolRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAgentPool	The response to send back to the client (wrapped by a task).

CreateTransferJob(CreateTransferJobRequest, ServerCallContext)

public virtual Task<TransferJob> CreateTransferJob(CreateTransferJobRequest request, ServerCallContext context)

Creates a transfer job that runs periodically.

Parameters
Name	Description
request	CreateTransferJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTransferJob	The response to send back to the client (wrapped by a task).

DeleteAgentPool(DeleteAgentPoolRequest, ServerCallContext)

public virtual Task<Empty> DeleteAgentPool(DeleteAgentPoolRequest request, ServerCallContext context)

Deletes an agent pool.

Parameters
Name	Description
request	DeleteAgentPoolRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteTransferJob(DeleteTransferJobRequest, ServerCallContext)

public virtual Task<Empty> DeleteTransferJob(DeleteTransferJobRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

GetAgentPool(GetAgentPoolRequest, ServerCallContext)

public virtual Task<AgentPool> GetAgentPool(GetAgentPoolRequest request, ServerCallContext context)

Gets an agent pool.

Parameters
Name	Description
request	GetAgentPoolRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAgentPool	The response to send back to the client (wrapped by a task).

GetGoogleServiceAccount(GetGoogleServiceAccountRequest, ServerCallContext)

public virtual Task<GoogleServiceAccount> GetGoogleServiceAccount(GetGoogleServiceAccountRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGoogleServiceAccount	The response to send back to the client (wrapped by a task).

GetTransferJob(GetTransferJobRequest, ServerCallContext)

public virtual Task<TransferJob> GetTransferJob(GetTransferJobRequest request, ServerCallContext context)

Gets a transfer job.

Parameters
Name	Description
request	GetTransferJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTransferJob	The response to send back to the client (wrapped by a task).

ListAgentPools(ListAgentPoolsRequest, ServerCallContext)

public virtual Task<ListAgentPoolsResponse> ListAgentPools(ListAgentPoolsRequest request, ServerCallContext context)

Lists agent pools.

Parameters
Name	Description
request	ListAgentPoolsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListAgentPoolsResponse	The response to send back to the client (wrapped by a task).

ListTransferJobs(ListTransferJobsRequest, ServerCallContext)

public virtual Task<ListTransferJobsResponse> ListTransferJobs(ListTransferJobsRequest request, ServerCallContext context)

Lists transfer jobs.

Parameters
Name	Description
request	ListTransferJobsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListTransferJobsResponse	The response to send back to the client (wrapped by a task).

PauseTransferOperation(PauseTransferOperationRequest, ServerCallContext)

public virtual Task<Empty> PauseTransferOperation(PauseTransferOperationRequest request, ServerCallContext context)

Pauses a transfer operation.

Parameters
Name	Description
request	PauseTransferOperationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

ResumeTransferOperation(ResumeTransferOperationRequest, ServerCallContext)

public virtual Task<Empty> ResumeTransferOperation(ResumeTransferOperationRequest request, ServerCallContext context)

Resumes a transfer operation that is paused.

Parameters
Name	Description
request	ResumeTransferOperationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

RunTransferJob(RunTransferJobRequest, ServerCallContext)

public virtual Task<Operation> RunTransferJob(RunTransferJobRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateAgentPool(UpdateAgentPoolRequest, ServerCallContext)

public virtual Task<AgentPool> UpdateAgentPool(UpdateAgentPoolRequest request, ServerCallContext context)

Updates an existing agent pool resource.

Parameters
Name	Description
request	UpdateAgentPoolRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAgentPool	The response to send back to the client (wrapped by a task).

UpdateTransferJob(UpdateTransferJobRequest, ServerCallContext)

public virtual Task<TransferJob> UpdateTransferJob(UpdateTransferJobRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTransferJob	The response to send back to the client (wrapped by a task).