google-cloud-error_reporting-v1beta1 0.1.3 → 0.2.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: 685aec6848b7bb842bd55b82c00d703404e1ebb7dc2d47a83faf617f9a72170b
4
- data.tar.gz: 82470d58b2cce7be2816ba72aa98b29300dde66b503f4e576b9f37a845ee1564
3
+ metadata.gz: 566647904d993e161090aacb4986c1279fc6303a67bbf01c64bd736696d5f4d1
4
+ data.tar.gz: c0329e99faed946bed9b16cbe9c68d05ba92657a381bc7232dadfab418d4b2a3
5
5
  SHA512:
6
- metadata.gz: '094e56e1c24ea11ec45804c53d1604624e2702966a82db137888d73bbc749af5611e796cdcd5302e2c817c6ea5e04f942cb61bdc96097f562135547c4daaf6e1'
7
- data.tar.gz: 41590ca8b0372ee198f0ad0c0d03a0d0803dc0bd3646e3b086bf9a318194e1cd6e13918180ae4a64a822d602f0ca3348e9a0a6a39ca3c9536ce3c96b19ed864b
6
+ metadata.gz: 10110734bdefbad6a8a2f3fc586789b34ace6cb6f6dd35db4935bce669c36cd087d99aaacc3ae60b999cd3521d1fe7b5a122e520b8d07b65c1e504cdef1e324f
7
+ data.tar.gz: 94dc8832b853724f14c96bdf271fe0ec1f5c26b5bd58e3636988384e35d5ab8429588f89c4b486b3200327a1737ee980766f0c8177f874a30c1fb8f48277c279
data/README.md CHANGED
@@ -6,6 +6,12 @@ The Error Reporting API provides a simple endpoint to report errors from your ru
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 Cloud Error Reporting V1beta1 API. Most users should consider using
11
+ the main client gem,
12
+ [google-cloud-error_reporting](https://rubygems.org/gems/google-cloud-error_reporting).
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-error_reporting`,
87
+ and lower-level _versioned_ client libraries with names such as
88
+ `google-cloud-error_reporting-v1beta1`.
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-error_reporting`.
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-error_reporting-v1beta1`.
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.
@@ -134,7 +134,13 @@ module Google
134
134
 
135
135
  # Create credentials
136
136
  credentials = @config.credentials
137
- credentials ||= Credentials.default scope: @config.scope
137
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
138
+ # but only if the default endpoint does not have a region prefix.
139
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
140
+ @config.endpoint == Client.configure.endpoint &&
141
+ !@config.endpoint.split(".").first.include?("-")
142
+ credentials ||= Credentials.default scope: @config.scope,
143
+ enable_self_signed_jwt: enable_self_signed_jwt
138
144
  if credentials.is_a?(String) || credentials.is_a?(Hash)
139
145
  credentials = Credentials.new credentials, scope: @config.scope
140
146
  end
@@ -135,7 +135,13 @@ module Google
135
135
 
136
136
  # Create credentials
137
137
  credentials = @config.credentials
138
- credentials ||= Credentials.default scope: @config.scope
138
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
139
+ # but only if the default endpoint does not have a region prefix.
140
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
141
+ @config.endpoint == Client.configure.endpoint &&
142
+ !@config.endpoint.split(".").first.include?("-")
143
+ credentials ||= Credentials.default scope: @config.scope,
144
+ enable_self_signed_jwt: enable_self_signed_jwt
139
145
  if credentials.is_a?(String) || credentials.is_a?(Hash)
140
146
  credentials = Credentials.new credentials, scope: @config.scope
141
147
  end
@@ -128,7 +128,13 @@ module Google
128
128
 
129
129
  # Create credentials
130
130
  credentials = @config.credentials
131
- credentials ||= Credentials.default scope: @config.scope
131
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
132
+ # but only if the default endpoint does not have a region prefix.
133
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
134
+ @config.endpoint == Client.configure.endpoint &&
135
+ !@config.endpoint.split(".").first.include?("-")
136
+ credentials ||= Credentials.default scope: @config.scope,
137
+ enable_self_signed_jwt: enable_self_signed_jwt
132
138
  if credentials.is_a?(String) || credentials.is_a?(Hash)
133
139
  credentials = Credentials.new credentials, scope: @config.scope
134
140
  end
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module ErrorReporting
23
23
  module V1beta1
24
- VERSION = "0.1.3"
24
+ VERSION = "0.2.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
@@ -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-error_reporting-v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.3
4
+ version: 0.2.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: 2021-01-19 00:00:00.000000000 Z
11
+ date: 2021-02-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -152,6 +152,9 @@ dependencies:
152
152
  version: '0.9'
153
153
  description: The Error Reporting API provides a simple endpoint to report errors from
154
154
  your running service, and read access to error groups and their associated errors.
155
+ Note that google-cloud-error_reporting-v1beta1 is a version-specific client library.
156
+ For most uses, we recommend installing the main client library google-cloud-error_reporting
157
+ instead. See the readme for more details.
155
158
  email: googleapis-packages@google.com
156
159
  executables: []
157
160
  extensions: []