google-cloud-error_reporting-v1beta1 0.8.0 → 0.9.1

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: 4e73daf0ddf4c43d212c3d036cc4cb840a2cc06028e7e1476783af9884eb49a3
4
- data.tar.gz: 140d420af5873ca421fed57ee765c054854d0381aeb69379ec819bfd2e3b5ff8
3
+ metadata.gz: f1a4b8d170081e1db11f10ec4cca020328c8a14d9dabb45b17a9ad9eb7fc9750
4
+ data.tar.gz: b0947f13cd0f3f03f05fd36cda8e6da29be1fb865ff65ad96ab4843d58e8342b
5
5
  SHA512:
6
- metadata.gz: 3870dfbef0bcc1ed16d4de8762ef699f2c2a2afad5542ca5ddb1e474ed3655d176730fa1146ff31635662c48762aca7a2e9a2e26398ee1dd489db036c3c35a43
7
- data.tar.gz: 5a13ebe11f07d278e18ad1fe6680f3ecd79bbc6983335d93acba60853ee801f35edf4a5c311948f0477f2fa8643669cc4cf6ec4a8b08cb5c872bd90033897623
6
+ metadata.gz: a23204df33d79485249be587566de8d2b8c54ce642d00aa66f58d01e26853493fba63fadb514a52cb130c468cc66700def7e22d8adb2d30ab31e722c5af23bff
7
+ data.tar.gz: c0e4b51491038d3133e82c923b21d134ea55ab84846fff13580e00a2aa9c7da0a3ef150c63af8c11b3f844c29ad4f50b3b7eb22110f441d6b280db39c63c4c4c
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-error_reporting-v1beta1 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
6
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
- credentials will be discovered automatically. When running on other
8
- environments, the Service Account credentials can be specified by providing the
9
- path to the
10
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
- for the account (or the JSON itself) in
12
- [environment variables](#environment-variables). Additionally, Cloud SDK
13
- credentials can also be discovered automatically, but this is only recommended
14
- during development.
3
+ The recommended way to authenticate to the google-cloud-error_reporting-v1beta1 library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
15
6
 
16
7
  ## Quickstart
17
8
 
18
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export ERROR_REPORTING_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/error_reporting/v1beta1"
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
29
17
 
30
- client = ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-error_reporting-v1beta1 library aims to make authentication
36
- as simple as possible, and provides several mechanisms to configure your system
37
- without requiring **Service Account Credentials** directly in code.
38
-
39
- **Credentials** are discovered in the following order:
40
-
41
- 1. Specify credentials in method arguments
42
- 2. Specify credentials in configuration
43
- 3. Discover credentials path in environment variables
44
- 4. Discover credentials JSON in environment variables
45
- 5. Discover credentials file in the Cloud SDK's path
46
- 6. Discover GCP credentials
47
-
48
- ### Google Cloud Platform environments
22
+ 3. Write code as if already authenticated.
49
23
 
50
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
- Code should be written as if already authenticated.
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
54
26
 
55
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
61
- **Credentials JSON** file can be stored in the environment variable, or the
62
- **Credentials JSON** itself can be stored for environments such as Docker
63
- containers where writing files is difficult or not encouraged.
29
+ The google-cloud-error_reporting-v1beta1 library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
64
33
 
65
- The environment variables that google-cloud-error_reporting-v1beta1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `ERROR_REPORTING_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `ERROR_REPORTING_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
74
41
 
75
- ```ruby
76
- require "google/cloud/error_reporting/v1beta1"
77
-
78
- ENV["ERROR_REPORTING_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.new
81
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
82
49
 
83
- ### Configuration
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
84
53
 
85
- The path to the **Credentials JSON** file can be configured instead of storing
86
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
87
55
 
88
56
  ```ruby
89
57
  require "google/cloud/error_reporting/v1beta1"
90
58
 
91
59
  client = ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.new do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/error_reporting/v1beta1"
100
68
 
101
69
  ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.new
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- credentials are discovered.
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
113
82
 
114
- To configure your system for this, simply:
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
115
87
 
116
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 3. Write code as if already authenticated.
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-error_reporting-v1beta1
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/error_reporting/v1beta1"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
126
- connect to the APIs. You will use the **JSON key file** to
127
- connect to most services with google-cloud-error_reporting-v1beta1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
129
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
134
- 2. Create a new project or click on an existing project.
135
- 3. Activate the menu in the upper left and select **APIs & Services**. From
136
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
137
107
 
138
- *Note: You may need to enable billing in order to use these services.*
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
139
111
 
140
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
142
- Find the "Create credentials" drop down near the top of the page, and select
143
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
146
- new key file. Just select the account you wish to re-use, click the pencil
147
- tool on the right side to edit the service account, select the **Keys** tab,
148
- and then select **Add Key**.
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
149
120
 
150
- The key file you download will be used by this library to authenticate API
151
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
@@ -30,6 +30,9 @@ module Google
30
30
  # Service for retrieving and updating individual error groups.
31
31
  #
32
32
  class Client
33
+ # @private
34
+ DEFAULT_ENDPOINT_TEMPLATE = "clouderrorreporting.$UNIVERSE_DOMAIN$"
35
+
33
36
  include Paths
34
37
 
35
38
  # @private
@@ -95,6 +98,15 @@ module Google
95
98
  @config
96
99
  end
97
100
 
101
+ ##
102
+ # The effective universe domain
103
+ #
104
+ # @return [String]
105
+ #
106
+ def universe_domain
107
+ @error_group_service_stub.universe_domain
108
+ end
109
+
98
110
  ##
99
111
  # Create a new ErrorGroupService client object.
100
112
  #
@@ -128,8 +140,9 @@ module Google
128
140
  credentials = @config.credentials
129
141
  # Use self-signed JWT if the endpoint is unchanged from default,
130
142
  # but only if the default endpoint does not have a region prefix.
131
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
132
- !@config.endpoint.split(".").first.include?("-")
143
+ enable_self_signed_jwt = @config.endpoint.nil? ||
144
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
145
+ !@config.endpoint.split(".").first.include?("-"))
133
146
  credentials ||= Credentials.default scope: @config.scope,
