Struct google_bigquerydatatransfer1::api::ProjectMethods
source · pub struct ProjectMethods<'a, S>where
S: 'a,{ /* private fields */ }Expand description
A builder providing access to all methods supported on project resources.
It is not used directly, but through the BigQueryDataTransfer hub.
§Example
Instantiate a resource builder
extern crate hyper;
extern crate hyper_rustls;
extern crate google_bigquerydatatransfer1 as bigquerydatatransfer1;
use std::default::Default;
use bigquerydatatransfer1::{BigQueryDataTransfer, 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 = BigQueryDataTransfer::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `data_sources_check_valid_creds(...)`, `data_sources_get(...)`, `data_sources_list(...)`, `enroll_data_sources(...)`, `locations_data_sources_check_valid_creds(...)`, `locations_data_sources_get(...)`, `locations_data_sources_list(...)`, `locations_enroll_data_sources(...)`, `locations_get(...)`, `locations_list(...)`, `locations_transfer_configs_create(...)`, `locations_transfer_configs_delete(...)`, `locations_transfer_configs_get(...)`, `locations_transfer_configs_list(...)`, `locations_transfer_configs_patch(...)`, `locations_transfer_configs_runs_delete(...)`, `locations_transfer_configs_runs_get(...)`, `locations_transfer_configs_runs_list(...)`, `locations_transfer_configs_runs_transfer_logs_list(...)`, `locations_transfer_configs_schedule_runs(...)`, `locations_transfer_configs_start_manual_runs(...)`, `locations_unenroll_data_sources(...)`, `transfer_configs_create(...)`, `transfer_configs_delete(...)`, `transfer_configs_get(...)`, `transfer_configs_list(...)`, `transfer_configs_patch(...)`, `transfer_configs_runs_delete(...)`, `transfer_configs_runs_get(...)`, `transfer_configs_runs_list(...)`, `transfer_configs_runs_transfer_logs_list(...)`, `transfer_configs_schedule_runs(...)` and `transfer_configs_start_manual_runs(...)`
// to build up your call.
let rb = hub.projects();Implementations§
source§impl<'a, S> ProjectMethods<'a, S>
impl<'a, S> ProjectMethods<'a, S>
sourcepub fn data_sources_check_valid_creds(
&self,
request: CheckValidCredsRequest,
name: &str,
) -> ProjectDataSourceCheckValidCredCall<'a, S>
pub fn data_sources_check_valid_creds( &self, request: CheckValidCredsRequest, name: &str, ) -> ProjectDataSourceCheckValidCredCall<'a, S>
Create a builder to help you perform the following task:
Returns true if valid credentials exist for the given data source and requesting user.
§Arguments
request- No description provided.name- Required. The data source in the form:projects/{project_id}/dataSources/{data_source_id}orprojects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.
sourcepub fn data_sources_get(&self, name: &str) -> ProjectDataSourceGetCall<'a, S>
pub fn data_sources_get(&self, name: &str) -> ProjectDataSourceGetCall<'a, S>
Create a builder to help you perform the following task:
Retrieves a supported data source and returns its settings.
§Arguments
name- Required. The field will contain name of the resource requested, for example:projects/{project_id}/dataSources/{data_source_id}orprojects/{project_id}/locations/{location_id}/dataSources/{data_source_id}
sourcepub fn data_sources_list(
&self,
parent: &str,
) -> ProjectDataSourceListCall<'a, S>
pub fn data_sources_list( &self, parent: &str, ) -> ProjectDataSourceListCall<'a, S>
Create a builder to help you perform the following task:
Lists supported data sources and returns their settings.
§Arguments
parent- Required. The BigQuery project id for which data sources should be returned. Must be in the form:projects/{project_id}orprojects/{project_id}/locations/{location_id}
sourcepub fn locations_data_sources_check_valid_creds(
&self,
request: CheckValidCredsRequest,
name: &str,
) -> ProjectLocationDataSourceCheckValidCredCall<'a, S>
pub fn locations_data_sources_check_valid_creds( &self, request: CheckValidCredsRequest, name: &str, ) -> ProjectLocationDataSourceCheckValidCredCall<'a, S>
Create a builder to help you perform the following task:
Returns true if valid credentials exist for the given data source and requesting user.
§Arguments
request- No description provided.name- Required. The data source in the form:projects/{project_id}/dataSources/{data_source_id}orprojects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.
sourcepub fn locations_data_sources_get(
&self,
name: &str,
) -> ProjectLocationDataSourceGetCall<'a, S>
pub fn locations_data_sources_get( &self, name: &str, ) -> ProjectLocationDataSourceGetCall<'a, S>
Create a builder to help you perform the following task:
Retrieves a supported data source and returns its settings.
§Arguments
name- Required. The field will contain name of the resource requested, for example:projects/{project_id}/dataSources/{data_source_id}orprojects/{project_id}/locations/{location_id}/dataSources/{data_source_id}
sourcepub fn locations_data_sources_list(
&self,
parent: &str,
) -> ProjectLocationDataSourceListCall<'a, S>
pub fn locations_data_sources_list( &self, parent: &str, ) -> ProjectLocationDataSourceListCall<'a, S>
Create a builder to help you perform the following task:
Lists supported data sources and returns their settings.
§Arguments
parent- Required. The BigQuery project id for which data sources should be returned. Must be in the form:projects/{project_id}orprojects/{project_id}/locations/{location_id}
sourcepub fn locations_transfer_configs_runs_transfer_logs_list(
&self,
parent: &str,
) -> ProjectLocationTransferConfigRunTransferLogListCall<'a, S>
pub fn locations_transfer_configs_runs_transfer_logs_list( &self, parent: &str, ) -> ProjectLocationTransferConfigRunTransferLogListCall<'a, S>
Create a builder to help you perform the following task:
Returns log messages for the transfer run.
§Arguments
parent- Required. Transfer run name in the form:projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}
sourcepub fn locations_transfer_configs_runs_delete(
&self,
name: &str,
) -> ProjectLocationTransferConfigRunDeleteCall<'a, S>
pub fn locations_transfer_configs_runs_delete( &self, name: &str, ) -> ProjectLocationTransferConfigRunDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes the specified transfer run.
§Arguments
name- Required. The field will contain name of the resource requested, for example:projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}
sourcepub fn locations_transfer_configs_runs_get(
&self,
name: &str,
) -> ProjectLocationTransferConfigRunGetCall<'a, S>
pub fn locations_transfer_configs_runs_get( &self, name: &str, ) -> ProjectLocationTransferConfigRunGetCall<'a, S>
Create a builder to help you perform the following task:
Returns information about the particular transfer run.
§Arguments
name- Required. The field will contain name of the resource requested, for example:projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}
sourcepub fn locations_transfer_configs_runs_list(
&self,
parent: &str,
) -> ProjectLocationTransferConfigRunListCall<'a, S>
pub fn locations_transfer_configs_runs_list( &self, parent: &str, ) -> ProjectLocationTransferConfigRunListCall<'a, S>
Create a builder to help you perform the following task:
Returns information about running and completed transfer runs.
§Arguments
parent- Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is:projects/{project_id}/transferConfigs/{config_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.
sourcepub fn locations_transfer_configs_create(
&self,
request: TransferConfig,
parent: &str,
) -> ProjectLocationTransferConfigCreateCall<'a, S>
pub fn locations_transfer_configs_create( &self, request: TransferConfig, parent: &str, ) -> ProjectLocationTransferConfigCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new data transfer configuration.
§Arguments
request- No description provided.parent- Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.
sourcepub fn locations_transfer_configs_delete(
&self,
name: &str,
) -> ProjectLocationTransferConfigDeleteCall<'a, S>
pub fn locations_transfer_configs_delete( &self, name: &str, ) -> ProjectLocationTransferConfigDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a data transfer configuration, including any associated transfer runs and logs.
§Arguments
name- Required. The field will contain name of the resource requested, for example:projects/{project_id}/transferConfigs/{config_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
sourcepub fn locations_transfer_configs_get(
&self,
name: &str,
) -> ProjectLocationTransferConfigGetCall<'a, S>
pub fn locations_transfer_configs_get( &self, name: &str, ) -> ProjectLocationTransferConfigGetCall<'a, S>
Create a builder to help you perform the following task:
Returns information about a data transfer config.
§Arguments
name- Required. The field will contain name of the resource requested, for example:projects/{project_id}/transferConfigs/{config_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
sourcepub fn locations_transfer_configs_list(
&self,
parent: &str,
) -> ProjectLocationTransferConfigListCall<'a, S>
pub fn locations_transfer_configs_list( &self, parent: &str, ) -> ProjectLocationTransferConfigListCall<'a, S>
Create a builder to help you perform the following task:
Returns information about all transfer configs owned by a project in the specified location.
§Arguments
parent- Required. The BigQuery project id for which transfer configs should be returned:projects/{project_id}orprojects/{project_id}/locations/{location_id}
sourcepub fn locations_transfer_configs_patch(
&self,
request: TransferConfig,
name: &str,
) -> ProjectLocationTransferConfigPatchCall<'a, S>
pub fn locations_transfer_configs_patch( &self, request: TransferConfig, name: &str, ) -> ProjectLocationTransferConfigPatchCall<'a, S>
Create a builder to help you perform the following task:
Updates a data transfer configuration. All fields must be set, even if they are not updated.
§Arguments
request- No description provided.name- Identifier. The resource name of the transfer config. Transfer config names have the form eitherprojects/{project_id}/locations/{region}/transferConfigs/{config_id}orprojects/{project_id}/transferConfigs/{config_id}, whereconfig_idis usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
sourcepub fn locations_transfer_configs_schedule_runs(
&self,
request: ScheduleTransferRunsRequest,
parent: &str,
) -> ProjectLocationTransferConfigScheduleRunCall<'a, S>
pub fn locations_transfer_configs_schedule_runs( &self, request: ScheduleTransferRunsRequest, parent: &str, ) -> ProjectLocationTransferConfigScheduleRunCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request- No description provided.parent- Required. Transfer configuration name in the form:projects/{project_id}/transferConfigs/{config_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.
sourcepub fn locations_transfer_configs_start_manual_runs(
&self,
request: StartManualTransferRunsRequest,
parent: &str,
) -> ProjectLocationTransferConfigStartManualRunCall<'a, S>
pub fn locations_transfer_configs_start_manual_runs( &self, request: StartManualTransferRunsRequest, parent: &str, ) -> ProjectLocationTransferConfigStartManualRunCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request- No description provided.parent- Required. Transfer configuration name in the form:projects/{project_id}/transferConfigs/{config_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.
sourcepub fn locations_enroll_data_sources(
&self,
request: EnrollDataSourcesRequest,
name: &str,
) -> ProjectLocationEnrollDataSourceCall<'a, S>
pub fn locations_enroll_data_sources( &self, request: EnrollDataSourcesRequest, name: &str, ) -> ProjectLocationEnrollDataSourceCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request- No description provided.name- Required. The name of the project resource in the form:projects/{project_id}
sourcepub fn locations_get(&self, name: &str) -> ProjectLocationGetCall<'a, S>
pub fn locations_get(&self, name: &str) -> ProjectLocationGetCall<'a, S>
Create a builder to help you perform the following task:
Gets information about a location.
§Arguments
name- Resource name for the location.
sourcepub fn locations_list(&self, name: &str) -> ProjectLocationListCall<'a, S>
pub fn locations_list(&self, name: &str) -> ProjectLocationListCall<'a, S>
Create a builder to help you perform the following task:
Lists information about the supported locations for this service.
§Arguments
name- The resource that owns the locations collection, if applicable.
sourcepub fn locations_unenroll_data_sources(
&self,
request: UnenrollDataSourcesRequest,
name: &str,
) -> ProjectLocationUnenrollDataSourceCall<'a, S>
pub fn locations_unenroll_data_sources( &self, request: UnenrollDataSourcesRequest, name: &str, ) -> ProjectLocationUnenrollDataSourceCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request- No description provided.name- Required. The name of the project resource in the form:projects/{project_id}
sourcepub fn transfer_configs_runs_transfer_logs_list(
&self,
parent: &str,
) -> ProjectTransferConfigRunTransferLogListCall<'a, S>
pub fn transfer_configs_runs_transfer_logs_list( &self, parent: &str, ) -> ProjectTransferConfigRunTransferLogListCall<'a, S>
Create a builder to help you perform the following task:
Returns log messages for the transfer run.
§Arguments
parent- Required. Transfer run name in the form:projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}
sourcepub fn transfer_configs_runs_delete(
&self,
name: &str,
) -> ProjectTransferConfigRunDeleteCall<'a, S>
pub fn transfer_configs_runs_delete( &self, name: &str, ) -> ProjectTransferConfigRunDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes the specified transfer run.
§Arguments
name- Required. The field will contain name of the resource requested, for example:projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}
sourcepub fn transfer_configs_runs_get(
&self,
name: &str,
) -> ProjectTransferConfigRunGetCall<'a, S>
pub fn transfer_configs_runs_get( &self, name: &str, ) -> ProjectTransferConfigRunGetCall<'a, S>
Create a builder to help you perform the following task:
Returns information about the particular transfer run.
§Arguments
name- Required. The field will contain name of the resource requested, for example:projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}
sourcepub fn transfer_configs_runs_list(
&self,
parent: &str,
) -> ProjectTransferConfigRunListCall<'a, S>
pub fn transfer_configs_runs_list( &self, parent: &str, ) -> ProjectTransferConfigRunListCall<'a, S>
Create a builder to help you perform the following task:
Returns information about running and completed transfer runs.
§Arguments
parent- Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is:projects/{project_id}/transferConfigs/{config_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.
sourcepub fn transfer_configs_create(
&self,
request: TransferConfig,
parent: &str,
) -> ProjectTransferConfigCreateCall<'a, S>
pub fn transfer_configs_create( &self, request: TransferConfig, parent: &str, ) -> ProjectTransferConfigCreateCall<'a, S>
Create a builder to help you perform the following task:
Creates a new data transfer configuration.
§Arguments
request- No description provided.parent- Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.
sourcepub fn transfer_configs_delete(
&self,
name: &str,
) -> ProjectTransferConfigDeleteCall<'a, S>
pub fn transfer_configs_delete( &self, name: &str, ) -> ProjectTransferConfigDeleteCall<'a, S>
Create a builder to help you perform the following task:
Deletes a data transfer configuration, including any associated transfer runs and logs.
§Arguments
name- Required. The field will contain name of the resource requested, for example:projects/{project_id}/transferConfigs/{config_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
sourcepub fn transfer_configs_get(
&self,
name: &str,
) -> ProjectTransferConfigGetCall<'a, S>
pub fn transfer_configs_get( &self, name: &str, ) -> ProjectTransferConfigGetCall<'a, S>
Create a builder to help you perform the following task:
Returns information about a data transfer config.
§Arguments
name- Required. The field will contain name of the resource requested, for example:projects/{project_id}/transferConfigs/{config_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
sourcepub fn transfer_configs_list(
&self,
parent: &str,
) -> ProjectTransferConfigListCall<'a, S>
pub fn transfer_configs_list( &self, parent: &str, ) -> ProjectTransferConfigListCall<'a, S>
Create a builder to help you perform the following task:
Returns information about all transfer configs owned by a project in the specified location.
§Arguments
parent- Required. The BigQuery project id for which transfer configs should be returned:projects/{project_id}orprojects/{project_id}/locations/{location_id}
sourcepub fn transfer_configs_patch(
&self,
request: TransferConfig,
name: &str,
) -> ProjectTransferConfigPatchCall<'a, S>
pub fn transfer_configs_patch( &self, request: TransferConfig, name: &str, ) -> ProjectTransferConfigPatchCall<'a, S>
Create a builder to help you perform the following task:
Updates a data transfer configuration. All fields must be set, even if they are not updated.
§Arguments
request- No description provided.name- Identifier. The resource name of the transfer config. Transfer config names have the form eitherprojects/{project_id}/locations/{region}/transferConfigs/{config_id}orprojects/{project_id}/transferConfigs/{config_id}, whereconfig_idis usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
sourcepub fn transfer_configs_schedule_runs(
&self,
request: ScheduleTransferRunsRequest,
parent: &str,
) -> ProjectTransferConfigScheduleRunCall<'a, S>
pub fn transfer_configs_schedule_runs( &self, request: ScheduleTransferRunsRequest, parent: &str, ) -> ProjectTransferConfigScheduleRunCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request- No description provided.parent- Required. Transfer configuration name in the form:projects/{project_id}/transferConfigs/{config_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.
sourcepub fn transfer_configs_start_manual_runs(
&self,
request: StartManualTransferRunsRequest,
parent: &str,
) -> ProjectTransferConfigStartManualRunCall<'a, S>
pub fn transfer_configs_start_manual_runs( &self, request: StartManualTransferRunsRequest, parent: &str, ) -> ProjectTransferConfigStartManualRunCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request- No description provided.parent- Required. Transfer configuration name in the form:projects/{project_id}/transferConfigs/{config_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.
sourcepub fn enroll_data_sources(
&self,
request: EnrollDataSourcesRequest,
name: &str,
) -> ProjectEnrollDataSourceCall<'a, S>
pub fn enroll_data_sources( &self, request: EnrollDataSourcesRequest, name: &str, ) -> ProjectEnrollDataSourceCall<'a, S>
Create a builder to help you perform the following task:
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.
§Arguments
request- No description provided.name- Required. The name of the project resource in the form:projects/{project_id}
Trait Implementations§
impl<'a, S> MethodsBuilder for ProjectMethods<'a, S>
Auto Trait Implementations§
impl<'a, S> Freeze for ProjectMethods<'a, S>
impl<'a, S> !RefUnwindSafe for ProjectMethods<'a, S>
impl<'a, S> Send for ProjectMethods<'a, S>where
S: Sync,
impl<'a, S> Sync for ProjectMethods<'a, S>where
S: Sync,
impl<'a, S> Unpin for ProjectMethods<'a, S>
impl<'a, S> !UnwindSafe for ProjectMethods<'a, S>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more