Struct google_api_proto::google::cloud::bigquery::datatransfer::v1::CreateTransferConfigRequest

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.

Fields

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

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:

client_id&scope=data_source_scopes>

• The client_id is the OAuth client_id of the data source as returned by ListDataSources method.
• data_source_scopes 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:

client_id&scope=data_source_scopes>

• The client_id is the OAuth client_id of the data source as returned by ListDataSources method.
• data_source_scopes 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.

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() -> Self

Returns the “default value” for a type.

impl Message for CreateTransferConfigRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CreateTransferConfigRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CreateTransferConfigRequest