google-cloud-language-v1beta2 0.2.3 → 0.3.0

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: 0a9c2bfd759d4ac38a7b382379b5140ae4d757b35ce5f7d3d75bbb1d9eb48af2
4
- data.tar.gz: e58f07419dfa72e33c4feda9eacda72b60da2aa9f71215c4894ec36ab18a7385
3
+ metadata.gz: 52adaa11ed211123ac72b91206a78715fb20da8eb330d566dd0fcf5d233bc43b
4
+ data.tar.gz: e1af0bd91e6ea640043814c3ac3e75baf50dd806683dc85c8edf4830a5d311c4
5
5
  SHA512:
6
- metadata.gz: e53f670d27953ec98d9c2ac3e95fa77709003f309c3d2db824900ab0d1462803c7f55afedf07388b8c6776b3ed04a0289d5dee1ae72ae79e33bab902ac5f6c63
7
- data.tar.gz: fdfa65b4043ab0b34980a13073c8ee2fd2a219428759c7509b4c64650beb84f917a1aaaac753ded061767f868fb97525fb87b60a79b849158b1e9bcc582fab21
6
+ metadata.gz: 79b2c82ec4d432142511220549faafd58749e65548a89bca2261469bff0692fa312a635d0595b6d50a4da82f53d28e64abd60e9231807d964db1f61127d08d90
7
+ data.tar.gz: 47e3da2ff26a9f143ba5862d76f02354e0e0f9fb806350c44a25db72b91dffffd79a1f8cd89ec1770ac99d45b7637e9de8a696372f76c4f4ca25e33ddc850b8a
data/README.md CHANGED
@@ -6,6 +6,12 @@ Provides natural language understanding technologies, such as sentiment analysis
6
6
 
7
7
  https://github.com/googleapis/google-cloud-ruby
8
8
 
