Class StorageTransferService.StorageTransferServiceClient (1.0.0)

Version 1.0.0

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

public class StorageTransferServiceClient : ClientBase<StorageTransferService.StorageTransferServiceClient>

Client for StorageTransferService

Inheritance

Object > ClientBase > ClientBase<StorageTransferService.StorageTransferServiceClient> > StorageTransferService.StorageTransferServiceClient

Inherited Members

ClientBase<StorageTransferService.StorageTransferServiceClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.StorageTransfer.V1

Assembly

Google.Cloud.StorageTransfer.V1.dll

Constructors

StorageTransferServiceClient()

protected StorageTransferServiceClient()

Protected parameterless constructor to allow creation of test doubles.

StorageTransferServiceClient(CallInvoker)

public StorageTransferServiceClient(CallInvoker callInvoker)

Creates a new client for StorageTransferService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

StorageTransferServiceClient(ChannelBase)

public StorageTransferServiceClient(ChannelBase channel)

Creates a new client for StorageTransferService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

StorageTransferServiceClient(ClientBase.ClientBaseConfiguration)

protected StorageTransferServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration The client configuration.

Methods

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
Operations.OperationsClient	A new Operations client for the same target as this client.

CreateTransferJob(CreateTransferJobRequest, CallOptions)

public virtual TransferJob CreateTransferJob(CreateTransferJobRequest request, CallOptions options)

Creates a transfer job that runs periodically.

Parameters
Name	Description
request	CreateTransferJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TransferJob	The response received from the server.