134
147
  enable_self_signed_jwt: enable_self_signed_jwt
135
148
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -140,8 +153,10 @@ module Google
140
153
 
141
154
  @error_group_service_stub = ::Gapic::ServiceStub.new(
142
155
  ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Stub,
143
- credentials: credentials,
144
- endpoint: @config.endpoint,
156
+ credentials: credentials,
157
+ endpoint: @config.endpoint,
158
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
159
+ universe_domain: @config.universe_domain,
145
160
  channel_args: @config.channel_args,
146
161
  interceptors: @config.interceptors,
147
162
  channel_pool_config: @config.channel_pool
@@ -356,9 +371,9 @@ module Google
356
371
  # end
357
372
  #
358
373
  # @!attribute [rw] endpoint
359
- # The hostname or hostname:port of the service endpoint.
360
- # Defaults to `"clouderrorreporting.googleapis.com"`.
361
- # @return [::String]
374
+ # A custom service endpoint, as a hostname or hostname:port. The default is
375
+ # nil, indicating to use the default endpoint in the current universe domain.
376
+ # @return [::String,nil]
362
377
  # @!attribute [rw] credentials
363
378
  # Credentials to send with calls. You may provide any of the following types:
364
379
  # * (`String`) The path to a service account key file in JSON format
@@ -404,13 +419,20 @@ module Google
404
419
  # @!attribute [rw] quota_project
405
420
  # A separate project against which to charge quota.
406
421
  # @return [::String]
422
+ # @!attribute [rw] universe_domain
423
+ # The universe domain within which to make requests. This determines the
424
+ # default endpoint URL. The default value of nil uses the environment
425
+ # universe (usually the default "googleapis.com" universe).
426
+ # @return [::String,nil]
407
427
  #
408
428
  class Configuration
409
429
  extend ::Gapic::Config
410
430
 
431
+ # @private
432
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
411
433
  DEFAULT_ENDPOINT = "clouderrorreporting.googleapis.com"
412
434
 
413
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
435
+ config_attr :endpoint, nil, ::String, nil
414
436
  config_attr :credentials, nil do |value|
415
437
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
416
438
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -425,6 +447,7 @@ module Google
425
447
  config_attr :metadata, nil, ::Hash, nil
426
448
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
427
449
  config_attr :quota_project, nil, ::String, nil
450
+ config_attr :universe_domain, nil, ::String, nil
428
451
 
429
452
  # @private
430
453
  def initialize parent_config = nil
@@ -32,6 +32,9 @@ module Google
32
32
  # Service for retrieving and updating individual error groups.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "clouderrorreporting.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -97,6 +100,15 @@ module Google
97
100
  @config
98
101
  end
99
102
 
103
+ ##
104
+ # The effective universe domain
105
+ #
106
+ # @return [String]
107
+ #
108
+ def universe_domain
109
+ @error_group_service_stub.universe_domain
110
+ end
111
+
100
112
  ##
101
113
  # Create a new ErrorGroupService REST client object.
102
114
  #
@@ -124,8 +136,9 @@ module Google
124
136
  credentials = @config.credentials
125
137
  # Use self-signed JWT if the endpoint is unchanged from default,
126
138
  # but only if the default endpoint does not have a region prefix.
127
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
128
- !@config.endpoint.split(".").first.include?("-")
139
+ enable_self_signed_jwt = @config.endpoint.nil? ||
140
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
141
+ !@config.endpoint.split(".").first.include?("-"))
129
142
  credentials ||= Credentials.default scope: @config.scope,
