Struct google_api_proto::google::ads::googleads::v17::services::batch_job_service_client::BatchJobServiceClient

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

Service to manage batch jobs.

Implementations

impl<T> BatchJobServiceClient<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, ) -> BatchJobServiceClient<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 mutate_batch_job( &mut self, request: impl IntoRequest<MutateBatchJobRequest>, ) -> Result<Response<MutateBatchJobResponse>, Status>

Mutates a batch job.

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError ResourceCountLimitExceededError

pub async fn list_batch_job_results( &mut self, request: impl IntoRequest<ListBatchJobResultsRequest>, ) -> Result<Response<ListBatchJobResultsResponse>, Status>

Returns the results of the batch job. The job must be done. Supports standard list paging.

List of thrown errors: AuthenticationError AuthorizationError BatchJobError HeaderError InternalError QuotaError RequestError

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

Runs the batch job.

The Operation.metadata field type is BatchJobMetadata. When finished, the long running operation will not contain errors or a response. Instead, use ListBatchJobResults to get the results of the job.

List of thrown errors: AuthenticationError AuthorizationError BatchJobError HeaderError InternalError QuotaError RequestError

pub async fn add_batch_job_operations( &mut self, request: impl IntoRequest<AddBatchJobOperationsRequest>, ) -> Result<Response<AddBatchJobOperationsResponse>, Status>

Add operations to the batch job.

List of thrown errors: AuthenticationError AuthorizationError BatchJobError HeaderError InternalError QuotaError RequestError ResourceCountLimitExceededError

Trait Implementations

impl<T: Clone> Clone for BatchJobServiceClient<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BatchJobServiceClient<T>

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

Formats the value using the given formatter.