CreateTransferJob(CreateTransferJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual TransferJob CreateTransferJob(CreateTransferJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a transfer job that runs periodically.

Parameters
Name	Description
request	CreateTransferJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
TransferJob	The response received from the server.

CreateTransferJobAsync(CreateTransferJobRequest, CallOptions)

public virtual AsyncUnaryCall<TransferJob> CreateTransferJobAsync(CreateTransferJobRequest request, CallOptions options)

Creates a transfer job that runs periodically.

Parameters
Name	Description
request	CreateTransferJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<TransferJob>	The call object.

CreateTransferJobAsync(CreateTransferJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<TransferJob> CreateTransferJobAsync(CreateTransferJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a transfer job that runs periodically.

Parameters
Name	Description
request	CreateTransferJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<TransferJob>	The call object.

GetGoogleServiceAccount(GetGoogleServiceAccountRequest, CallOptions)

public virtual GoogleServiceAccount GetGoogleServiceAccount(GetGoogleServiceAccountRequest request, CallOptions options)

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.

Parameters
Name	Description
request	GetGoogleServiceAccountRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
GoogleServiceAccount	The response received from the server.

GetGoogleServiceAccount(GetGoogleServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual GoogleServiceAccount GetGoogleServiceAccount(GetGoogleServiceAccountRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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.

Parameters
Name	Description
request	GetGoogleServiceAccountRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
GoogleServiceAccount	The response received from the server.

GetGoogleServiceAccountAsync(GetGoogleServiceAccountRequest, CallOptions)

public virtual AsyncUnaryCall<GoogleServiceAccount> GetGoogleServiceAccountAsync(GetGoogleServiceAccountRequest request, CallOptions options)

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.

Parameters
Name	Description
request	GetGoogleServiceAccountRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<GoogleServiceAccount>	The call object.

GetGoogleServiceAccountAsync(GetGoogleServiceAccountRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<GoogleServiceAccount> GetGoogleServiceAccountAsync(GetGoogleServiceAccountRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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.

Parameters
Name	Description
request	GetGoogleServiceAccountRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<GoogleServiceAccount>	The call object.

GetTransferJob(GetTransferJobRequest, CallOptions)

public virtual TransferJob GetTransferJob(GetTransferJobRequest request, CallOptions options)

Gets a transfer job.

Parameters
Name	Description
request	GetTransferJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TransferJob	The response received from the server.

GetTransferJob(GetTransferJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual TransferJob GetTransferJob(GetTransferJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets a transfer job.

Parameters
Name	Description
request	GetTransferJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
TransferJob	The response received from the server.

GetTransferJobAsync(GetTransferJobRequest, CallOptions)

public virtual AsyncUnaryCall<TransferJob> GetTransferJobAsync(GetTransferJobRequest request, CallOptions options)

Gets a transfer job.

Parameters
Name	Description
request	GetTransferJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<TransferJob>	The call object.

GetTransferJobAsync(GetTransferJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<TransferJob> GetTransferJobAsync(GetTransferJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets a transfer job.

Parameters
Name	Description
request	GetTransferJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<TransferJob>	The call object.

ListTransferJobs(ListTransferJobsRequest, CallOptions)

public virtual ListTransferJobsResponse ListTransferJobs(ListTransferJobsRequest request, CallOptions options)

Lists transfer jobs.

Parameters
Name	Description
request	ListTransferJobsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListTransferJobsResponse	The response received from the server.

ListTransferJobs(ListTransferJobsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListTransferJobsResponse ListTransferJobs(ListTransferJobsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists transfer jobs.

Parameters
Name	Description
request	ListTransferJobsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListTransferJobsResponse	The response received from the server.

ListTransferJobsAsync(ListTransferJobsRequest, CallOptions)

public virtual AsyncUnaryCall<ListTransferJobsResponse> ListTransferJobsAsync(ListTransferJobsRequest request, CallOptions options)

Lists transfer jobs.

Parameters
Name	Description
request	ListTransferJobsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<ListTransferJobsResponse>	The call object.

ListTransferJobsAsync(ListTransferJobsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListTransferJobsResponse> ListTransferJobsAsync(ListTransferJobsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists transfer jobs.

Parameters
Name	Description
request	ListTransferJobsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<ListTransferJobsResponse>	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override StorageTransferService.StorageTransferServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration

Returns
Type	Description
StorageTransferService.StorageTransferServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.StorageTransfer.V1.StorageTransferService.StorageTransferServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

PauseTransferOperation(PauseTransferOperationRequest, CallOptions)

public virtual Empty PauseTransferOperation(PauseTransferOperationRequest request, CallOptions options)

Pauses a transfer operation.

Parameters
Name	Description
request	PauseTransferOperationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

PauseTransferOperation(PauseTransferOperationRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty PauseTransferOperation(PauseTransferOperationRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Pauses a transfer operation.

Parameters
Name	Description
request	PauseTransferOperationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

PauseTransferOperationAsync(PauseTransferOperationRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> PauseTransferOperationAsync(PauseTransferOperationRequest request, CallOptions options)

Pauses a transfer operation.

Parameters
Name	Description
request	PauseTransferOperationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Empty>	The call object.

PauseTransferOperationAsync(PauseTransferOperationRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> PauseTransferOperationAsync(PauseTransferOperationRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Pauses a transfer operation.

Parameters
Name	Description
request	PauseTransferOperationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Empty>	The call object.

ResumeTransferOperation(ResumeTransferOperationRequest, CallOptions)

public virtual Empty ResumeTransferOperation(ResumeTransferOperationRequest request, CallOptions options)

Resumes a transfer operation that is paused.

Parameters
Name	Description
request	ResumeTransferOperationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

ResumeTransferOperation(ResumeTransferOperationRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty ResumeTransferOperation(ResumeTransferOperationRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Resumes a transfer operation that is paused.

Parameters
Name	Description
request	ResumeTransferOperationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

ResumeTransferOperationAsync(ResumeTransferOperationRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> ResumeTransferOperationAsync(ResumeTransferOperationRequest request, CallOptions options)

Resumes a transfer operation that is paused.

Parameters
Name	Description
request	ResumeTransferOperationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Empty>	The call object.

ResumeTransferOperationAsync(ResumeTransferOperationRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> ResumeTransferOperationAsync(ResumeTransferOperationRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Resumes a transfer operation that is paused.

Parameters
Name	Description
request	ResumeTransferOperationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Empty>	The call object.

RunTransferJob(RunTransferJobRequest, CallOptions)

public virtual Operation RunTransferJob(RunTransferJobRequest request, CallOptions options)

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.

Parameters
Name	Description
request	RunTransferJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

RunTransferJob(RunTransferJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation RunTransferJob(RunTransferJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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.

Parameters
Name	Description
request	RunTransferJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

RunTransferJobAsync(RunTransferJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RunTransferJobAsync(RunTransferJobRequest request, CallOptions options)

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.

Parameters
Name	Description
request	RunTransferJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

RunTransferJobAsync(RunTransferJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> RunTransferJobAsync(RunTransferJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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.

Parameters
Name	Description
request	RunTransferJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

UpdateTransferJob(UpdateTransferJobRequest, CallOptions)

public virtual TransferJob UpdateTransferJob(UpdateTransferJobRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TransferJob	The response received from the server.

UpdateTransferJob(UpdateTransferJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual TransferJob UpdateTransferJob(UpdateTransferJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
TransferJob	The response received from the server.

UpdateTransferJobAsync(UpdateTransferJobRequest, CallOptions)

public virtual AsyncUnaryCall<TransferJob> UpdateTransferJobAsync(UpdateTransferJobRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<TransferJob>	The call object.

UpdateTransferJobAsync(UpdateTransferJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<TransferJob> UpdateTransferJobAsync(UpdateTransferJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCall<TransferJob>	The call object.