2021-01-01 03:01:13 +00:00
|
|
|
# Copyright 2020 Google LLC
|
|
|
|
|
#
|
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
|
#
|
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
#
|
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
|
# limitations under the License.
|
|
|
|
|
|
|
|
|
|
require 'google/apis/core/base_service'
|
|
|
|
|
require 'google/apis/core/json_representation'
|
|
|
|
|
require 'google/apis/core/hashable'
|
|
|
|
|
require 'google/apis/errors'
|
|
|
|
|
|
|
|
|
|
module Google
|
|
|
|
|
module Apis
|
|
|
|
|
module BigquerydatatransferV1
|
|
|
|
|
# BigQuery Data Transfer API
|
|
|
|
|
#
|
|
|
|
|
# Schedule queries or transfer external data from SaaS applications to Google
|
|
|
|
|
# BigQuery on a regular basis.
|
|
|
|
|
#
|
|
|
|
|
# @example
|
|
|
|
|
# require 'google/apis/bigquerydatatransfer_v1'
|
|
|
|
|
#
|
|
|
|
|
# Bigquerydatatransfer = Google::Apis::BigquerydatatransferV1 # Alias the module
|
|
|
|
|
# service = Bigquerydatatransfer::BigQueryDataTransferService.new
|
|
|
|
|
#
|
feat: Automated regeneration of bigquerydatatransfer v1 client (#2428)
This PR was generated using Autosynth. :rainbow:
<details><summary>Log from Synthtool</summary>
```
2021-01-19 15:31:52,074 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-bigquerydatatransfer-v1
nothing to commit, working tree clean
2021-01-19 15:31:52,154 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth bigquerydatatransfer v1
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth bigquerydatatransfer v1
git clean -df
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Fetching zeitwerk 2.4.2
Fetching minitest 5.14.3
Fetching public_suffix 4.0.6
Installing zeitwerk 2.4.2
Installing minitest 5.14.3
Installing public_suffix 4.0.6
Installing concurrent-ruby 1.1.7
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.2.6
Fetching byebug 11.1.3
Fetching coderay 1.1.3
Fetching json 2.5.1
Installing byebug 11.1.3 with native extensions
Installing coderay 1.1.3
Installing json 2.5.1 with native extensions
Fetching docile 1.3.5
Installing docile 1.3.5
Fetching simplecov-html 0.10.2
Installing simplecov-html 0.10.2
Using sync 0.5.0
Fetching thor 1.0.1
Fetching rexml 3.2.4
Installing thor 1.0.1
Installing rexml 3.2.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Fetching declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing declarative-option 0.1.0
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Fetching faraday-net_http 1.0.1
Installing fakefs 0.20.1
Installing faraday-net_http 1.0.1
Fetching multipart-post 2.1.1
Fetching ruby2_keywords 0.0.4
Installing multipart-post 2.1.1
Installing ruby2_keywords 0.0.4
Fetching gems 1.2.0
Fetching github-markup 1.7.0
Installing gems 1.2.0
Fetching jwt 2.2.2
Installing github-markup 1.7.0
Fetching memoist 0.16.2
Installing jwt 2.2.2
Installing memoist 0.16.2
Fetching os 0.9.6
Fetching multi_json 1.15.0
Installing os 0.9.6
Installing multi_json 1.15.0
Fetching httpclient 2.8.3
Fetching mini_mime 1.0.2
Installing httpclient 2.8.3
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching hashdiff 1.0.1
Installing hashdiff 1.0.1
Fetching mime-types-data 3.2020.1104
Installing mime-types-data 3.2020.1104
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Fetching rspec-support 3.10.1
Installing rspec-support 3.10.1
Fetching little-plugger 1.1.4
Fetching method_source 1.0.0
Installing little-plugger 1.1.4
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching powerpack 0.1.3
Fetching parallel 1.20.1
Installing parallel 1.20.1
Installing powerpack 0.1.3
Fetching yard 0.9.26
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Installing yard 0.9.26
Fetching redcarpet 3.5.1
Installing redcarpet 3.5.1 with native extensions
Fetching redis 3.3.5
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.11.0
Installing ruby-progressbar 1.11.0
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching parser 2.7.2.0
Fetching addressable 2.7.0
Installing addressable 2.7.0
Installing parser 2.7.2.0
Fetching i18n 1.8.7
Installing i18n 1.8.7
Fetching tzinfo 2.0.4
Installing tzinfo 2.0.4
Fetching tins 1.28.0
Installing tins 1.28.0
Fetching crack 0.4.5
Installing crack 0.4.5
Fetching faraday 1.3.0
Installing faraday 1.3.0
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching pry 0.13.1
Fetching rspec-core 3.10.1
Installing pry 0.13.1
Installing rspec-core 3.10.1
Fetching rspec-expectations 3.10.1
Installing rspec-expectations 3.10.1
Fetching rspec-mocks 3.10.1
Installing rspec-mocks 3.10.1
Fetching launchy 2.5.0
Fetching simplecov 0.16.1
Installing launchy 2.5.0
Installing simplecov 0.16.1
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching activesupport 6.1.1
Fetching webmock 2.3.2
Fetching signet 0.14.0
Installing activesupport 6.1.1
Installing signet 0.14.0
Installing webmock 2.3.2
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching pry-doc 0.13.5
Fetching rspec 3.10.0
Installing rspec 3.10.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Installing pry-doc 0.13.5
Fetching google-apis-core 0.2.0
Installing google-apis-core 0.2.0
Fetching google-apis-discovery_v1 0.1.0
Installing google-apis-discovery_v1 0.1.0
Using google-apis-generator 0.1.2 from source at `.`
Bundle complete! 25 Gemfile dependencies, 81 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
If you are upgrading your Rails application from an older version of Rails:
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
If you are starting a NEW Rails application, you can ignore this notice.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen /workspace/generated --api=bigquerydatatransfer.v1 --names=/workspace/api_names.yaml --names-out=/workspace/api_names_out.yaml --spot-check
Loading bigquerydatatransfer, version v1 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/bigquerydatatransfer.v1.json
conflict google-apis-bigquerydatatransfer_v1/OVERVIEW.md
<fer_v1/OVERVIEW.md? (enter "h" for help) [Ynaqdhm] a
force google-apis-bigquerydatatransfer_v1/OVERVIEW.md
conflict google-apis-bigquerydatatransfer_v1/lib/google/apis/bigquerydatatransfer_v1.rb
force google-apis-bigquerydatatransfer_v1/lib/google/apis/bigquerydatatransfer_v1.rb
conflict google-apis-bigquerydatatransfer_v1/lib/google/apis/bigquerydatatransfer_v1/service.rb
force google-apis-bigquerydatatransfer_v1/lib/google/apis/bigquerydatatransfer_v1/service.rb
conflict google-apis-bigquerydatatransfer_v1/lib/google/apis/bigquerydatatransfer_v1/gem_version.rb
force google-apis-bigquerydatatransfer_v1/lib/google/apis/bigquerydatatransfer_v1/gem_version.rb
conflict google-apis-bigquerydatatransfer_v1/CHANGELOG.md
force google-apis-bigquerydatatransfer_v1/CHANGELOG.md
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Using rake 13.0.3
Using public_suffix 4.0.6
Using bundler 2.2.6
Using declarative 0.0.20
Using declarative-option 0.1.0
Using diff-lcs 1.4.4
Using faraday-net_http 1.0.1
Using multipart-post 2.1.1
Using ruby2_keywords 0.0.4
Using jwt 2.2.2
Using memoist 0.16.2
Using multi_json 1.15.0
Using httpclient 2.8.3
Using mini_mime 1.0.2
Using uber 0.1.0
Using retriable 3.1.2
Using rexml 3.2.4
Using opencensus 0.5.0
Fetching os 1.1.1
Using redcarpet 3.5.1
Using rspec-support 3.10.1
Using yard 0.9.26
Using addressable 2.7.0
Using representable 3.0.4
Using rspec-core 3.10.1
Using faraday 1.3.0
Using rspec-expectations 3.10.1
Using rspec-mocks 3.10.1
Using signet 0.14.0
Using rspec 3.10.0
Installing os 1.1.1
Using googleauth 0.14.0
Using google-apis-core 0.2.0
Using google-apis-bigquerydatatransfer_v1 0.2.0 from source at `.`
Bundle complete! 8 Gemfile dependencies, 33 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
/root/.rbenv/versions/2.6.6/bin/ruby -I/root/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/rspec-core-3.10.1/lib:/root/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/rspec-support-3.10.1/lib /root/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/rspec-core-3.10.1/exe/rspec --pattern spec/\*\*\{,/\*/\*\*\}/\*_spec.rb
Google::Apis::BigquerydatatransferV1
should load
Finished in 0.33672 seconds (files took 0.10852 seconds to load)
1 example, 0 failures
Files: 4
Modules: 3 ( 1 undocumented)
Classes: 23 ( 0 undocumented)
Constants: 8 ( 0 undocumented)
Attributes: 73 ( 0 undocumented)
Methods: 75 ( 0 undocumented)
99.45% documented
google-apis-bigquerydatatransfer_v1 0.2.0 built to pkg/google-apis-bigquerydatatransfer_v1-0.2.0.gem.
identical /workspace/api_names_out.yaml
2021-01-19 15:32:23,594 synthtool [DEBUG] > Wrote metadata to generated/google-apis-bigquerydatatransfer_v1/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google-apis-bigquerydatatransfer_v1/synth.metadata.
```
</details>
Full log will be available here:
https://source.cloud.google.com/results/invocations/b9a73516-7203-45da-9706-97b9e64348be/targets
- [ ] To automatically regenerate this PR, check this box.
2021-01-19 23:46:05 +00:00
|
|
|
# @see https://cloud.google.com/bigquery-transfer/
|
2021-01-01 03:01:13 +00:00
|
|
|
class BigQueryDataTransferService < Google::Apis::Core::BaseService
|
|
|
|
|
# @return [String]
|
|
|
|
|
# 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.
|
|
|
|
|
attr_accessor :key
|
|
|
|
|
|
|
|
|
|
# @return [String]
|
|
|
|
|
# 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.
|
|
|
|
|
attr_accessor :quota_user
|
|
|
|
|
|
|
|
|
|
def initialize
|
2021-01-01 17:40:59 +00:00
|
|
|
super('https://bigquerydatatransfer.googleapis.com/', '',
|
|
|
|
|
client_name: 'google-apis-bigquerydatatransfer_v1',
|
|
|
|
|
client_version: Google::Apis::BigquerydatatransferV1::GEM_VERSION)
|
2021-01-01 03:01:13 +00:00
|
|
|
@batch_path = 'batch'
|
|
|
|
|
end
|
|
|
|
|
|
2022-04-05 07:52:26 +00:00
|
|
|
# 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 'https://
|
|
|
|
|
# bigquery.cloud.google.com' (and the documents can be found at https://cloud.
|
|
|
|
|
# google.com/bigquery/bigquery-web-ui and https://cloud.google.com/bigquery/docs/
|
|
|
|
|
# working-with-transfers).
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# The name of the project resource in the form: `projects/`project_id``
|
|
|
|
|
# @param [Google::Apis::BigquerydatatransferV1::EnrollDataSourcesRequest] enroll_data_sources_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::Empty] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::Empty]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def enroll_project_data_sources(name, enroll_data_sources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1/{+name}:enrollDataSources', options)
|
|
|
|
|
command.request_representation = Google::Apis::BigquerydatatransferV1::EnrollDataSourcesRequest::Representation
|
|
|
|
|
command.request_object = enroll_data_sources_request_object
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::Empty::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::Empty
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2021-01-01 03:01:13 +00:00
|
|
|
# Returns true if valid credentials exist for the given data source and
|
2022-04-05 07:52:26 +00:00
|
|
|
# requesting user.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The data source in the form: `projects/`project_id`/dataSources/`
|
|
|
|
|
# data_source_id`` or `projects/`project_id`/locations/`location_id`/dataSources/
|
|
|
|
|
# `data_source_id``.
|
|
|
|
|
# @param [Google::Apis::BigquerydatatransferV1::CheckValidCredsRequest] check_valid_creds_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def check_project_data_source_valid_creds(name, check_valid_creds_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1/{+name}:checkValidCreds', options)
|
|
|
|
|
command.request_representation = Google::Apis::BigquerydatatransferV1::CheckValidCredsRequest::Representation
|
|
|
|
|
command.request_object = check_valid_creds_request_object
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2022-04-05 07:52:26 +00:00
|
|
|
# Retrieves a supported data source and returns its settings.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The field will contain name of the resource requested, for example: `
|
|
|
|
|
# projects/`project_id`/dataSources/`data_source_id`` or `projects/`project_id`/
|
|
|
|
|
# locations/`location_id`/dataSources/`data_source_id``
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::DataSource] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::DataSource]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_data_source(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::DataSource::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::DataSource
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2022-04-05 07:52:26 +00:00
|
|
|
# Lists supported data sources and returns their settings.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] parent
|
|
|
|
|
# Required. The BigQuery project id for which data sources should be returned.
|
|
|
|
|
# Must be in the form: `projects/`project_id`` or `projects/`project_id`/
|
2022-04-05 07:52:26 +00:00
|
|
|
# locations/`location_id``
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# Page size. The default page size is the maximum value of 1000 results.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# Pagination token, which can be used to request a specific page of `
|
|
|
|
|
# ListDataSourcesRequest` list results. For multiple-page results, `
|
|
|
|
|
# ListDataSourcesResponse` outputs a `next_page` token, which can be used as the
|
|
|
|
|
# `page_token` value to request the next page of list results.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_data_sources(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+parent}/dataSources', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2022-04-05 07:52:26 +00:00
|
|
|
# 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 'https://
|
|
|
|
|
# bigquery.cloud.google.com' (and the documents can be found at https://cloud.
|
|
|
|
|
# google.com/bigquery/bigquery-web-ui and https://cloud.google.com/bigquery/docs/
|
|
|
|
|
# working-with-transfers).
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# The name of the project resource in the form: `projects/`project_id``
|
|
|
|
|
# @param [Google::Apis::BigquerydatatransferV1::EnrollDataSourcesRequest] enroll_data_sources_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::Empty] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::Empty]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def enroll_location_data_sources(name, enroll_data_sources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1/{+name}:enrollDataSources', options)
|
|
|
|
|
command.request_representation = Google::Apis::BigquerydatatransferV1::EnrollDataSourcesRequest::Representation
|
|
|
|
|
command.request_object = enroll_data_sources_request_object
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::Empty::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::Empty
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2021-01-01 03:01:13 +00:00
|
|
|
# Gets information about a location.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Resource name for the location.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::Location] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::Location]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::Location::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::Location
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Lists information about the supported locations for this service.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# The resource that owns the locations collection, if applicable.
|
|
|
|
|
# @param [String] filter
|
2022-04-05 07:52:26 +00:00
|
|
|
# A filter to narrow down results to a preferred subset. The filtering language
|
|
|
|
|
# accepts strings like "displayName=tokyo", and is documented in more detail in [
|
|
|
|
|
# AIP-160](https://google.aip.dev/160).
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [Fixnum] page_size
|
2022-04-05 07:52:26 +00:00
|
|
|
# The maximum number of results to return. If not set, the service selects a
|
|
|
|
|
# default.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] page_token
|
2022-04-05 07:52:26 +00:00
|
|
|
# A page token received from the `next_page_token` field in the response. Send
|
|
|
|
|
# that page token to receive the subsequent page.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::ListLocationsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::ListLocationsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+name}/locations', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::ListLocationsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::ListLocationsResponse
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['filter'] = filter unless filter.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Returns true if valid credentials exist for the given data source and
|
2022-04-05 07:52:26 +00:00
|
|
|
# requesting user.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The data source in the form: `projects/`project_id`/dataSources/`
|
|
|
|
|
# data_source_id`` or `projects/`project_id`/locations/`location_id`/dataSources/
|
|
|
|
|
# `data_source_id``.
|
|
|
|
|
# @param [Google::Apis::BigquerydatatransferV1::CheckValidCredsRequest] check_valid_creds_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def check_project_location_data_source_valid_creds(name, check_valid_creds_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1/{+name}:checkValidCreds', options)
|
|
|
|
|
command.request_representation = Google::Apis::BigquerydatatransferV1::CheckValidCredsRequest::Representation
|
|
|
|
|
command.request_object = check_valid_creds_request_object
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2022-04-05 07:52:26 +00:00
|
|
|
# Retrieves a supported data source and returns its settings.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The field will contain name of the resource requested, for example: `
|
|
|
|
|
# projects/`project_id`/dataSources/`data_source_id`` or `projects/`project_id`/
|
|
|
|
|
# locations/`location_id`/dataSources/`data_source_id``
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::DataSource] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::DataSource]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_location_data_source(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::DataSource::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::DataSource
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2022-04-05 07:52:26 +00:00
|
|
|
# Lists supported data sources and returns their settings.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] parent
|
|
|
|
|
# Required. The BigQuery project id for which data sources should be returned.
|
|
|
|
|
# Must be in the form: `projects/`project_id`` or `projects/`project_id`/
|
2022-04-05 07:52:26 +00:00
|
|
|
# locations/`location_id``
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# Page size. The default page size is the maximum value of 1000 results.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# Pagination token, which can be used to request a specific page of `
|
|
|
|
|
# ListDataSourcesRequest` list results. For multiple-page results, `
|
|
|
|
|
# ListDataSourcesResponse` outputs a `next_page` token, which can be used as the
|
|
|
|
|
# `page_token` value to request the next page of list results.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_location_data_sources(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+parent}/dataSources', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Creates a new data transfer configuration.
|
|
|
|
|
# @param [String] 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.
|
|
|
|
|
# @param [Google::Apis::BigquerydatatransferV1::TransferConfig] transfer_config_object
|
|
|
|
|
# @param [String] authorization_code
|
|
|
|
|
# Optional OAuth2 authorization code to use with this transfer configuration.
|
2022-04-05 07:52:26 +00:00
|
|
|
# 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, please make a request to https://www.gstatic.com/
|
|
|
|
|
# bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:
|
|
|
|
|
# oauth:2.0:oob&response_type=authorization_code * 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. Note that this should not be set when `
|
|
|
|
|
# service_account_name` is used to create the transfer config.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] service_account_name
|
|
|
|
|
# Optional service account name. If this field is set, transfer config will be
|
2022-04-05 07:52:26 +00:00
|
|
|
# created with this service account credential. It requires that 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 transfer
|
|
|
|
|
# config. Please refer to this public guide for the latest list of data sources
|
|
|
|
|
# with service account support: https://cloud.google.com/bigquery-transfer/docs/
|
|
|
|
|
# use-service-accounts
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] version_info
|
2022-04-05 07:52:26 +00:00
|
|
|
# Optional version info. This is required only if `transferConfig.dataSourceId`
|
|
|
|
|
# is anything else but 'youtube_channel' and new credentials are needed, as
|
|
|
|
|
# indicated by `CheckValidCreds`. In order to obtain version info, please make a
|
|
|
|
|
# request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&
|
|
|
|
|
# scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info *
|
|
|
|
|
# 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. Note that this should not be set when `
|
|
|
|
|
# service_account_name` is used to create the transfer config.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::TransferConfig] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::TransferConfig]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def create_project_location_transfer_config(parent, transfer_config_object = nil, authorization_code: nil, service_account_name: nil, version_info: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1/{+parent}/transferConfigs', options)
|
|
|
|
|
command.request_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
|
|
|
|
|
command.request_object = transfer_config_object
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['authorizationCode'] = authorization_code unless authorization_code.nil?
|
|
|
|
|
command.query['serviceAccountName'] = service_account_name unless service_account_name.nil?
|
|
|
|
|
command.query['versionInfo'] = version_info unless version_info.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Deletes a data transfer configuration, including any associated transfer runs
|
|
|
|
|
# and logs.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The field will contain name of the resource requested, for example: `
|
|
|
|
|
# projects/`project_id`/transferConfigs/`config_id`` or `projects/`project_id`/
|
|
|
|
|
# locations/`location_id`/transferConfigs/`config_id``
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::Empty] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::Empty]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def delete_project_location_transfer_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::Empty::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::Empty
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Returns information about a data transfer config.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The field will contain name of the resource requested, for example: `
|
|
|
|
|
# projects/`project_id`/transferConfigs/`config_id`` or `projects/`project_id`/
|
|
|
|
|
# locations/`location_id`/transferConfigs/`config_id``
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::TransferConfig] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::TransferConfig]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_location_transfer_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2022-04-05 07:52:26 +00:00
|
|
|
# Returns information about all transfer configs owned by a project in the
|
|
|
|
|
# specified location.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] parent
|
2022-04-05 07:52:26 +00:00
|
|
|
# Required. The BigQuery project id for which transfer configs should be
|
|
|
|
|
# returned: `projects/`project_id`` or `projects/`project_id`/locations/`
|
|
|
|
|
# location_id``
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [Array<String>, String] data_source_ids
|
|
|
|
|
# When specified, only configurations of requested data sources are returned.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# Page size. The default page size is the maximum value of 1000 results.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# Pagination token, which can be used to request a specific page of `
|
|
|
|
|
# ListTransfersRequest` list results. For multiple-page results, `
|
|
|
|
|
# ListTransfersResponse` outputs a `next_page` token, which can be used as the `
|
|
|
|
|
# page_token` value to request the next page of list results.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_location_transfer_configs(parent, data_source_ids: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+parent}/transferConfigs', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['dataSourceIds'] = data_source_ids unless data_source_ids.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Updates a data transfer configuration. All fields must be set, even if they
|
|
|
|
|
# are not updated.
|
|
|
|
|
# @param [String] name
|
2022-04-05 07:52:26 +00:00
|
|
|
# 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.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [Google::Apis::BigquerydatatransferV1::TransferConfig] transfer_config_object
|
|
|
|
|
# @param [String] authorization_code
|
2022-04-05 07:52:26 +00:00
|
|
|
# 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, please make a request to https://www.gstatic.com/
|
|
|
|
|
# bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:
|
|
|
|
|
# oauth:2.0:oob&response_type=authorization_code * 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. Note that this should not be set when `
|
|
|
|
|
# service_account_name` is used to create the transfer config.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] service_account_name
|
|
|
|
|
# Optional service account name. If this field is set and "service_account_name"
|
2022-04-05 07:52:26 +00:00
|
|
|
# is set in update_mask, transfer config will be created with this service
|
|
|
|
|
# account credential. It requires that 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 transfer config. Please
|
|
|
|
|
# refer to this public guide for the latest list of data sources with service
|
|
|
|
|
# account support: https://cloud.google.com/bigquery-transfer/docs/use-service-
|
|
|
|
|
# accounts
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] update_mask
|
|
|
|
|
# Required. Required list of fields to be updated in this request.
|
|
|
|
|
# @param [String] version_info
|
2022-04-05 07:52:26 +00:00
|
|
|
# Optional version info. This is required only if `transferConfig.dataSourceId`
|
|
|
|
|
# is anything else but 'youtube_channel' and new credentials are needed, as
|
|
|
|
|
# indicated by `CheckValidCreds`. In order to obtain version info, please make a
|
|
|
|
|
# request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&
|
|
|
|
|
# scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info *
|
|
|
|
|
# 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. Note that this should not be set when `
|
|
|
|
|
# service_account_name` is used to create the transfer config.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::TransferConfig] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::TransferConfig]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def patch_project_location_transfer_config(name, transfer_config_object = nil, authorization_code: nil, service_account_name: nil, update_mask: nil, version_info: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
|
|
|
command.request_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
|
|
|
|
|
command.request_object = transfer_config_object
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['authorizationCode'] = authorization_code unless authorization_code.nil?
|
|
|
|
|
command.query['serviceAccountName'] = service_account_name unless service_account_name.nil?
|
|
|
|
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
|
|
|
command.query['versionInfo'] = version_info unless version_info.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [String] parent
|
|
|
|
|
# Required. Transfer configuration name in the form: `projects/`project_id`/
|
|
|
|
|
# transferConfigs/`config_id`` or `projects/`project_id`/locations/`location_id`/
|
|
|
|
|
# transferConfigs/`config_id``.
|
|
|
|
|
# @param [Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsRequest] schedule_transfer_runs_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def schedule_project_location_transfer_config_runs(parent, schedule_transfer_runs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1/{+parent}:scheduleRuns', options)
|
|
|
|
|
command.request_representation = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsRequest::Representation
|
|
|
|
|
command.request_object = schedule_transfer_runs_request_object
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [String] parent
|
|
|
|
|
# Transfer configuration name in the form: `projects/`project_id`/
|
|
|
|
|
# transferConfigs/`config_id`` or `projects/`project_id`/locations/`location_id`/
|
|
|
|
|
# transferConfigs/`config_id``.
|
|
|
|
|
# @param [Google::Apis::BigquerydatatransferV1::StartManualTransferRunsRequest] start_manual_transfer_runs_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::StartManualTransferRunsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::StartManualTransferRunsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def start_project_location_transfer_config_manual_runs(parent, start_manual_transfer_runs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1/{+parent}:startManualRuns', options)
|
|
|
|
|
command.request_representation = Google::Apis::BigquerydatatransferV1::StartManualTransferRunsRequest::Representation
|
|
|
|
|
command.request_object = start_manual_transfer_runs_request_object
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::StartManualTransferRunsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::StartManualTransferRunsResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Deletes the specified transfer run.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The field will contain name of the resource requested, for example: `
|
|
|
|
|
# projects/`project_id`/transferConfigs/`config_id`/runs/`run_id`` or `projects/`
|
|
|
|
|
# project_id`/locations/`location_id`/transferConfigs/`config_id`/runs/`run_id``
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::Empty] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::Empty]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def delete_project_location_transfer_config_run(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::Empty::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::Empty
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Returns information about the particular transfer run.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The field will contain name of the resource requested, for example: `
|
|
|
|
|
# projects/`project_id`/transferConfigs/`config_id`/runs/`run_id`` or `projects/`
|
|
|
|
|
# project_id`/locations/`location_id`/transferConfigs/`config_id`/runs/`run_id``
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::TransferRun] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::TransferRun]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_location_transfer_config_run(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::TransferRun::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::TransferRun
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2022-04-05 07:52:26 +00:00
|
|
|
# Returns information about running and completed transfer runs.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] 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`` or `projects/`project_id`/locations/`
|
|
|
|
|
# location_id`/transferConfigs/`config_id``.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# Page size. The default page size is the maximum value of 1000 results.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# Pagination token, which can be used to request a specific page of `
|
|
|
|
|
# ListTransferRunsRequest` list results. For multiple-page results, `
|
|
|
|
|
# ListTransferRunsResponse` outputs a `next_page` token, which can be used as
|
|
|
|
|
# the `page_token` value to request the next page of list results.
|
|
|
|
|
# @param [String] run_attempt
|
|
|
|
|
# Indicates how run attempts are to be pulled.
|
|
|
|
|
# @param [Array<String>, String] states
|
|
|
|
|
# When specified, only transfer runs with requested states are returned.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_location_transfer_config_runs(parent, page_size: nil, page_token: nil, run_attempt: nil, states: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+parent}/runs', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['runAttempt'] = run_attempt unless run_attempt.nil?
|
|
|
|
|
command.query['states'] = states unless states.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2022-04-05 07:52:26 +00:00
|
|
|
# Returns log messages for the transfer run.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] parent
|
|
|
|
|
# Required. Transfer run name in the form: `projects/`project_id`/
|
|
|
|
|
# transferConfigs/`config_id`/runs/`run_id`` or `projects/`project_id`/locations/
|
|
|
|
|
# `location_id`/transferConfigs/`config_id`/runs/`run_id``
|
|
|
|
|
# @param [Array<String>, String] message_types
|
|
|
|
|
# Message types to return. If not populated - INFO, WARNING and ERROR messages
|
|
|
|
|
# are returned.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# Page size. The default page size is the maximum value of 1000 results.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# Pagination token, which can be used to request a specific page of `
|
|
|
|
|
# ListTransferLogsRequest` list results. For multiple-page results, `
|
|
|
|
|
# ListTransferLogsResponse` outputs a `next_page` token, which can be used as
|
|
|
|
|
# the `page_token` value to request the next page of list results.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_location_transfer_config_run_transfer_logs(parent, message_types: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+parent}/transferLogs', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['messageTypes'] = message_types unless message_types.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Creates a new data transfer configuration.
|
|
|
|
|
# @param [String] 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.
|
|
|
|
|
# @param [Google::Apis::BigquerydatatransferV1::TransferConfig] transfer_config_object
|
|
|
|
|
# @param [String] authorization_code
|
|
|
|
|
# Optional OAuth2 authorization code to use with this transfer configuration.
|
2022-04-05 07:52:26 +00:00
|
|
|
# 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, please make a request to https://www.gstatic.com/
|
|
|
|
|
# bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:
|
|
|
|
|
# oauth:2.0:oob&response_type=authorization_code * 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. Note that this should not be set when `
|
|
|
|
|
# service_account_name` is used to create the transfer config.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] service_account_name
|
|
|
|
|
# Optional service account name. If this field is set, transfer config will be
|
2022-04-05 07:52:26 +00:00
|
|
|
# created with this service account credential. It requires that 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 transfer
|
|
|
|
|
# config. Please refer to this public guide for the latest list of data sources
|
|
|
|
|
# with service account support: https://cloud.google.com/bigquery-transfer/docs/
|
|
|
|
|
# use-service-accounts
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] version_info
|
2022-04-05 07:52:26 +00:00
|
|
|
# Optional version info. This is required only if `transferConfig.dataSourceId`
|
|
|
|
|
# is anything else but 'youtube_channel' and new credentials are needed, as
|
|
|
|
|
# indicated by `CheckValidCreds`. In order to obtain version info, please make a
|
|
|
|
|
# request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&
|
|
|
|
|
# scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info *
|
|
|
|
|
# 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. Note that this should not be set when `
|
|
|
|
|
# service_account_name` is used to create the transfer config.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::TransferConfig] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::TransferConfig]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def create_project_transfer_config(parent, transfer_config_object = nil, authorization_code: nil, service_account_name: nil, version_info: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1/{+parent}/transferConfigs', options)
|
|
|
|
|
command.request_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
|
|
|
|
|
command.request_object = transfer_config_object
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['authorizationCode'] = authorization_code unless authorization_code.nil?
|
|
|
|
|
command.query['serviceAccountName'] = service_account_name unless service_account_name.nil?
|
|
|
|
|
command.query['versionInfo'] = version_info unless version_info.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Deletes a data transfer configuration, including any associated transfer runs
|
|
|
|
|
# and logs.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The field will contain name of the resource requested, for example: `
|
|
|
|
|
# projects/`project_id`/transferConfigs/`config_id`` or `projects/`project_id`/
|
|
|
|
|
# locations/`location_id`/transferConfigs/`config_id``
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::Empty] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::Empty]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def delete_project_transfer_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::Empty::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::Empty
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Returns information about a data transfer config.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The field will contain name of the resource requested, for example: `
|
|
|
|
|
# projects/`project_id`/transferConfigs/`config_id`` or `projects/`project_id`/
|
|
|
|
|
# locations/`location_id`/transferConfigs/`config_id``
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::TransferConfig] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::TransferConfig]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_transfer_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2022-04-05 07:52:26 +00:00
|
|
|
# Returns information about all transfer configs owned by a project in the
|
|
|
|
|
# specified location.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] parent
|
2022-04-05 07:52:26 +00:00
|
|
|
# Required. The BigQuery project id for which transfer configs should be
|
|
|
|
|
# returned: `projects/`project_id`` or `projects/`project_id`/locations/`
|
|
|
|
|
# location_id``
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [Array<String>, String] data_source_ids
|
|
|
|
|
# When specified, only configurations of requested data sources are returned.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# Page size. The default page size is the maximum value of 1000 results.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# Pagination token, which can be used to request a specific page of `
|
|
|
|
|
# ListTransfersRequest` list results. For multiple-page results, `
|
|
|
|
|
# ListTransfersResponse` outputs a `next_page` token, which can be used as the `
|
|
|
|
|
# page_token` value to request the next page of list results.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_transfer_configs(parent, data_source_ids: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+parent}/transferConfigs', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['dataSourceIds'] = data_source_ids unless data_source_ids.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Updates a data transfer configuration. All fields must be set, even if they
|
|
|
|
|
# are not updated.
|
|
|
|
|
# @param [String] name
|
2022-04-05 07:52:26 +00:00
|
|
|
# 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.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [Google::Apis::BigquerydatatransferV1::TransferConfig] transfer_config_object
|
|
|
|
|
# @param [String] authorization_code
|
2022-04-05 07:52:26 +00:00
|
|
|
# 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, please make a request to https://www.gstatic.com/
|
|
|
|
|
# bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:
|
|
|
|
|
# oauth:2.0:oob&response_type=authorization_code * 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. Note that this should not be set when `
|
|
|
|
|
# service_account_name` is used to create the transfer config.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] service_account_name
|
|
|
|
|
# Optional service account name. If this field is set and "service_account_name"
|
2022-04-05 07:52:26 +00:00
|
|
|
# is set in update_mask, transfer config will be created with this service
|
|
|
|
|
# account credential. It requires that 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 transfer config. Please
|
|
|
|
|
# refer to this public guide for the latest list of data sources with service
|
|
|
|
|
# account support: https://cloud.google.com/bigquery-transfer/docs/use-service-
|
|
|
|
|
# accounts
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] update_mask
|
|
|
|
|
# Required. Required list of fields to be updated in this request.
|
|
|
|
|
# @param [String] version_info
|
2022-04-05 07:52:26 +00:00
|
|
|
# Optional version info. This is required only if `transferConfig.dataSourceId`
|
|
|
|
|
# is anything else but 'youtube_channel' and new credentials are needed, as
|
|
|
|
|
# indicated by `CheckValidCreds`. In order to obtain version info, please make a
|
|
|
|
|
# request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&
|
|
|
|
|
# scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info *
|
|
|
|
|
# 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. Note that this should not be set when `
|
|
|
|
|
# service_account_name` is used to create the transfer config.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::TransferConfig] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::TransferConfig]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def patch_project_transfer_config(name, transfer_config_object = nil, authorization_code: nil, service_account_name: nil, update_mask: nil, version_info: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
|
|
|
command.request_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
|
|
|
|
|
command.request_object = transfer_config_object
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['authorizationCode'] = authorization_code unless authorization_code.nil?
|
|
|
|
|
command.query['serviceAccountName'] = service_account_name unless service_account_name.nil?
|
|
|
|
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
|
|
|
command.query['versionInfo'] = version_info unless version_info.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [String] parent
|
|
|
|
|
# Required. Transfer configuration name in the form: `projects/`project_id`/
|
|
|
|
|
# transferConfigs/`config_id`` or `projects/`project_id`/locations/`location_id`/
|
|
|
|
|
# transferConfigs/`config_id``.
|
|
|
|
|
# @param [Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsRequest] schedule_transfer_runs_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def schedule_project_transfer_config_runs(parent, schedule_transfer_runs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1/{+parent}:scheduleRuns', options)
|
|
|
|
|
command.request_representation = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsRequest::Representation
|
|
|
|
|
command.request_object = schedule_transfer_runs_request_object
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [String] parent
|
|
|
|
|
# Transfer configuration name in the form: `projects/`project_id`/
|
|
|
|
|
# transferConfigs/`config_id`` or `projects/`project_id`/locations/`location_id`/
|
|
|
|
|
# transferConfigs/`config_id``.
|
|
|
|
|
# @param [Google::Apis::BigquerydatatransferV1::StartManualTransferRunsRequest] start_manual_transfer_runs_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::StartManualTransferRunsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::StartManualTransferRunsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def start_project_transfer_config_manual_runs(parent, start_manual_transfer_runs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1/{+parent}:startManualRuns', options)
|
|
|
|
|
command.request_representation = Google::Apis::BigquerydatatransferV1::StartManualTransferRunsRequest::Representation
|
|
|
|
|
command.request_object = start_manual_transfer_runs_request_object
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::StartManualTransferRunsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::StartManualTransferRunsResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Deletes the specified transfer run.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The field will contain name of the resource requested, for example: `
|
|
|
|
|
# projects/`project_id`/transferConfigs/`config_id`/runs/`run_id`` or `projects/`
|
|
|
|
|
# project_id`/locations/`location_id`/transferConfigs/`config_id`/runs/`run_id``
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::Empty] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::Empty]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def delete_project_transfer_config_run(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::Empty::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::Empty
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Returns information about the particular transfer run.
|
|
|
|
|
# @param [String] name
|
|
|
|
|
# Required. The field will contain name of the resource requested, for example: `
|
|
|
|
|
# projects/`project_id`/transferConfigs/`config_id`/runs/`run_id`` or `projects/`
|
|
|
|
|
# project_id`/locations/`location_id`/transferConfigs/`config_id`/runs/`run_id``
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::TransferRun] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::TransferRun]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_transfer_config_run(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::TransferRun::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::TransferRun
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2022-04-05 07:52:26 +00:00
|
|
|
# Returns information about running and completed transfer runs.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] 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`` or `projects/`project_id`/locations/`
|
|
|
|
|
# location_id`/transferConfigs/`config_id``.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# Page size. The default page size is the maximum value of 1000 results.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# Pagination token, which can be used to request a specific page of `
|
|
|
|
|
# ListTransferRunsRequest` list results. For multiple-page results, `
|
|
|
|
|
# ListTransferRunsResponse` outputs a `next_page` token, which can be used as
|
|
|
|
|
# the `page_token` value to request the next page of list results.
|
|
|
|
|
# @param [String] run_attempt
|
|
|
|
|
# Indicates how run attempts are to be pulled.
|
|
|
|
|
# @param [Array<String>, String] states
|
|
|
|
|
# When specified, only transfer runs with requested states are returned.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_transfer_config_runs(parent, page_size: nil, page_token: nil, run_attempt: nil, states: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+parent}/runs', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['runAttempt'] = run_attempt unless run_attempt.nil?
|
|
|
|
|
command.query['states'] = states unless states.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2022-04-05 07:52:26 +00:00
|
|
|
# Returns log messages for the transfer run.
|
2021-01-01 03:01:13 +00:00
|
|
|
# @param [String] parent
|
|
|
|
|
# Required. Transfer run name in the form: `projects/`project_id`/
|
|
|
|
|
# transferConfigs/`config_id`/runs/`run_id`` or `projects/`project_id`/locations/
|
|
|
|
|
# `location_id`/transferConfigs/`config_id`/runs/`run_id``
|
|
|
|
|
# @param [Array<String>, String] message_types
|
|
|
|
|
# Message types to return. If not populated - INFO, WARNING and ERROR messages
|
|
|
|
|
# are returned.
|
|
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# Page size. The default page size is the maximum value of 1000 results.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# Pagination token, which can be used to request a specific page of `
|
|
|
|
|
# ListTransferLogsRequest` list results. For multiple-page results, `
|
|
|
|
|
# ListTransferLogsResponse` outputs a `next_page` token, which can be used as
|
|
|
|
|
# the `page_token` value to request the next page of list results.
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_transfer_config_run_transfer_logs(parent, message_types: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:get, 'v1/{+parent}/transferLogs', options)
|
|
|
|
|
command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse
|
|
|
|
|
command.params['parent'] = parent unless parent.nil?
|
|
|
|
|
command.query['messageTypes'] = message_types unless message_types.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
protected
|
|
|
|
|
|
|
|
|
|
def apply_command_defaults(command)
|
|
|
|
|
command.query['key'] = key unless key.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
