google-apis-bigquerydatatransfer_v1 0.12.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5057b7b7f5d2b406978c29d8c45b14c0b06d2b04f428383249d2911d525b2b9
-  data.tar.gz: 78e39b6255cd906aa304305bda41768d52764101c4f34903feca15d6b011db69
+  metadata.gz: 6963ef20fa1620f90fc46fce12d16e13be0ad1b1559c4d6cfb065ad149a15429
+  data.tar.gz: 58d2c0f1f24ed4f0de31af97833e83fe79e5bd656607dc033221b354e7b59a86
 SHA512:
-  metadata.gz: 71f6859e42a7cb2ee49e551f06227ec6cf45329bb5021d9d237b4ddeb3a3e30faef7ef3764031b9095aecd3d996cbd8690c8d7d132aee26e2a8450d657c03df0
-  data.tar.gz: bb7858e1a70199b571ea402f406f9b9a17254d98dd0b0d772e60776a6211bd11762d641fa602a84a121bfbb85aada0115ca8c4761af3cfbe4e474a5d0de54fc6
+  metadata.gz: 84024a0d30dea8dde7487aad834b3945cd3d126167f85fab9aecba17abdbe7d0784c3eb12f766cec1b58a10db2ad3c2687e182d08ff2086c6da8a8c439ab3c88
+  data.tar.gz: bc35c8be943851aed7a8d0b32e763bf7d616a8da757fbbdde0281632f2460d314afe220d81c3fc805c50a837fe62604e20199acac08d320a8635ca4e01abb19d

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Release history for google-apis-bigquerydatatransfer_v1
 
+### v0.16.0 (2022-01-07)
+
+* Regenerated from discovery document revision 20211230
+* Unspecified changes
+
+### v0.15.0 (2021-12-04)
+
+* Regenerated from discovery document revision 20211125
+
+### v0.14.0 (2021-10-20)
+
+* Unspecified changes
+
+### v0.13.0 (2021-08-27)
+
+* Regenerated from discovery document revision 20210822
+
 ### v0.12.0 (2021-08-22)
 
 * Regenerated from discovery document revision 20210814

data/OVERVIEW.md

@@ -51,7 +51,7 @@ require "google/apis/bigquerydatatransfer_v1"
 client = Google::Apis::BigquerydatatransferV1::BigQueryDataTransferService.new
 
 # Authenticate calls
-client.authentication = # ... use the googleauth gem to create credentials
+client.authorization = # ... use the googleauth gem to create credentials
 ```
 
 See the class reference docs for information on the methods you can call from a client.
@@ -60,8 +60,8 @@ See the class reference docs for information on the methods you can call from a
 
 More detailed descriptions of the Google simple REST clients are available in two documents.
 
- *  The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
- *  The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
+ *  The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
+ *  The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
 
 (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Bigquerydatatransfer service in particular.)
 

data/lib/google/apis/bigquerydatatransfer_v1/classes.rb

@@ -59,8 +59,7 @@ module Google
         end
       end
       
-      # Represents data source metadata. Metadata is sufficient to render UI and
-      # request proper OAuth tokens.
+      # Defines the properties and custom parameters for a data source.
       class DataSource
         include Google::Apis::Core::Hashable
       
@@ -194,11 +193,7 @@ module Google
         end
       end
       
-      # Represents a data source parameter with validation rules, so that parameters
-      # can be rendered in the UI. These parameters are given to us by supported data
-      # sources, and include all needed information for rendering and validation. Thus,
-      # whoever uses this api can decide to generate either generic ui, or custom
-      # data source specific forms.
+      # A parameter used to define custom fields in a data source definition.
       class DataSourceParameter
         include Google::Apis::Core::Hashable
       
@@ -351,6 +346,27 @@ module Google
         end
       end
       
+      # A request to enroll a set of data sources so they are visible in the BigQuery
+      # UI's `Transfer` tab.
+      class EnrollDataSourcesRequest
+        include Google::Apis::Core::Hashable
+      
+        # Data sources that are enrolled. It is required to provide at least one data
+        # source id.
+        # Corresponds to the JSON property `dataSourceIds`
+        # @return [Array<String>]
+        attr_accessor :data_source_ids
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @data_source_ids = args[:data_source_ids] if args.key?(:data_source_ids)
+        end
+      end
+      
       # Returns list of supported data sources and their metadata.
       class ListDataSourcesResponse
         include Google::Apis::Core::Hashable
@@ -824,8 +840,9 @@ module Google
         # 3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first
         # sunday of quarter 00:00`. See more explanation about the format here: https://
         # cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#
-        # the_schedule_format NOTE: the granularity should be at least 8 hours, or less
-        # frequent.
+        # the_schedule_format NOTE: The minimum interval time between recurring
+        # transfers depends on the data source; refer to the documentation for your data
+        # source.
         # Corresponds to the JSON property `schedule`
         # @return [String]
         attr_accessor :schedule

data/lib/google/apis/bigquerydatatransfer_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module BigquerydatatransferV1
       # Version of the google-apis-bigquerydatatransfer_v1 gem
-      GEM_VERSION = "0.12.0"
+      GEM_VERSION = "0.16.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210814"
+      REVISION = "20211230"
     end
   end
 end

data/lib/google/apis/bigquerydatatransfer_v1/representations.rb

@@ -58,6 +58,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class EnrollDataSourcesRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ListDataSourcesResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -234,6 +240,13 @@ module Google
         end
       end
       
+      class EnrollDataSourcesRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :data_source_ids, as: 'dataSourceIds'
+        end
+      end
+      
       class ListDataSourcesResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/bigquerydatatransfer_v1/service.rb

@@ -50,11 +50,46 @@ module Google
           @batch_path = 'batch'
         end
         
+        # 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
+        
         # Returns true if valid credentials exist for the given data source and
-        # requesting user. Some data sources doesn't support service account, so we need
-        # to talk to them on behalf of the end user. This API just checks whether we
-        # have OAuth token for the particular user, which is a pre-requisite before user
-        # can create a transfer config.
+        # requesting user.
         # @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/
@@ -89,8 +124,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves a supported data source and returns its settings, which can be used
-        # for UI rendering.
+        # Retrieves a supported data source and returns its settings.
         # @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`/
@@ -122,8 +156,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Lists supported data sources and returns their settings, which can be used for
-        # UI rendering.
+        # Lists supported data sources and returns their settings.
         # @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`/
@@ -164,6 +197,44 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # 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
+        
         # Gets information about a location.
         # @param [String] name
         #   Resource name for the location.
@@ -238,10 +309,7 @@ module Google
         end
         
         # Returns true if valid credentials exist for the given data source and
-        # requesting user. Some data sources doesn't support service account, so we need
-        # to talk to them on behalf of the end user. This API just checks whether we
-        # have OAuth token for the particular user, which is a pre-requisite before user
-        # can create a transfer config.
+        # requesting user.
         # @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/
@@ -276,8 +344,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves a supported data source and returns its settings, which can be used
-        # for UI rendering.
+        # Retrieves a supported data source and returns its settings.
         # @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`/
@@ -309,8 +376,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Lists supported data sources and returns their settings, which can be used for
-        # UI rendering.
+        # Lists supported data sources and returns their settings.
         # @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`/
@@ -729,7 +795,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Returns information about running and completed jobs.
+        # Returns information about running and completed transfer runs.
         # @param [String] parent
         #   Required. Name of transfer configuration for which transfer runs should be
         #   retrieved. Format of transfer configuration resource name is: `projects/`
@@ -777,7 +843,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Returns user facing log messages for the data transfer run.
+        # Returns log messages for the transfer run.
         # @param [String] parent
         #   Required. Transfer run name in the form: `projects/`project_id`/
         #   transferConfigs/`config_id`/runs/`run_id`` or `projects/`project_id`/locations/
@@ -1200,7 +1266,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Returns information about running and completed jobs.
+        # Returns information about running and completed transfer runs.
         # @param [String] parent
         #   Required. Name of transfer configuration for which transfer runs should be
         #   retrieved. Format of transfer configuration resource name is: `projects/`
@@ -1248,7 +1314,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Returns user facing log messages for the data transfer run.
+        # Returns log messages for the transfer run.
         # @param [String] parent
         #   Required. Transfer run name in the form: `projects/`project_id`/
         #   transferConfigs/`config_id`/runs/`run_id`` or `projects/`project_id`/locations/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-bigquerydatatransfer_v1
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-23 00:00:00.000000000 Z
+date: 2022-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -57,9 +57,9 @@ licenses:
 - Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
-  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-bigquerydatatransfer_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-bigquerydatatransfer_v1/v0.12.0
-  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-bigquerydatatransfer_v1
+  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-bigquerydatatransfer_v1/CHANGELOG.md
+  documentation_uri: https://googleapis.dev/ruby/google-apis-bigquerydatatransfer_v1/v0.16.0
+  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-bigquerydatatransfer_v1
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: Simple REST client for BigQuery Data Transfer API V1