130
143
  enable_self_signed_jwt: enable_self_signed_jwt
131
144
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -135,7 +148,12 @@ module Google
135
148
  @quota_project_id = @config.quota_project
136
149
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
137
150
 
138
- @error_group_service_stub = ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
151
+ @error_group_service_stub = ::Google::Cloud::ErrorReporting::V1beta1::ErrorGroupService::Rest::ServiceStub.new(
152
+ endpoint: @config.endpoint,
153
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
154
+ universe_domain: @config.universe_domain,
155
+ credentials: credentials
156
+ )
139
157
  end
140
158
 
141
159
  # Service calls
@@ -332,9 +350,9 @@ module Google
332
350
  # end
333
351
  #
334
352
  # @!attribute [rw] endpoint
335
- # The hostname or hostname:port of the service endpoint.
336
- # Defaults to `"clouderrorreporting.googleapis.com"`.
337
- # @return [::String]
353
+ # A custom service endpoint, as a hostname or hostname:port. The default is
354
+ # nil, indicating to use the default endpoint in the current universe domain.
355
+ # @return [::String,nil]
338
356
  # @!attribute [rw] credentials
339
357
  # Credentials to send with calls. You may provide any of the following types:
340
358
  # * (`String`) The path to a service account key file in JSON format
@@ -371,13 +389,20 @@ module Google
371
389
  # @!attribute [rw] quota_project
372
390
  # A separate project against which to charge quota.
373
391
  # @return [::String]
392
+ # @!attribute [rw] universe_domain
393
+ # The universe domain within which to make requests. This determines the
394
+ # default endpoint URL. The default value of nil uses the environment
395
+ # universe (usually the default "googleapis.com" universe).
396
+ # @return [::String,nil]
374
397
  #
375
398
  class Configuration
376
399
  extend ::Gapic::Config
377
400
 
401
+ # @private
402
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
378
403
  DEFAULT_ENDPOINT = "clouderrorreporting.googleapis.com"
379
404
 
380
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
405
+ config_attr :endpoint, nil, ::String, nil
381
406
  config_attr :credentials, nil do |value|
382
407
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
383
408
  allowed.any? { |klass| klass === value }
@@ -389,6 +414,7 @@ module Google
389
414
  config_attr :metadata, nil, ::Hash, nil
390
415
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
391
416
  config_attr :quota_project, nil, ::String, nil
417
+ config_attr :universe_domain, nil, ::String, nil
392
418
 
393
419
  # @private
394
420
  def initialize parent_config = nil
@@ -30,16 +30,37 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
55
+ ##
56
+ # The effective endpoint
57
+ #
58
+ # @return [String]
59
+ #
60
+ def endpoint
61
+ @client_stub.endpoint
62
+ end
63
+
43
64
  ##
44
65
  # Baseline implementation for the get_group REST call
45
66
  #
@@ -31,6 +31,9 @@ module Google
31
31
  # individual events.
32
32
  #
33
33
  class Client
34
+ # @private
35
+ DEFAULT_ENDPOINT_TEMPLATE = "clouderrorreporting.$UNIVERSE_DOMAIN$"
36
+
34
37
  include Paths
35
38
 
36
39
  # @private
