Struct google_api_proto::google::storagetransfer::v1::storage_transfer_service_client::StorageTransferServiceClient

pub struct StorageTransferServiceClient<T> { /* private fields */ }

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.

Implementations

impl<T> StorageTransferServiceClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F ) -> StorageTransferServiceClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn get_google_service_account( &mut self, request: impl IntoRequest<GetGoogleServiceAccountRequest> ) -> Result<Response<GoogleServiceAccount>, Status>

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.

pub async fn create_transfer_job( &mut self, request: impl IntoRequest<CreateTransferJobRequest> ) -> Result<Response<TransferJob>, Status>

Creates a transfer job that runs periodically.

pub async fn update_transfer_job( &mut self, request: impl IntoRequest<UpdateTransferJobRequest> ) -> Result<Response<TransferJob>, Status>

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

pub async fn get_transfer_job( &mut self, request: impl IntoRequest<GetTransferJobRequest> ) -> Result<Response<TransferJob>, Status>

Gets a transfer job.

pub async fn list_transfer_jobs( &mut self, request: impl IntoRequest<ListTransferJobsRequest> ) -> Result<Response<ListTransferJobsResponse>, Status>

Lists transfer jobs.

pub async fn pause_transfer_operation( &mut self, request: impl IntoRequest<PauseTransferOperationRequest> ) -> Result<Response<()>, Status>

Pauses a transfer operation.

pub async fn resume_transfer_operation( &mut self, request: impl IntoRequest<ResumeTransferOperationRequest> ) -> Result<Response<()>, Status>

Resumes a transfer operation that is paused.

pub async fn run_transfer_job( &mut self, request: impl IntoRequest<RunTransferJobRequest> ) -> Result<Response<Operation>, Status>

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.

pub async fn delete_transfer_job( &mut self, request: impl IntoRequest<DeleteTransferJobRequest> ) -> Result<Response<()>, Status>

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

pub async fn create_agent_pool( &mut self, request: impl IntoRequest<CreateAgentPoolRequest> ) -> Result<Response<AgentPool>, Status>

Creates an agent pool resource.

pub async fn update_agent_pool( &mut self, request: impl IntoRequest<UpdateAgentPoolRequest> ) -> Result<Response<AgentPool>, Status>

Updates an existing agent pool resource.

pub async fn get_agent_pool( &mut self, request: impl IntoRequest<GetAgentPoolRequest> ) -> Result<Response<AgentPool>, Status>

Gets an agent pool.

pub async fn list_agent_pools( &mut self, request: impl IntoRequest<ListAgentPoolsRequest> ) -> Result<Response<ListAgentPoolsResponse>, Status>

Lists agent pools.

pub async fn delete_agent_pool( &mut self, request: impl IntoRequest<DeleteAgentPoolRequest> ) -> Result<Response<()>, Status>

Deletes an agent pool.

Trait Implementations

impl<T: Clone> Clone for StorageTransferServiceClient<T>

fn clone(&self) -> StorageTransferServiceClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for StorageTransferServiceClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.