GoogleApi.BigQueryDataTransfer.V1.Api.Projects.bigquerydatatransfer_projects_transfer_configs_patch

You're seeing just the function bigquerydatatransfer_projects_transfer_configs_patch, go back to GoogleApi.BigQueryDataTransfer.V1.Api.Projects module for more information.
Link to this function

bigquerydatatransfer_projects_transfer_configs_patch(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

bigquerydatatransfer_projects_transfer_configs_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a data transfer configuration. All fields must be set, even if they are not updated.

Parameters

  • connection (type: GoogleApi.BigQueryDataTransfer.V1.Connection.t) - Connection to server
  • name (type: String.t) - The resource name of the transfer config. Transfer config names have the form projects/{project_id}/locations/{region}/transferConfigs/{config_id}. Where config_id is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :authorizationCode (type: String.t) - Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
    • :serviceAccountName (type: String.t) - Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
    • :updateMask (type: String.t) - Required. Required list of fields to be updated in this request.
    • :versionInfo (type: String.t) - Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
    • :body (type: GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryDataTransfer.V1.Model.TransferConfig{}} on success
  • {:error, info} on failure