google-cloud-logging-v2 0.3.1 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cec696718da2e399c1d53d2b1da764dda4d759ca703f5e5a6177c46604fa7a0f
4
- data.tar.gz: '05794f4fb216825976bf7882b0d6477263e4beb85db015799adeb560fd417805'
3
+ metadata.gz: e216376c818044085c0458bd8c566405dbec48867d6f2611a46e66a27f40d392
4
+ data.tar.gz: 5c5755cb11fe32a7e951f5e8e32fc3f3e24857631b00d568862f54f94d89553c
5
5
  SHA512:
6
- metadata.gz: f7d3861b2ca7929559980e0c4a2d8dee846b23cccd1671ef1a57baf9404507e5cee4a01f524949fa68039d638b84f77b7bec242366af1b139881f395a4799156
7
- data.tar.gz: a6e5fcafcfd5376a91f4ea83db9c4149b290f28028f7386618315528ecdaef8e7c3c4bf4d959b968f5d72d846191f86c3b97937033c140c7dfa5e311db03d55f
6
+ metadata.gz: 7e09aaf05aec87edd72de4e3d7e864d80738da5a9fd7e6d6fa6536262a333446a983888697f488875e071c85243268faeca6b407ae7c066aed2fadd3690e19d8
7
+ data.tar.gz: e23702e99761b2e99dcad73869bbebcf7245d8931a9582d9482ac8e68ef5cde900e38e82ede882fbcd637b7b7bb452bdcf64d05e4976a36e22aef154650dc8f2
data/README.md CHANGED
@@ -6,6 +6,12 @@ The Cloud Logging API lets you programmatically read and write log entries, set
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 Logging V2 API. Most users should consider using
11
+ the main client gem,
12
+ [google-cloud-logging](https://rubygems.org/gems/google-cloud-logging).
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-logging`,
87
+ and lower-level _versioned_ client libraries with names such as
88
+ `google-cloud-logging-v2`.
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-logging`.
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-logging-v2`.
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.
@@ -188,7 +188,13 @@ module Google
188
188
 
189
189
  # Create credentials
190
190
  credentials = @config.credentials
191
- credentials ||= Credentials.default scope: @config.scope
191
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
192
+ # but only if the default endpoint does not have a region prefix.
193
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
194
+ @config.endpoint == Client.configure.endpoint &&
195
+ !@config.endpoint.split(".").first.include?("-")
196
+ credentials ||= Credentials.default scope: @config.scope,
197
+ enable_self_signed_jwt: enable_self_signed_jwt
192
198
  if credentials.is_a?(String) || credentials.is_a?(Hash)
193
199
  credentials = Credentials.new credentials, scope: @config.scope
194
200
  end
@@ -174,7 +174,13 @@ module Google
174
174
 
175
175
  # Create credentials
176
176
  credentials = @config.credentials
177
- credentials ||= Credentials.default scope: @config.scope
177
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
178
+ # but only if the default endpoint does not have a region prefix.
179
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
180
+ @config.endpoint == Client.configure.endpoint &&
181
+ !@config.endpoint.split(".").first.include?("-")
182
+ credentials ||= Credentials.default scope: @config.scope,
183
+ enable_self_signed_jwt: enable_self_signed_jwt
178
184
  if credentials.is_a?(String) || credentials.is_a?(Hash)
179
185
  credentials = Credentials.new credentials, scope: @config.scope
180
186
  end
@@ -160,7 +160,13 @@ module Google
160
160
 
161
161
  # Create credentials
162
162
  credentials = @config.credentials
163
- credentials ||= Credentials.default scope: @config.scope
163
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
164
+ # but only if the default endpoint does not have a region prefix.
165
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
166
+ @config.endpoint == Client.configure.endpoint &&
167
+ !@config.endpoint.split(".").first.include?("-")
168
+ credentials ||= Credentials.default scope: @config.scope,
169
+ enable_self_signed_jwt: enable_self_signed_jwt
164
170
  if credentials.is_a?(String) || credentials.is_a?(Hash)
165
171
  credentials = Credentials.new credentials, scope: @config.scope
166
172
  end
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Logging
23
23
  module V2
24
- VERSION = "0.3.1"
24
+ VERSION = "0.4.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
@@ -57,10 +57,13 @@ module Google
57
57
  # Example 4: Pack and unpack a message in Go
58
58
  #
59
59
  # foo := &pb.Foo{...}
60
- # any, err := ptypes.MarshalAny(foo)
60
+ # any, err := anypb.New(foo)
61
+ # if err != nil {
62
+ # ...
63
+ # }
61
64
  # ...
62
65
  # foo := &pb.Foo{}
63
- # if err := ptypes.UnmarshalAny(any, foo); err != nil {
66
+ # if err := any.UnmarshalTo(foo); err != nil {
64
67
  # ...
65
68
  # }
66
69
  #
@@ -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-logging-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.1
4
+ version: 0.4.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-20 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
@@ -151,7 +151,10 @@ dependencies:
151
151
  - !ruby/object:Gem::Version
152
152
  version: '0.9'
153
153
  description: The Cloud Logging API lets you programmatically read and write log entries,
154
- set up exclusions, create logs-based metrics, and manage export sinks.
154
+ set up exclusions, create logs-based metrics, and manage export sinks. Note that
155
+ google-cloud-logging-v2 is a version-specific client library. For most uses, we
156
+ recommend installing the main client library google-cloud-logging instead. See the
157
+ readme for more details.
155
158
  email: googleapis-packages@google.com
156
159
  executables: []
157
160
  extensions: []