@@ -96,6 +99,15 @@ module Google
96
99
  @config
97
100
  end
98
101
 
102
+ ##
103
+ # The effective universe domain
104
+ #
105
+ # @return [String]
106
+ #
107
+ def universe_domain
108
+ @error_stats_service_stub.universe_domain
109
+ end
110
+
99
111
  ##
100
112
  # Create a new ErrorStatsService client object.
101
113
  #
@@ -129,8 +141,9 @@ module Google
129
141
  credentials = @config.credentials
130
142
  # Use self-signed JWT if the endpoint is unchanged from default,
131
143
  # but only if the default endpoint does not have a region prefix.
132
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
133
- !@config.endpoint.split(".").first.include?("-")
144
+ enable_self_signed_jwt = @config.endpoint.nil? ||
145
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
146
+ !@config.endpoint.split(".").first.include?("-"))
134
147
  credentials ||= Credentials.default scope: @config.scope,
135
148
  enable_self_signed_jwt: enable_self_signed_jwt
136
149
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -141,8 +154,10 @@ module Google
141
154
 
142
155
  @error_stats_service_stub = ::Gapic::ServiceStub.new(
143
156
  ::Google::Cloud::ErrorReporting::V1beta1::ErrorStatsService::Stub,
144
- credentials: credentials,
145
- endpoint: @config.endpoint,
157
+ credentials: credentials,
158
+ endpoint: @config.endpoint,
159
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
160
+ universe_domain: @config.universe_domain,
146
161
  channel_args: @config.channel_args,
147
162
  interceptors: @config.interceptors,
148
163
  channel_pool_config: @config.channel_pool
@@ -509,9 +524,9 @@ module Google
509
524
  # end
510
525
  #
511
526
  # @!attribute [rw] endpoint
512
- # The hostname or hostname:port of the service endpoint.
513
- # Defaults to `"clouderrorreporting.googleapis.com"`.
514
- # @return [::String]
527
+ # A custom service endpoint, as a hostname or hostname:port. The default is
528
+ # nil, indicating to use the default endpoint in the current universe domain.
529
+ # @return [::String,nil]
515
530
  # @!attribute [rw] credentials
516
531
  # Credentials to send with calls. You may provide any of the following types:
517
532
  # * (`String`) The path to a service account key file in JSON format
@@ -557,13 +572,20 @@ module Google
557
572
  # @!attribute [rw] quota_project
558
573
  # A separate project against which to charge quota.
559
574
  # @return [::String]
575
+ # @!attribute [rw] universe_domain
576
+ # The universe domain within which to make requests. This determines the
577
+ # default endpoint URL. The default value of nil uses the environment
578
+ # universe (usually the default "googleapis.com" universe).
579
+ # @return [::String,nil]
560
580
  #
561
581
  class Configuration
562
582
  extend ::Gapic::Config
563
583
 
584
+ # @private
585
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
564
586
  DEFAULT_ENDPOINT = "clouderrorreporting.googleapis.com"
565
587
 
566
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
588
+ config_attr :endpoint, nil, ::String, nil
567
589
  config_attr :credentials, nil do |value|
568
590
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
569
591
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -578,6 +600,7 @@ module Google
578
600
  config_attr :metadata, nil, ::Hash, nil
579
601
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
580
602
  config_attr :quota_project, nil, ::String, nil
603
+ config_attr :universe_domain, nil, ::String, nil
581
604
 
582
605
  # @private
583
606
  def initialize parent_config = nil
@@ -33,6 +33,9 @@ module Google
33
33
  # individual events.
34
34
  #
35
35
  class Client
36
+ # @private
37
+ DEFAULT_ENDPOINT_TEMPLATE = "clouderrorreporting.$UNIVERSE_DOMAIN$"
38
+
36
39
  include Paths
37
40
 
38
41
  # @private
@@ -98,6 +101,15 @@ module Google
98
101
  @config
99
102
  end
100
103
 
104
+ ##
105
+ # The effective universe domain
106
+ #
107
+ # @return [String]
108
+ #
109
+ def universe_domain
110
+ @error_stats_service_stub.universe_domain
111
+ end
112
+
101
113
  ##
102
114
  # Create a new ErrorStatsService REST client object.
103
115
  #
@@ -125,8 +137,9 @@ module Google
125
137
  credentials = @config.credentials
126
138
  # Use self-signed JWT if the endpoint is unchanged from default,
127
139
  # but only if the default endpoint does not have a region prefix.
128
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
129
- !@config.endpoint.split(".").first.include?("-")
140
+ enable_self_signed_jwt = @config.endpoint.nil? ||
141
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
142
+ !@config.endpoint.split(".").first.include?("-"))
130
143
  credentials ||= Credentials.default scope: @config.scope,