9
+ This gem is a _versioned_ client. It provides basic client classes for a
10
+ specific version of the Natural Language V1beta2 API. Most users should consider using
11
+ the main client gem,
12
+ [google-cloud-language](https://rubygems.org/gems/google-cloud-language).
13
+ See the section below titled *Which client should I use?* for more information.
14
+
9
15
  ## Installation
10
16
 
11
17
  ```
@@ -73,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
73
79
  and later. Older versions of Ruby _may_ still work, but are unsupported and not
74
80
  recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
75
81
  about the Ruby support schedule.
82
+
83
+ ## Which client should I use?
84
+
85
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
86
+ client library with a name such as `google-cloud-language`,
87
+ and lower-level _versioned_ client libraries with names such as
88
+ `google-cloud-language-v1beta2`.
89
+ _In most cases, you should install the main client._
90
+
91
+ ### What's the difference between the main client and a versioned client?
92
+
93
+ A _versioned client_ provides a basic set of data types and client classes for
94
+ a _single version_ of a specific service. (That is, for a service with multiple
95
+ versions, there might be a separate versioned client for each service version.)
96
+ Most versioned clients are written and maintained by a code generator.
97
+
98
+ The _main client_ is designed to provide you with the _recommended_ client
99
+ interfaces for the service. There will be only one main client for any given
100
+ service, even a service with multiple versions. The main client includes
101
+ factory methods for constructing the client objects we recommend for most
102
+ users. In some cases, those will be classes provided by an underlying versioned
103
+ client; in other cases, they will be handwritten higher-level client objects
104
+ with additional capabilities, convenience methods, or best practices built in.
105
+ Generally, the main client will default to a recommended service version,
106
+ although in some cases you can override this if you need to talk to a specific
107
+ service version.
108
+
109
+ ### Why would I want to use the main client?
110
+
111
+ We recommend that most users install the main client gem for a service. You can
112
+ identify this gem as the one _without_ a version in its name, e.g.
113
+ `google-cloud-language`.
114
+ The main client is recommended because it will embody the best practices for
115
+ accessing the service, and may also provide more convenient interfaces or
116
+ tighter integration into frameworks and third-party libraries. In addition, the
117
+ documentation and samples published by Google will generally demonstrate use of
118
+ the main client.
119
+
120
+ ### Why would I want to use a versioned client?
121
+
122
+ You can use a versioned client if you are content with a possibly lower-level
123
+ class interface, you explicitly want to avoid features provided by the main
124
+ client, or you want to access a specific service version not be covered by the
125
+ main client. You can identify versioned client gems because the service version
126
+ is part of the name, e.g. `google-cloud-language-v1beta2`.
127
+
128
+ ### What about the google-apis-<name> clients?
129
+
130
+ Client library gems with names that begin with `google-apis-` are based on an
131
+ older code generation technology. They talk to a REST/JSON backend (whereas
132
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
133
+ not offer the same performance, features, and ease of use provided by more
134
+ modern clients.
135
+
136
+ The `google-apis-` clients have wide coverage across Google services, so you
137
+ might need to use one if there is no modern client available for the service.
138
+ However, if a modern client is available, we generally recommend it over the
139
+ older `google-apis-` clients.
@@ -33,3 +33,6 @@ module Google
33
33
  end
34
34
  end
35
35
  end
36
+
37
+ helper_path = ::File.join __dir__, "v1beta2", "_helpers.rb"
38
+ require "google/cloud/language/v1beta2/_helpers" if ::File.file? helper_path
@@ -69,7 +69,7 @@ module Google
69
69
  initial_delay: 0.1,
70
70
  max_delay: 60.0,
71
71
  multiplier: 1.3,
72
- retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
72
+ retry_codes: [14, 4]
73
73
  }
74
74
 
75
75
  default_config.rpcs.analyze_entities.timeout = 600.0
@@ -77,7 +77,7 @@ module Google
77
77
  initial_delay: 0.1,
78
78
  max_delay: 60.0,
79
79
  multiplier: 1.3,
80
- retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
80
+ retry_codes: [14, 4]
81
81
  }
82
82
 
83
83
  default_config.rpcs.analyze_entity_sentiment.timeout = 600.0
@@ -85,7 +85,7 @@ module Google
85
85
  initial_delay: 0.1,
86
86
  max_delay: 60.0,
87
87
  multiplier: 1.3,
88
- retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
88
+ retry_codes: [14, 4]
89
89
  }
90
90
 
91
91
  default_config.rpcs.analyze_syntax.timeout = 600.0
@@ -93,7 +93,7 @@ module Google
93
93
  initial_delay: 0.1,
94
94
  max_delay: 60.0,
95
95
  multiplier: 1.3,
96
- retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
96
+ retry_codes: [14, 4]
97
97
  }
98
98
 
99
99
  default_config.rpcs.classify_text.timeout = 600.0
@@ -101,7 +101,7 @@ module Google
101
101
  initial_delay: 0.1,
102
102
  max_delay: 60.0,
103
103
  multiplier: 1.3,
104
- retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
104
+ retry_codes: [14, 4]
105
105
  }
106
106
 
107
107
  default_config.rpcs.annotate_text.timeout = 600.0
@@ -109,7 +109,7 @@ module Google
109
109
  initial_delay: 0.1,
110
110
  max_delay: 60.0,
111
111
  multiplier: 1.3,
112
- retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
112
+ retry_codes: [14, 4]
113
113
  }
114
114
 
115
115
  default_config
@@ -173,7 +173,13 @@ module Google
173
173
 
174
174
  # Create credentials
175
175
  credentials = @config.credentials
176
- credentials ||= Credentials.default scope: @config.scope
176
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
177
+ # but only if the default endpoint does not have a region prefix.
178
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
179
+ @config.endpoint == Client.configure.endpoint &&
180
+ !@config.endpoint.split(".").first.include?("-")
181
+ credentials ||= Credentials.default scope: @config.scope,
182
+ enable_self_signed_jwt: enable_self_signed_jwt
177
183
  if credentials.is_a?(String) || credentials.is_a?(Hash)
178
184
  credentials = Credentials.new credentials, scope: @config.scope
179
185
  end
@@ -655,7 +661,7 @@ module Google
655
661
 
656
662
  config_attr :endpoint, "language.googleapis.com", ::String
657
663
  config_attr :credentials, nil do |value|
658
- allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
664
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
659
665
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
660
666
  allowed.any? { |klass| klass === value }
661
667
  end
@@ -695,7 +701,7 @@ module Google
695
701
  # Each configuration object is of type `Gapic::Config::Method` and includes
696
702
  # the following configuration fields:
697
703
  #
698
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
704
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
699
705
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
700
706
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
701
707
  # include the following keys:
@@ -36,23 +36,23 @@ module Google
36
36
  self.service_name = 'google.cloud.language.v1beta2.LanguageService'
37
37
 
38
38
  # Analyzes the sentiment of the provided text.
39
- rpc :AnalyzeSentiment, AnalyzeSentimentRequest, AnalyzeSentimentResponse
39
+ rpc :AnalyzeSentiment, ::Google::Cloud::Language::V1beta2::AnalyzeSentimentRequest, ::Google::Cloud::Language::V1beta2::AnalyzeSentimentResponse
40
40
  # Finds named entities (currently proper names and common nouns) in the text
41
41
  # along with entity types, salience, mentions for each entity, and
42
42
  # other properties.
43
- rpc :AnalyzeEntities, AnalyzeEntitiesRequest, AnalyzeEntitiesResponse
43
+ rpc :AnalyzeEntities, ::Google::Cloud::Language::V1beta2::AnalyzeEntitiesRequest, ::Google::Cloud::Language::V1beta2::AnalyzeEntitiesResponse
44
44
  # Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1beta2.LanguageService.AnalyzeEntities] in the text and analyzes
45
45
  # sentiment associated with each entity and its mentions.
46
- rpc :AnalyzeEntitySentiment, AnalyzeEntitySentimentRequest, AnalyzeEntitySentimentResponse
46
+ rpc :AnalyzeEntitySentiment, ::Google::Cloud::Language::V1beta2::AnalyzeEntitySentimentRequest, ::Google::Cloud::Language::V1beta2::AnalyzeEntitySentimentResponse
47
47
  # Analyzes the syntax of the text and provides sentence boundaries and
48
48
  # tokenization along with part-of-speech tags, dependency trees, and other
49
49
  # properties.
50
- rpc :AnalyzeSyntax, AnalyzeSyntaxRequest, AnalyzeSyntaxResponse
50
+ rpc :AnalyzeSyntax, ::Google::Cloud::Language::V1beta2::AnalyzeSyntaxRequest, ::Google::Cloud::Language::V1beta2::AnalyzeSyntaxResponse
51
51
  # Classifies a document into categories.
52
- rpc :ClassifyText, ClassifyTextRequest, ClassifyTextResponse
52
+ rpc :ClassifyText, ::Google::Cloud::Language::V1beta2::ClassifyTextRequest, ::Google::Cloud::Language::V1beta2::ClassifyTextResponse
53
53
  # A convenience method that provides all syntax, sentiment, entity, and
54
54
  # classification features in one call.
55
- rpc :AnnotateText, AnnotateTextRequest, AnnotateTextResponse
55
+ rpc :AnnotateText, ::Google::Cloud::Language::V1beta2::AnnotateTextRequest, ::Google::Cloud::Language::V1beta2::AnnotateTextResponse
56
56
  end
57
57
 
58
58
  Stub = Service.rpc_stub_class
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Language
23
23
  module V1beta2
24
- VERSION = "0.2.3"
24
+ VERSION = "0.3.0"
25
25
  end
26
26
  end
27
27
  end
@@ -54,6 +54,12 @@ module Google
54
54
  # This indicates that the field may be set once in a request to create a
55
55
  # resource, but may not be changed thereafter.
56
56
  IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
57
63
  end
58
64
  end
59
65
  end
@@ -43,12 +43,12 @@ module Google
43
43
  #
44
44
  # The ResourceDescriptor Yaml config will look like:
45
45
  #
46
- # resources:
47
- # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/\\{project}/topics/\\{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/\\{project}"
46
+ # resources:
47
+ # - type: "pubsub.googleapis.com/Topic"
48
+ # name_descriptor:
49
+ # - pattern: "projects/{project}/topics/{topic}"
50
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
+ # parent_name_extractor: "projects/{project}"
52
52
  #
53
53
  # Sometimes, resources have multiple patterns, typically because they can
54
54
  # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
183
183
  # }
184
184
  # @!attribute [rw] plural
185
185
  # @return [::String]
186
- # The plural name used in the resource name, such as 'projects' for
187
- # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
- # field in k8s CRD spec
186
+ # The plural name used in the resource name and permission names, such as
187
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
188
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
189
+ # concept of the `plural` field in k8s CRD spec
189
190
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
191
+ #
192
+ # Note: The plural form is required even for singleton resources. See
193
+ # https://aip.dev/156
190
194
  # @!attribute [rw] singular
191
195
  # @return [::String]
192
196
  # The same concept of the `singular` field in k8s CRD spec
193
197
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
198
  # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
199
+ # @!attribute [rw] style
200
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
201
+ # Style flag(s) for this resource.
202
+ # These indicate that a resource is expected to conform to a given
203
+ # style. See the specific style flags for additional information.
195
204
  class ResourceDescriptor
196
205
  include ::Google::Protobuf::MessageExts
197
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
211
220
  # that from being necessary once there are multiple patterns.)
212
221
  FUTURE_MULTI_PATTERN = 2
213
222
  end
223
+
224
+ # A flag representing a specific style that a resource claims to conform to.
225
+ module Style
226
+ # The unspecified value. Do not use.
227
+ STYLE_UNSPECIFIED = 0
228
+
229
+ # This resource is intended to be "declarative-friendly".
230
+ #
231
+ # Declarative-friendly resources must be more strictly consistent, and
232
+ # setting this to true communicates to tools that this resource should
233
+ # adhere to declarative-friendly expectations.
234
+ #
235
+ # Note: This is used by the API linter (linter.aip.dev) to enable
236
+ # additional checks.
237
+ DECLARATIVE_FRIENDLY = 1
238
+ end
214
239
  end
215
240
 
216
241
  # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
226
251
  # type: "pubsub.googleapis.com/Topic"
227
252
  # }];
228
253
  # }
254
+ #
255
+ # Occasionally, a field may reference an arbitrary resource. In this case,
256
+ # APIs use the special value * in their resource reference.
257
+ #
258
+ # Example:
259
+ #
260
+ # message GetIamPolicyRequest {
261
+ # string resource = 2 [(google.api.resource_reference) = {
262
+ # type: "*"
263
+ # }];
264
+ # }
229
265
  # @!attribute [rw] child_type
230
266
  # @return [::String]
231
267
  # The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
234
270
  #
235
271
  # Example:
236
272
  #
237
- # message ListLogEntriesRequest {
238
- # string parent = 1 [(google.api.resource_reference) = {
239
- # child_type: "logging.googleapis.com/LogEntry"
240
- # };
241
- # }
273
+ # message ListLogEntriesRequest {
274
+ # string parent = 1 [(google.api.resource_reference) = {
275
+ # child_type: "logging.googleapis.com/LogEntry"
276
+ # };
277
+ # }
242
278
  class ResourceReference
243
279
  include ::Google::Protobuf::MessageExts
244
280
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -21,8 +21,6 @@ module Google
21
21
  module Cloud
22
22
  module Language
23
23
  module V1beta2
24
- # ################################################################ #
25
- #
26
24
  # Represents the input to API methods.
27
25
  # @!attribute [rw] type
28
26
  # @return [::Google::Cloud::Language::V1beta2::Document::Type]
@@ -70,7 +70,16 @@ module Google
70
70
  # .setNanos((int) ((millis % 1000) * 1000000)).build();
71
71
  #
72
72
  #
73
- # Example 5: Compute Timestamp from current time in Python.
73
+ # Example 5: Compute Timestamp from Java `Instant.now()`.
74
+ #
75
+ # Instant now = Instant.now();
76
+ #
77
+ # Timestamp timestamp =
78
+ # Timestamp.newBuilder().setSeconds(now.getEpochSecond())
79
+ # .setNanos(now.getNano()).build();
80
+ #
81
+ #
82
+ # Example 6: Compute Timestamp from current time in Python.
74
83
  #
75
84
  # timestamp = Timestamp()
76
85
  # timestamp.GetCurrentTime()
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-language-v1beta2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.3
4
+ version: 0.3.0
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-06-18 00:00:00.000000000 Z
11
+ date: 2021-02-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,14 +16,14 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '0.2'
19
+ version: '0.3'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: '0.2'
26
+ version: '0.3'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: google-cloud-errors
29
29
  requirement: !ruby/object:Gem::Requirement
@@ -152,6 +152,9 @@ dependencies:
152
152
  version: '0.9'
153
153
  description: Provides natural language understanding technologies, such as sentiment
154
154
  analysis, entity recognition, entity sentiment analysis, and other text annotations.
155
+ Note that google-cloud-language-v1beta2 is a version-specific client library. For
156
+ most uses, we recommend installing the main client library google-cloud-language
157
+ instead. See the readme for more details.
155
158
  email: googleapis-packages@google.com
156
159
  executables: []
157
160
  extensions: []
@@ -193,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
193
196
  - !ruby/object:Gem::Version
194
197
  version: '0'
195
198
  requirements: []
196
- rubygems_version: 3.1.3
199
+ rubygems_version: 3.2.6
197
200
  signing_key:
198
201
  specification_version: 4
199
202
  summary: API Client library for the Natural Language V1beta2 API