Struct google_storagetransfer1::api::TransferOperationMethods

source ·

pub struct TransferOperationMethods<'a, S>where
    S: 'a,
{ /* private fields */ }

Expand description

A builder providing access to all methods supported on transferOperation resources. It is not used directly, but through the Storagetransfer hub.

§Example

Instantiate a resource builder

extern crate hyper;
extern crate hyper_rustls;
extern crate google_storagetransfer1 as storagetransfer1;
 
use std::default::Default;
use storagetransfer1::{Storagetransfer, oauth2, hyper, hyper_rustls, chrono, FieldMask};
 
let secret: oauth2::ApplicationSecret = Default::default();
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = Storagetransfer::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `cancel(...)`, `get(...)`, `list(...)`, `pause(...)` and `resume(...)`
// to build up your call.
let rb = hub.transfer_operations();

Implementations§

source §

impl<'a, S> TransferOperationMethods<'a, S>

source

pub fn cancel( &self, request: CancelOperationRequest, name: &str ) -> TransferOperationCancelCall<'a, S>

Create a builder to help you perform the following task:

Cancels a transfer. Use the transferOperations.get method to check if the cancellation succeeded or if the operation completed despite the cancel request. When you cancel an operation, the currently running transfer is interrupted. For recurring transfer jobs, the next instance of the transfer job will still run. For example, if your job is configured to run every day at 1pm and you cancel Monday’s operation at 1:05pm, Monday’s transfer will stop. However, a transfer job will still be attempted on Tuesday. This applies only to currently running operations. If an operation is not currently running, cancel does nothing. Caution: Canceling a transfer job can leave your data in an unknown state. We recommend that you restore the state at both the destination and the source after the cancel request completes so that your data is in a consistent state. When you cancel a job, the next job computes a delta of files and may repair any inconsistent state. For instance, if you run a job every day, and today’s job found 10 new files and transferred five files before you canceled the job, tomorrow’s transfer operation will compute a new delta with the five files that were not copied today plus any new files discovered tomorrow.

§Arguments

request - No description provided.
name - The name of the operation resource to be cancelled.

source

pub fn get(&self, name: &str) -> TransferOperationGetCall<'a, S>

Create a builder to help you perform the following task:

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

§Arguments

name - The name of the operation resource.

source

pub fn list(&self, name: &str, filter: &str) -> TransferOperationListCall<'a, S>

Create a builder to help you perform the following task:

Lists transfer operations. Operations are ordered by their creation time in reverse chronological order.

§Arguments

name - Required. The name of the type being listed; must be transferOperations.
filter - Required. A list of query parameters specified as JSON text in the form of: {"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobNamePattern": "job_name_pattern", "operationNames":["opid1","opid2",...], "operationNamePattern": "operation_name_pattern", "minCreationTime": "min_creation_time", "maxCreationTime": "max_creation_time", "transferStatuses":["status1","status2",...]} Since jobNames, operationNames, and transferStatuses support multiple values, they must be specified with array notation. projectId is the only argument that is required. If specified, jobNamePattern and operationNamePattern must match the full job or operation name respectively. ‘*’ is a wildcard matching 0 or more characters. minCreationTime and maxCreationTime should be timestamps encoded as a string in the RFC 3339 format. The valid values for transferStatuses are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.