Struct google_api_proto::google::cloud::bigquery::datatransfer::v1::data_transfer_service_client::DataTransferServiceClient

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

This API allows users to manage their data transfers into BigQuery.

Implementations

impl<T> DataTransferServiceClient<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, ) -> DataTransferServiceClient<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_data_source( &mut self, request: impl IntoRequest<GetDataSourceRequest>, ) -> Result<Response<DataSource>, Status>

Retrieves a supported data source and returns its settings.

pub async fn list_data_sources( &mut self, request: impl IntoRequest<ListDataSourcesRequest>, ) -> Result<Response<ListDataSourcesResponse>, Status>

Lists supported data sources and returns their settings.

pub async fn create_transfer_config( &mut self, request: impl IntoRequest<CreateTransferConfigRequest>, ) -> Result<Response<TransferConfig>, Status>

Creates a new data transfer configuration.

pub async fn update_transfer_config( &mut self, request: impl IntoRequest<UpdateTransferConfigRequest>, ) -> Result<Response<TransferConfig>, Status>

Updates a data transfer configuration. All fields must be set, even if they are not updated.

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

Deletes a data transfer configuration, including any associated transfer runs and logs.

pub async fn get_transfer_config( &mut self, request: impl IntoRequest<GetTransferConfigRequest>, ) -> Result<Response<TransferConfig>, Status>

Returns information about a data transfer config.

pub async fn list_transfer_configs( &mut self, request: impl IntoRequest<ListTransferConfigsRequest>, ) -> Result<Response<ListTransferConfigsResponse>, Status>

Returns information about all transfer configs owned by a project in the specified location.

pub async fn schedule_transfer_runs( &mut self, request: impl IntoRequest<ScheduleTransferRunsRequest>, ) -> Result<Response<ScheduleTransferRunsResponse>, Status>

Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.

pub async fn start_manual_transfer_runs( &mut self, request: impl IntoRequest<StartManualTransferRunsRequest>, ) -> Result<Response<StartManualTransferRunsResponse>, Status>

Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.

pub async fn get_transfer_run( &mut self, request: impl IntoRequest<GetTransferRunRequest>, ) -> Result<Response<TransferRun>, Status>

Returns information about the particular transfer run.

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

Deletes the specified transfer run.

pub async fn list_transfer_runs( &mut self, request: impl IntoRequest<ListTransferRunsRequest>, ) -> Result<Response<ListTransferRunsResponse>, Status>

Returns information about running and completed transfer runs.

pub async fn list_transfer_logs( &mut self, request: impl IntoRequest<ListTransferLogsRequest>, ) -> Result<Response<ListTransferLogsResponse>, Status>

Returns log messages for the transfer run.

pub async fn check_valid_creds( &mut self, request: impl IntoRequest<CheckValidCredsRequest>, ) -> Result<Response<CheckValidCredsResponse>, Status>

Returns true if valid credentials exist for the given data source and requesting user.

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

Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI, and the documents can be found in the public guide for BigQuery Web UI and Data Transfer Service.

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

Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the BigQuery UI. Data transfers configurations of unenrolled data sources will not be scheduled.

Trait Implementations

impl<T: Clone> Clone for DataTransferServiceClient<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for DataTransferServiceClient<T>

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

Formats the value using the given formatter.