131
144
  enable_self_signed_jwt: enable_self_signed_jwt
132
145
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -136,7 +149,12 @@ module Google
136
149
  @quota_project_id = @config.quota_project
137
150
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
138
151
 
139
- @error_stats_service_stub = ::Google::Cloud::ErrorReporting::V1beta1::ErrorStatsService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
152
+ @error_stats_service_stub = ::Google::Cloud::ErrorReporting::V1beta1::ErrorStatsService::Rest::ServiceStub.new(
153
+ endpoint: @config.endpoint,
154
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
155
+ universe_domain: @config.universe_domain,
156
+ credentials: credentials
157
+ )
140
158
  end
141
159
 
142
160
  # Service calls
@@ -478,9 +496,9 @@ module Google
478
496
  # end
479
497
  #
480
498
  # @!attribute [rw] endpoint
481
- # The hostname or hostname:port of the service endpoint.
482
- # Defaults to `"clouderrorreporting.googleapis.com"`.
483
- # @return [::String]
499
+ # A custom service endpoint, as a hostname or hostname:port. The default is
500
+ # nil, indicating to use the default endpoint in the current universe domain.
501
+ # @return [::String,nil]
484
502
  # @!attribute [rw] credentials
485
503
  # Credentials to send with calls. You may provide any of the following types:
486
504
  # * (`String`) The path to a service account key file in JSON format
@@ -517,13 +535,20 @@ module Google
517
535
  # @!attribute [rw] quota_project
518
536
  # A separate project against which to charge quota.
519
537
  # @return [::String]
538
+ # @!attribute [rw] universe_domain
539
+ # The universe domain within which to make requests. This determines the
540
+ # default endpoint URL. The default value of nil uses the environment
541
+ # universe (usually the default "googleapis.com" universe).
542
+ # @return [::String,nil]
520
543
  #
521
544
  class Configuration
522
545
  extend ::Gapic::Config
523
546
 
547
+ # @private
548
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
524
549
  DEFAULT_ENDPOINT = "clouderrorreporting.googleapis.com"
525
550
 
526
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
551
+ config_attr :endpoint, nil, ::String, nil
527
552
  config_attr :credentials, nil do |value|
528
553
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
529
554
  allowed.any? { |klass| klass === value }
@@ -535,6 +560,7 @@ module Google
535
560
  config_attr :metadata, nil, ::Hash, nil
536
561
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
537
562
  config_attr :quota_project, nil, ::String, nil
563
+ config_attr :universe_domain, nil, ::String, nil
538
564
 
539
565
  # @private
540
566
  def initialize parent_config = nil
@@ -30,16 +30,37 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
55
+ ##
56
+ # The effective endpoint
57
+ #
58
+ # @return [String]
59
+ #
60
+ def endpoint
61
+ @client_stub.endpoint
62
+ end
63
+
43
64
  ##
44
65
  # Baseline implementation for the list_group_stats REST call
45
66
  #
@@ -30,6 +30,9 @@ module Google
30
30
  # An API for reporting error events.
31
31
  #
32
32
  class Client
33
+ # @private
34
+ DEFAULT_ENDPOINT_TEMPLATE = "clouderrorreporting.$UNIVERSE_DOMAIN$"
35
+
33
36
  include Paths
34
37
 
35
38
  # @private
@@ -92,6 +95,15 @@ module Google
92
95
  @config
93
96
  end
94
97
 
98
+ ##
99
+ # The effective universe domain
100
+ #
101
+ # @return [String]
102
+ #
103
+ def universe_domain
104
+ @report_errors_service_stub.universe_domain
105
+ end
106
+
95
107
  ##
96
108
  # Create a new ReportErrorsService client object.
97
109
  #
@@ -125,8 +137,9 @@ module Google
125
137
  credentials = @config.credentials
126
138
  # Use self-signed JWT if the endpoint is unchanged from default,
127
139
  # but only if the default endpoint does not have a region prefix.
128
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
129
- !@config.endpoint.split(".").first.include?("-")
140
+ enable_self_signed_jwt = @config.endpoint.nil? ||
141
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
142
+ !@config.endpoint.split(".").first.include?("-"))
130
143
  credentials ||= Credentials.default scope: @config.scope,
131
144
  enable_self_signed_jwt: enable_self_signed_jwt
132
145
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -137,8 +150,10 @@ module Google
137
150
 
138
151
  @report_errors_service_stub = ::Gapic::ServiceStub.new(
139
152
  ::Google::Cloud::ErrorReporting::V1beta1::ReportErrorsService::Stub,
140
- credentials: credentials,
141
- endpoint: @config.endpoint,
153
+ credentials: credentials,
154
+ endpoint: @config.endpoint,
155
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
156
+ universe_domain: @config.universe_domain,
142
157
  channel_args: @config.channel_args,
143
158
  interceptors: @config.interceptors,
144
159
  channel_pool_config: @config.channel_pool
@@ -281,9 +296,9 @@ module Google
281
296
  # end
282
297
  #
283
298
  # @!attribute [rw] endpoint
284
- # The hostname or hostname:port of the service endpoint.
285
- # Defaults to `"clouderrorreporting.googleapis.com"`.
286
- # @return [::String]
299
+ # A custom service endpoint, as a hostname or hostname:port. The default is
300
+ # nil, indicating to use the default endpoint in the current universe domain.
301
+ # @return [::String,nil]
287
302
  # @!attribute [rw] credentials
288
303
  # Credentials to send with calls. You may provide any of the following types:
289
304
  # * (`String`) The path to a service account key file in JSON format
@@ -329,13 +344,20 @@ module Google
329
344
  # @!attribute [rw] quota_project
330
345
  # A separate project against which to charge quota.
331
346
  # @return [::String]
347
+ # @!attribute [rw] universe_domain
348
+ # The universe domain within which to make requests. This determines the
349
+ # default endpoint URL. The default value of nil uses the environment
350
+ # universe (usually the default "googleapis.com" universe).
351
+ # @return [::String,nil]
332
352
  #
333
353
  class Configuration
334
354
  extend ::Gapic::Config
335
355
 
356
+ # @private
357
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
336
358
  DEFAULT_ENDPOINT = "clouderrorreporting.googleapis.com"
337
359
 
338
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
360
+ config_attr :endpoint, nil, ::String, nil
339
361
  config_attr :credentials, nil do |value|
340
362
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
341
363
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -350,6 +372,7 @@ module Google
350
372
  config_attr :metadata, nil, ::Hash, nil
351
373
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
352
374
  config_attr :quota_project, nil, ::String, nil
375
+ config_attr :universe_domain, nil, ::String, nil
353
376
 
354
377
  # @private
355
378
  def initialize parent_config = nil
@@ -32,6 +32,9 @@ module Google
32
32
  # An API for reporting error events.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "clouderrorreporting.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -94,6 +97,15 @@ module Google
94
97
  @config
95
98
  end
96
99
 
100
+ ##
101
+ # The effective universe domain
102
+ #
103
+ # @return [String]
104
+ #
105
+ def universe_domain
106
+ @report_errors_service_stub.universe_domain
107
+ end
108
+
97
109
  ##
98
110
  # Create a new ReportErrorsService REST client object.
99
111
  #
@@ -121,8 +133,9 @@ module Google
121
133
  credentials = @config.credentials
122
134
  # Use self-signed JWT if the endpoint is unchanged from default,
123
135
  # but only if the default endpoint does not have a region prefix.
124
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
125
- !@config.endpoint.split(".").first.include?("-")
136
+ enable_self_signed_jwt = @config.endpoint.nil? ||
137
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
138
+ !@config.endpoint.split(".").first.include?("-"))
126
139
  credentials ||= Credentials.default scope: @config.scope,
127
140
  enable_self_signed_jwt: enable_self_signed_jwt
128
141
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -132,7 +145,12 @@ module Google
132
145
  @quota_project_id = @config.quota_project
133
146
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
134
147
 
135
- @report_errors_service_stub = ::Google::Cloud::ErrorReporting::V1beta1::ReportErrorsService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
148
+ @report_errors_service_stub = ::Google::Cloud::ErrorReporting::V1beta1::ReportErrorsService::Rest::ServiceStub.new(
149
+ endpoint: @config.endpoint,
150
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
151
+ universe_domain: @config.universe_domain,
152
+ credentials: credentials
153
+ )
136
154
  end
137
155
 
138
156
  # Service calls
@@ -264,9 +282,9 @@ module Google
264
282
  # end
265
283
  #
266
284
  # @!attribute [rw] endpoint
267
- # The hostname or hostname:port of the service endpoint.
268
- # Defaults to `"clouderrorreporting.googleapis.com"`.
269
- # @return [::String]
285
+ # A custom service endpoint, as a hostname or hostname:port. The default is
286
+ # nil, indicating to use the default endpoint in the current universe domain.
287
+ # @return [::String,nil]
270
288
  # @!attribute [rw] credentials
271
289
  # Credentials to send with calls. You may provide any of the following types:
272
290
  # * (`String`) The path to a service account key file in JSON format
@@ -303,13 +321,20 @@ module Google
303
321
  # @!attribute [rw] quota_project
304
322
  # A separate project against which to charge quota.
305
323
  # @return [::String]
324
+ # @!attribute [rw] universe_domain
325
+ # The universe domain within which to make requests. This determines the
326
+ # default endpoint URL. The default value of nil uses the environment
327
+ # universe (usually the default "googleapis.com" universe).
328
+ # @return [::String,nil]
306
329
  #
307
330
  class Configuration
308
331
  extend ::Gapic::Config
309
332
 
333
+ # @private
334
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
310
335
  DEFAULT_ENDPOINT = "clouderrorreporting.googleapis.com"
311
336
 
312
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
337
+ config_attr :endpoint, nil, ::String, nil
313
338
  config_attr :credentials, nil do |value|
314
339
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
315
340
  allowed.any? { |klass| klass === value }
@@ -321,6 +346,7 @@ module Google
321
346
  config_attr :metadata, nil, ::Hash, nil
322
347
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
323
348
  config_attr :quota_project, nil, ::String, nil
349
+ config_attr :universe_domain, nil, ::String, nil
324
350
 
325
351
  # @private
326
352
  def initialize parent_config = nil
@@ -30,16 +30,37 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
55
+ ##
56
+ # The effective endpoint
57
+ #
58
+ # @return [String]
59
+ #
60
+ def endpoint
61
+ @client_stub.endpoint
62
+ end
63
+
43
64
  ##
44
65
  # Baseline implementation for the report_error_event REST call
45
66
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module ErrorReporting
23
23
  module V1beta1
24
- VERSION = "0.8.0"
24
+ VERSION = "0.9.1"
25
25
  end
26
26
  end
27
27
  end
@@ -21,6 +21,7 @@ module Google
21
21
  module Api
22
22
  # Required information for every language.
23
23
  # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
24
25
  # @return [::String]
25
26
  # Link to automatically generated reference documentation. Example:
26
27
  # https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
304
305
  # seconds: 360 # 6 minutes
305
306
  # total_poll_timeout:
306
307
  # seconds: 54000 # 90 minutes
308
+ # @!attribute [rw] auto_populated_fields
309
+ # @return [::Array<::String>]
310
+ # List of top-level fields of the request message, that should be
311
+ # automatically populated by the client libraries based on their
312
+ # (google.api.field_info).format. Currently supported format: UUID4.
313
+ #
314
+ # Example of a YAML configuration:
315
+ #
316
+ # publishing:
317
+ # method_settings:
318
+ # - selector: google.example.v1.ExampleService.CreateExample
319
+ # auto_populated_fields:
320
+ # - request_id
307
321
  class MethodSettings
308
322
  include ::Google::Protobuf::MessageExts
309
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.8.0
4
+ version: 0.9.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-12 00:00:00.000000000 Z
11
+ date: 2024-01-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.20.0
19
+ version: 0.21.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.20.0
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -232,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
232
232
  - !ruby/object:Gem::Version
233
233
  version: '0'
234
234
  requirements: []
235
- rubygems_version: 3.4.19
235
+ rubygems_version: 3.5.3
236
236
  signing_key:
237
237
  specification_version: 4
238
238
  summary: Groups and counts similar errors from cloud services and applications, reports