Struct CreateTransferConfigRequest

#[non_exhaustive]
pub struct CreateTransferConfigRequest {
    pub parent: String,
    pub transfer_config: Option<TransferConfig>,
    pub authorization_code: String,
    pub version_info: String,
    pub service_account_name: String,
}

A request to create a data transfer configuration. If new credentials are needed for this transfer configuration, authorization info must be provided. If authorization info is provided, the transfer configuration will be associated with the user id corresponding to the authorization info. Otherwise, the transfer configuration will be associated with the calling user.

When using a cross project service account for creating a transfer config, you must enable cross project service account usage. For more information, see Disable attachment of service accounts to resources in other projects.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

parent: String

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.

transfer_config: Option<TransferConfig>

Required. Data transfer configuration to create.

authorization_code: String

Deprecated: Authorization code was required when transferConfig.dataSourceId is ‘youtube_channel’ but it is no longer used in any data sources. Use version_info instead.

Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is ‘youtube_channel’ and new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, make a request to the following URL:

• The <var>client_id</var> is the OAuth client_id of the data source as returned by ListDataSources method.
• <var>data_source_scopes</var> are the scopes returned by ListDataSources method.

Note that this should not be set when service_account_name is used to create the transfer config.

version_info: String

Optional version info. This parameter replaces authorization_code which is no longer used in any data sources. This is required only if transferConfig.dataSourceId is ‘youtube_channel’ or new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, make a request to the following URL:

• The <var>client_id</var> is the OAuth client_id of the data source as returned by ListDataSources method.
• <var>data_source_scopes</var> are the scopes returned by ListDataSources method.

Note that this should not be set when service_account_name is used to create the transfer config.

service_account_name: String

Optional service account email. If this field is set, the transfer config will be created with this service account’s credentials. It requires that the requesting user calling this API has permissions to act as this service account.

Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.

Implementations

impl CreateTransferConfigRequest

pub fn new() -> Self

pub fn set_parent<T: Into<String>>(self, v: T) -> Self

Sets the value of parent.

pub fn set_transfer_config<T: Into<Option<TransferConfig>>>(self, v: T) -> Self

Sets the value of transfer_config.

pub fn set_authorization_code<T: Into<String>>(self, v: T) -> Self

Sets the value of authorization_code.

pub fn set_version_info<T: Into<String>>(self, v: T) -> Self

Sets the value of version_info.

pub fn set_service_account_name<T: Into<String>>(self, v: T) -> Self

Sets the value of service_account_name.

Trait Implementations

impl Clone for CreateTransferConfigRequest

fn clone(&self) -> CreateTransferConfigRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateTransferConfigRequest

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

Formats the value using the given formatter.

impl Default for CreateTransferConfigRequest

fn default() -> CreateTransferConfigRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateTransferConfigRequest

where CreateTransferConfigRequest: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for CreateTransferConfigRequest

fn typename() -> &'static str

The typename of this message.

fn to_map(&self) -> Result<Map<String, Value>, AnyError>

where Self: Sized + Serialize,

Store the value into a JSON object.

fn from_map(map: &Map<String, Value>) -> Result<Self, AnyError>

where Self: DeserializeOwned,

Extract the value from a JSON object.

impl PartialEq for CreateTransferConfigRequest

fn eq(&self, other: &CreateTransferConfigRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CreateTransferConfigRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateTransferConfigRequest