google-cloud-bigquery-storage 0.2.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ea4446d45f329274b51b08b2f847b2042ed08c9f6f4baaa3d137425a795659b7
4
- data.tar.gz: 0f8dd3e9672630b1e21fdb7d61568a76d16fb6dce49508d43508d78e93c12372
3
+ metadata.gz: 0642504e1fcd03ec5f7b8dcd0d6499403506973876de48938b4aebb225d63f51
4
+ data.tar.gz: 707cb90a0b9fc85f6f442f4dd704188ae123c9acbf238b630ea961c1f5dcf769
5
5
  SHA512:
6
- metadata.gz: 8851b2e9837a04ac7206f0610de03b864d64f333a5ce7b8c41b1f506167fed7813aea56d2c9fe0b967d499e58dcc015199e7da81e6eba095e4ec2b4945cad23a
7
- data.tar.gz: 50d2b2f277d9ec60f083e4cdc9850531b72491d98427c431fdf836c4cf58eadc2ea45821e2a05580cef250d475da72d1324e6d3acc13c875b33e4c4d6e258ef1
6
+ metadata.gz: 18e780b8dc6fe40f437fae8bbe0c978a54f3eca4647f1df553b5eed21a8ec70fb72287b96349d3be6c546d3ce014dcc5e36c13622edf3f5c22ed700153b947bd
7
+ data.tar.gz: 10f0417efb2977880da9dc7ac056bfd18b6f1280069746e6fccba6c9606d0e914eab05bc77a6feeade9ebbbabc45eadbf4dcc47366b5c28637ec38ebe16f0a12
data/AUTHENTICATION.md CHANGED
@@ -64,7 +64,7 @@ containers where writing files is difficult or not encouraged.
64
64
 
65
65
  The environment variables that google-cloud-bigquery-storage
66
66
  checks for credentials are configured on the service Credentials class (such as
67
- `Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Credentials`):
67
+ `::Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Credentials`):
68
68
 
69
69
  1. `BIGQUERY_STORAGE_CREDENTIALS` - Path to JSON file, or JSON contents
70
70
  2. `BIGQUERY_STORAGE_KEYFILE` - Path to JSON file, or JSON contents
data/README.md CHANGED
@@ -6,9 +6,10 @@ The BigQuery Storage API provides fast access to BigQuery managed storage.
6
6
 
7
7
  Actual client classes for the various versions of this API are defined in
8
8
  _versioned_ client gems, with names of the form `google-cloud-bigquery-storage-v*`.
9
- The gem `google-cloud-bigquery-storage` is a convenience wrapper library that brings the
9
+ The gem `google-cloud-bigquery-storage` is the main client library that brings the
10
10
  verisoned gems in as dependencies, and provides high-level methods for
11
- constructing clients.
11
+ constructing clients. More information on versioned clients can be found below
12
+ in the section titled *Which client should I use?*.
12
13
 
13
14
  View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-bigquery-storage/latest)
14
15
  for this library, google-cloud-bigquery-storage, to see the convenience methods for
@@ -69,3 +70,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
69
70
  and later. Older versions of Ruby _may_ still work, but are unsupported and not
70
71
  recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
71
72
  about the Ruby support schedule.
