Struct google_storagetransfer1::api::TransferJobMethods
source · pub struct TransferJobMethods<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
A builder providing access to all methods supported on transferJob 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 `create(...)`, `delete(...)`, `get(...)`, `list(...)`, `patch(...)` and `run(...)`
// to build up your call.
let rb = hub.transfer_jobs();
Implementations§
source§impl<'a, S> TransferJobMethods<'a, S>
impl<'a, S> TransferJobMethods<'a, S>
sourcepub fn create(&self, request: TransferJob) -> TransferJobCreateCall<'a, S>
pub fn create(&self, request: TransferJob) -> TransferJobCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a transfer job that runs periodically.
§Arguments
request
- No description provided.
sourcepub fn delete(
&self,
job_name: &str,
project_id: &str
) -> TransferJobDeleteCall<'a, S>
pub fn delete( &self, job_name: &str, project_id: &str ) -> TransferJobDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a transfer job. Deleting a transfer job sets its status to DELETED.
§Arguments
jobName
- Required. The job to delete.projectId
- Required. The ID of the Google Cloud project that owns the job.
sourcepub fn get(&self, job_name: &str, project_id: &str) -> TransferJobGetCall<'a, S>
pub fn get(&self, job_name: &str, project_id: &str) -> TransferJobGetCall<'a, S>
Create a builder to help you perform the following task:
Gets a transfer job.
§Arguments
jobName
- Required. The job to get.projectId
- Required. The ID of the Google Cloud project that owns the job.
sourcepub fn list(&self, filter: &str) -> TransferJobListCall<'a, S>
pub fn list(&self, filter: &str) -> TransferJobListCall<'a, S>
Create a builder to help you perform the following task:
Lists transfer jobs.
§Arguments
filter
- Required. A list of query parameters specified as JSON text in the form of:{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobStatuses":["status1","status2",...]}
SincejobNames
andjobStatuses
support multiple values, their values must be specified with array notation.projectId
is required.jobNames
andjobStatuses
are optional. The valid values forjobStatuses
are case-insensitive: ENABLED, DISABLED, and DELETED.
sourcepub fn patch(
&self,
request: UpdateTransferJobRequest,
job_name: &str
) -> TransferJobPatchCall<'a, S>
pub fn patch( &self, request: UpdateTransferJobRequest, job_name: &str ) -> TransferJobPatchCall<'a, S>
Create a builder to help you perform the following task:
Updates a transfer job. Updating a job’s transfer spec does not affect transfer operations that are running already. Note: The job’s status field can be modified using this RPC (for example, to set a job’s status to DELETED, DISABLED, or ENABLED).
§Arguments
request
- No description provided.jobName
- Required. The name of job to update.
sourcepub fn run(
&self,
request: RunTransferJobRequest,
job_name: &str
) -> TransferJobRunCall<'a, S>
pub fn run( &self, request: RunTransferJobRequest, job_name: &str ) -> TransferJobRunCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request
- No description provided.jobName
- Required. The name of the transfer job.