73
+
74
+ ## Which client should I use?
75
+
76
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
77
+ client library with a name such as `google-cloud-bigquery-storage`,
78
+ and lower-level _versioned_ client libraries with names such as
79
+ `google-cloud-bigquery-storage-v1`.
80
+ _In most cases, you should install the main client._
81
+
82
+ ### What's the difference between the main client and a versioned client?
83
+
84
+ A _versioned client_ provides a basic set of data types and client classes for
85
+ a _single version_ of a specific service. (That is, for a service with multiple
86
+ versions, there might be a separate versioned client for each service version.)
87
+ Most versioned clients are written and maintained by a code generator.
88
+
89
+ The _main client_ is designed to provide you with the _recommended_ client
90
+ interfaces for the service. There will be only one main client for any given
91
+ service, even a service with multiple versions. The main client includes
92
+ factory methods for constructing the client objects we recommend for most
93
+ users. In some cases, those will be classes provided by an underlying versioned
94
+ client; in other cases, they will be handwritten higher-level client objects
95
+ with additional capabilities, convenience methods, or best practices built in.
96
+ Generally, the main client will default to a recommended service version,
97
+ although in some cases you can override this if you need to talk to a specific
98
+ service version.
99
+
100
+ ### Why would I want to use the main client?
101
+
102
+ We recommend that most users install the main client gem for a service. You can
103
+ identify this gem as the one _without_ a version in its name, e.g.
104
+ `google-cloud-bigquery-storage`.
105
+ The main client is recommended because it will embody the best practices for
106
+ accessing the service, and may also provide more convenient interfaces or
107
+ tighter integration into frameworks and third-party libraries. In addition, the
108
+ documentation and samples published by Google will generally demonstrate use of
109
+ the main client.
110
+
111
+ ### Why would I want to use a versioned client?
112
+
113
+ You can use a versioned client if you are content with a possibly lower-level
114
+ class interface, you explicitly want to avoid features provided by the main
115
+ client, or you want to access a specific service version not be covered by the
116
+ main client. You can identify versioned client gems because the service version
117
+ is part of the name, e.g. `google-cloud-bigquery-storage-v1`.
118
+
119
+ ### What about the google-apis-<name> clients?
120
+
121
+ Client library gems with names that begin with `google-apis-` are based on an
122
+ older code generation technology. They talk to a REST/JSON backend (whereas
123
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
124
+ not offer the same performance, features, and ease of use provided by more
125
+ modern clients.
126
+
127
+ The `google-apis-` clients have wide coverage across Google services, so you
128
+ might need to use one if there is no modern client available for the service.
129
+ However, if a modern client is available, we generally recommend it over the
130
+ older `google-apis-` clients.
@@ -16,4 +16,4 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
- require "google/cloud/bigquery/storage"
19
+ require "google/cloud/bigquery/storage" unless defined? Google::Cloud::Bigquery::Storage::VERSION
@@ -16,21 +16,29 @@
16
16
 
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
+ # Require this file early so that the version constant gets defined before
20
+ # requiring "google/cloud". This is because google-cloud-core will load the
21
+ # entrypoint (gem name) file, which in turn re-requires this file (hence
22
+ # causing a require cycle) unless the version constant is already defined.
19
23
  require "google/cloud/bigquery/storage/version"
24
+
20
25
  require "googleauth"
21
26
  gem "google-cloud-core"
22
- require "google/cloud" unless defined? Google::Cloud.new
27
+ require "google/cloud" unless defined? ::Google::Cloud.new
23
28
  require "google/cloud/config"
24
29
 
25
30
  # Set the default configuration
26
- Google::Cloud.configure.add_config! :bigquery_storage do |config|
27
- config.add_field! :credentials, nil, match: [String, Hash, Google::Auth::Credentials]
28
- config.add_field! :lib_name, nil, match: String
29
- config.add_field! :lib_version, nil, match: String
30
- config.add_field! :interceptors, nil, match: Array
31
- config.add_field! :timeout, nil, match: Numeric
32
- config.add_field! :metadata, nil, match: Hash
33
- config.add_field! :retry_policy, nil, match: [Hash, Proc]
31
+ ::Google::Cloud.configure.add_config! :bigquery_storage do |config|
32
+ config.add_field! :endpoint, "bigquerystorage.googleapis.com", match: ::String
33
+ config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
34
+ config.add_field! :scope, nil, match: [::Array, ::String]
35
+ config.add_field! :lib_name, nil, match: ::String
36
+ config.add_field! :lib_version, nil, match: ::String
37
+ config.add_field! :interceptors, nil, match: ::Array
38
+ config.add_field! :timeout, nil, match: ::Numeric
39
+ config.add_field! :metadata, nil, match: ::Hash
40
+ config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
41
+ config.add_field! :quota_project, nil, match: ::String
34
42
  end
35
43
 
36
44
  module Google
@@ -54,7 +62,7 @@ module Google
54
62
  #
55
63
  # The Read API can be used to read data from BigQuery.
56
64
  #
57
- # @param version [String, Symbol] The API version to connect to. Optional.
65
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
58
66
  # Defaults to `:v1`.
59
67
  # @return [BigQueryRead::Client] A client object for the specified version.
60
68
  #
@@ -83,8 +91,8 @@ module Google
83
91
  # The library version as recorded in instrumentation and logging.
84
92
  # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
85
93
  # An array of interceptors that are run before calls are executed.
86
- # * `timeout` (*type:* `Integer`) -
87
- # Default timeout in milliseconds.
94
+ # * `timeout` (*type:* `Numeric`) -
95
+ # Default timeout in seconds.
88
96
  # * `metadata` (*type:* `Hash{Symbol=>String}`) -
89
97
  # Additional gRPC headers to be sent with the call.
90
98
  # * `retry_policy` (*type:* `Hash`) -
@@ -95,14 +103,17 @@ module Google
95
103
  # * `:retry_codes` (*type:* `Array<String>`) -
96
104
  # The error codes that should trigger a retry.
97
105
  #
98
- # @return [Google::Cloud::Config] The default configuration used by this library
106
+ # @return [::Google::Cloud::Config] The default configuration used by this library
99
107
  #
100
108
  def self.configure
101
- yield Google::Cloud.configure.bigquery_storage if block_given?
109
+ yield ::Google::Cloud.configure.bigquery_storage if block_given?
102
110
 
103
- Google::Cloud.configure.bigquery_storage
111
+ ::Google::Cloud.configure.bigquery_storage
104
112
  end
105
113
  end
106
114
  end
107
115
  end
108
116
  end
117
+
118
+ helper_path = ::File.join __dir__, "storage", "helpers.rb"
119
+ require "google/cloud/bigquery/storage/helpers" if ::File.file? helper_path
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Bigquery
23
23
  module Storage
24
- VERSION = "0.2.0"
24
+ VERSION = "1.0.2"
25
25
  end
26
26
  end
27
27
  end
metadata CHANGED
@@ -1,29 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-bigquery-storage
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 1.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-04-13 00:00:00.000000000 Z
11
+ date: 2021-02-02 00:00:00.000000000 Z
12
12
  dependencies:
13
- - !ruby/object:Gem::Dependency
14
- name: google-cloud-core
15
- requirement: !ruby/object:Gem::Requirement
16
- requirements:
17
- - - "~>"
18
- - !ruby/object:Gem::Version
19
- version: '1.5'
20
- type: :runtime
21
- prerelease: false
22
- version_requirements: !ruby/object:Gem::Requirement
23
- requirements:
24
- - - "~>"
25
- - !ruby/object:Gem::Version
26
- version: '1.5'
27
13
  - !ruby/object:Gem::Dependency
28
14
  name: google-cloud-bigquery-storage-v1
29
15
  requirement: !ruby/object:Gem::Requirement
@@ -39,19 +25,19 @@ dependencies:
39
25
  - !ruby/object:Gem::Version
40
26
  version: '0.0'
41
27
  - !ruby/object:Gem::Dependency
42
- name: autotest-suffix
28
+ name: google-cloud-core
43
29
  requirement: !ruby/object:Gem::Requirement
44
30
  requirements:
45
31
  - - "~>"
46
32
  - !ruby/object:Gem::Version
47
- version: '1.1'
48
- type: :development
33
+ version: '1.5'
34
+ type: :runtime
49
35
  prerelease: false
50
36
  version_requirements: !ruby/object:Gem::Requirement
51
37
  requirements:
52
38
  - - "~>"
53
39
  - !ruby/object:Gem::Version
54
- version: '1.1'
40
+ version: '1.5'
55
41
  - !ruby/object:Gem::Dependency
56
42
  name: google-style
57
43
  requirement: !ruby/object:Gem::Requirement
@@ -72,56 +58,56 @@ dependencies:
72
58
  requirements:
73
59
  - - "~>"
74
60
  - !ruby/object:Gem::Version
75
- version: '5.10'
61
+ version: '5.14'
76
62
  type: :development
77
63
  prerelease: false
78
64
  version_requirements: !ruby/object:Gem::Requirement
79
65
  requirements:
80
66
  - - "~>"
81
67
  - !ruby/object:Gem::Version
82
- version: '5.10'
68
+ version: '5.14'
83
69
  - !ruby/object:Gem::Dependency
84
- name: minitest-autotest
70
+ name: minitest-focus
85
71
  requirement: !ruby/object:Gem::Requirement
86
72
  requirements:
87
73
  - - "~>"
88
74
  - !ruby/object:Gem::Version
89
- version: '1.0'
75
+ version: '1.1'
90
76
  type: :development
91
77
  prerelease: false
92
78
  version_requirements: !ruby/object:Gem::Requirement
93
79
  requirements:
94
80
  - - "~>"
95
81
  - !ruby/object:Gem::Version
96
- version: '1.0'
82
+ version: '1.1'
97
83
  - !ruby/object:Gem::Dependency
98
- name: minitest-focus
84
+ name: minitest-rg
99
85
  requirement: !ruby/object:Gem::Requirement
100
86
  requirements:
101
87
  - - "~>"
102
88
  - !ruby/object:Gem::Version
103
- version: '1.1'
89
+ version: '5.2'
104
90
  type: :development
105
91
  prerelease: false
106
92
  version_requirements: !ruby/object:Gem::Requirement
107
93
  requirements:
108
94
  - - "~>"
109
95
  - !ruby/object:Gem::Version
110
- version: '1.1'
96
+ version: '5.2'
111
97
  - !ruby/object:Gem::Dependency
112
- name: minitest-rg
98
+ name: rake
113
99
  requirement: !ruby/object:Gem::Requirement
114
100
  requirements:
115
- - - "~>"
101
+ - - ">="
116
102
  - !ruby/object:Gem::Version
117
- version: '5.2'
103
+ version: '12.0'
118
104
  type: :development
119
105
  prerelease: false
120
106
  version_requirements: !ruby/object:Gem::Requirement
121
107
  requirements:
122
- - - "~>"
108
+ - - ">="
123
109
  - !ruby/object:Gem::Version
124
- version: '5.2'
110
+ version: '12.0'
125
111
  - !ruby/object:Gem::Dependency
126
112
  name: redcarpet
127
113
  requirement: !ruby/object:Gem::Requirement
@@ -196,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
196
182
  - !ruby/object:Gem::Version
197
183
  version: '0'
198
184
  requirements: []
199
- rubygems_version: 3.0.6
185
+ rubygems_version: 3.2.6
200
186
  signing_key:
201
187
  specification_version: 4
202
188
  summary: API Client library for the BigQuery Storage API