google-cloud-monitoring-dashboard-v1 0.12.1 → 0.14.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb +41 -9
  4. data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service/rest/client.rb +117 -7
  5. data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service/rest/service_stub.rb +14 -2
  6. data/lib/google/cloud/monitoring/dashboard/v1/version.rb +1 -1
  7. data/proto_docs/google/api/client.rb +14 -0
  8. data/proto_docs/google/api/field_behavior.rb +14 -0
  9. data/proto_docs/google/monitoring/dashboard/v1/metrics.rb +2 -0
  10. data/proto_docs/google/monitoring/dashboard/v1/table_display_options.rb +1 -0
  11. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 91d27544406498203c77c4dee0f815abd3f8d0c4780a6e9fb557e29bd215dc38
4
- data.tar.gz: 7e029c34e4dc36569702ab1193b27fd8cf101fd8cd02401d91bf799779305d4c
3
+ metadata.gz: b9d959dcd209cbfb3ba8e0f735a18d279cdefac0a78b23562b6b9e07557dc9fb
4
+ data.tar.gz: 93ffc999a62fc89fbc3a08c1a95b9bc36f18cec5cb5707cc5463a0a860047d91
5
5
  SHA512:
6
- metadata.gz: 7f3faa5acb66feb560d2334acc159eb90054bd8bb46b5254cfc69e6afe1666f3ad29d79ba3f0166e252bbb872b59bd61bd5d932cdf790ca6164eec68ab0606c3
7
- data.tar.gz: bf4338ca2ccf5140417588f8998a84b0737d4fc1360e9e95c250eeeeb39c587b2edc15c6b6a131e84f0b90709db5f0cffd0e1db92373478d3709bd22963df441
6
+ metadata.gz: cc8d6fbc247885ca666bd935eaa62f0b95223644824b55718dc14556e11f042402bddf0df327c92b3e86b32ed8546dc991cb705d62420b5b595c34fff8c35061
7
+ data.tar.gz: dea02f5a37042b0228da9796c23a6bfa9e267540d34f796e13d5e6ce8ffed25cd5c4d507f211fe0ad7eeef9cd01416c243ae5bd624fa9044b6d8c7f7e00415c7
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-monitoring-dashboard-v1 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-monitoring-dashboard-v1 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 MONITORING_DASHBOARD_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/monitoring/dashboard/v1"
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::Monitoring::Dashboard::V1::DashboardsService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-monitoring-dashboard-v1 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-monitoring-dashboard-v1 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-monitoring-dashboard-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `MONITORING_DASHBOARD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `MONITORING_DASHBOARD_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/monitoring/dashboard/v1"
77
-
78
- ENV["MONITORING_DASHBOARD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::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/monitoring/dashboard/v1"
90
58
 
91
59
  client = ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::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/monitoring/dashboard/v1"
100
68
 
101
69
  ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::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::Monitoring::Dashboard::V1::DashboardsService::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-monitoring-dashboard-v1
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/monitoring/dashboard/v1"
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-monitoring-dashboard-v1.
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::Monitoring::Dashboard::V1::DashboardsService::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).
data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # widgets in a specific layout.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "monitoring.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -103,6 +106,15 @@ module Google
103
106
  @config
104
107
  end
105
108
 
109
+ ##
110
+ # The effective universe domain
111
+ #
112
+ # @return [String]
113
+ #
114
+ def universe_domain
115
+ @dashboards_service_stub.universe_domain
116
+ end
117
+
106
118
  ##
107
119
  # Create a new DashboardsService client object.
108
120
  #
@@ -136,8 +148,9 @@ module Google
136
148
  credentials = @config.credentials
137
149
  # Use self-signed JWT if the endpoint is unchanged from default,
138
150
  # but only if the default endpoint does not have a region prefix.
139
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
140
- !@config.endpoint.split(".").first.include?("-")
151
+ enable_self_signed_jwt = @config.endpoint.nil? ||
152
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
153
+ !@config.endpoint.split(".").first.include?("-"))
141
154
  credentials ||= Credentials.default scope: @config.scope,
142
155
  enable_self_signed_jwt: enable_self_signed_jwt
143
156
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -148,10 +161,13 @@ module Google
148
161
 
149
162
  @dashboards_service_stub = ::Gapic::ServiceStub.new(
150
163
  ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Stub,
151
- credentials: credentials,
152
- endpoint: @config.endpoint,
164
+ credentials: credentials,
165
+ endpoint: @config.endpoint,
166
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
167
+ universe_domain: @config.universe_domain,
153
168
  channel_args: @config.channel_args,
154
- interceptors: @config.interceptors
169
+ interceptors: @config.interceptors,
170
+ channel_pool_config: @config.channel_pool
155
171
  )
156
172
  end
157
173
 
@@ -665,9 +681,9 @@ module Google
665
681
  # end
666
682
  #
667
683
  # @!attribute [rw] endpoint
668
- # The hostname or hostname:port of the service endpoint.
669
- # Defaults to `"monitoring.googleapis.com"`.
670
- # @return [::String]
684
+ # A custom service endpoint, as a hostname or hostname:port. The default is
685
+ # nil, indicating to use the default endpoint in the current universe domain.
686
+ # @return [::String,nil]
671
687
  # @!attribute [rw] credentials
672
688
  # Credentials to send with calls. You may provide any of the following types:
673
689
  # * (`String`) The path to a service account key file in JSON format
@@ -713,13 +729,20 @@ module Google
713
729
  # @!attribute [rw] quota_project
714
730
  # A separate project against which to charge quota.
715
731
  # @return [::String]
732
+ # @!attribute [rw] universe_domain
733
+ # The universe domain within which to make requests. This determines the
734
+ # default endpoint URL. The default value of nil uses the environment
735
+ # universe (usually the default "googleapis.com" universe).
736
+ # @return [::String,nil]
716
737
  #
717
738
  class Configuration
718
739
  extend ::Gapic::Config
719
740
 
741
+ # @private
742
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
720
743
  DEFAULT_ENDPOINT = "monitoring.googleapis.com"
721
744
 
722
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
745
+ config_attr :endpoint, nil, ::String, nil
723
746
  config_attr :credentials, nil do |value|
724
747
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
725
748
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -734,6 +757,7 @@ module Google
734
757
  config_attr :metadata, nil, ::Hash, nil
735
758
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
736
759
  config_attr :quota_project, nil, ::String, nil
760
+ config_attr :universe_domain, nil, ::String, nil
737
761
 
738
762
  # @private
739
763
  def initialize parent_config = nil
@@ -754,6 +778,14 @@ module Google
754
778
  end
755
779
  end
756
780
 
781
+ ##
782
+ # Configuration for the channel pool
783
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
784
+ #
785
+ def channel_pool
786
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
787
+ end
788
+
757
789
  ##
758
790
  # Configuration RPC class for the DashboardsService API.
759
791
  #
data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service/rest/client.rb CHANGED
@@ -34,6 +34,9 @@ module Google
34
34
  # widgets in a specific layout.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "monitoring.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -105,6 +108,15 @@ module Google
105
108
  @config
106
109
  end
107
110
 
111
+ ##
112
+ # The effective universe domain
113
+ #
114
+ # @return [String]
115
+ #
116
+ def universe_domain
117
+ @dashboards_service_stub.universe_domain
118
+ end
119
+
108
120
  ##
109
121
  # Create a new DashboardsService REST client object.
110
122
  #
@@ -132,8 +144,9 @@ module Google
132
144
  credentials = @config.credentials
133
145
  # Use self-signed JWT if the endpoint is unchanged from default,
134
146
  # but only if the default endpoint does not have a region prefix.
135
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
136
- !@config.endpoint.split(".").first.include?("-")
147
+ enable_self_signed_jwt = @config.endpoint.nil? ||
148
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
149
+ !@config.endpoint.split(".").first.include?("-"))
137
150
  credentials ||= Credentials.default scope: @config.scope,
138
151
  enable_self_signed_jwt: enable_self_signed_jwt
139
152
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -143,7 +156,12 @@ module Google
143
156
  @quota_project_id = @config.quota_project
144
157
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
145
158
 
146
- @dashboards_service_stub = ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
159
+ @dashboards_service_stub = ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Rest::ServiceStub.new(
160
+ endpoint: @config.endpoint,
161
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
162
+ universe_domain: @config.universe_domain,
163
+ credentials: credentials
164
+ )
147
165
  end
148
166
 
149
167
  # Service calls
@@ -189,6 +207,22 @@ module Google
189
207
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]
190
208
  #
191
209
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
210
+ #
211
+ # @example Basic example
212
+ # require "google/cloud/monitoring/dashboard/v1"
213
+ #
214
+ # # Create a client object. The client can be reused for multiple calls.
215
+ # client = Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Rest::Client.new
216
+ #
217
+ # # Create a request. To set request fields, pass in keyword arguments.
218
+ # request = Google::Cloud::Monitoring::Dashboard::V1::CreateDashboardRequest.new
219
+ #
220
+ # # Call the create_dashboard method.
221
+ # result = client.create_dashboard request
222
+ #
223
+ # # The returned object is of type Google::Cloud::Monitoring::Dashboard::V1::Dashboard.
224
+ # p result
225
+ #
192
226
  def create_dashboard request, options = nil
193
227
  raise ::ArgumentError, "request must be provided" if request.nil?
194
228
 
@@ -264,6 +298,26 @@ module Google
264
298
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Monitoring::Dashboard::V1::Dashboard>]
265
299
  #
266
300
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
301
+ #
302
+ # @example Basic example
303
+ # require "google/cloud/monitoring/dashboard/v1"
304
+ #
305
+ # # Create a client object. The client can be reused for multiple calls.
306
+ # client = Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Rest::Client.new
307
+ #
308
+ # # Create a request. To set request fields, pass in keyword arguments.
309
+ # request = Google::Cloud::Monitoring::Dashboard::V1::ListDashboardsRequest.new
310
+ #
311
+ # # Call the list_dashboards method.
312
+ # result = client.list_dashboards request
313
+ #
314
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
315
+ # # over elements, and API calls will be issued to fetch pages as needed.
316
+ # result.each do |item|
317
+ # # Each element is of type ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard.
318
+ # p item
319
+ # end
320
+ #
267
321
  def list_dashboards request, options = nil
268
322
  raise ::ArgumentError, "request must be provided" if request.nil?
269
323
 
@@ -335,6 +389,22 @@ module Google
335
389
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]
336
390
  #
337
391
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
392
+ #
393
+ # @example Basic example
394
+ # require "google/cloud/monitoring/dashboard/v1"
395
+ #
396
+ # # Create a client object. The client can be reused for multiple calls.
397
+ # client = Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Rest::Client.new
398
+ #
399
+ # # Create a request. To set request fields, pass in keyword arguments.
400
+ # request = Google::Cloud::Monitoring::Dashboard::V1::GetDashboardRequest.new
401
+ #
402
+ # # Call the get_dashboard method.
403
+ # result = client.get_dashboard request
404
+ #
405
+ # # The returned object is of type Google::Cloud::Monitoring::Dashboard::V1::Dashboard.
406
+ # p result
407
+ #
338
408
  def get_dashboard request, options = nil
339
409
  raise ::ArgumentError, "request must be provided" if request.nil?
340
410
 
@@ -403,6 +473,22 @@ module Google
403
473
  # @return [::Google::Protobuf::Empty]
404
474
  #
405
475
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
476
+ #
477
+ # @example Basic example
478
+ # require "google/cloud/monitoring/dashboard/v1"
479
+ #
480
+ # # Create a client object. The client can be reused for multiple calls.
481
+ # client = Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Rest::Client.new
482
+ #
483
+ # # Create a request. To set request fields, pass in keyword arguments.
484
+ # request = Google::Cloud::Monitoring::Dashboard::V1::DeleteDashboardRequest.new
485
+ #
486
+ # # Call the delete_dashboard method.
487
+ # result = client.delete_dashboard request
488
+ #
489
+ # # The returned object is of type Google::Protobuf::Empty.
490
+ # p result
491
+ #
406
492
  def delete_dashboard request, options = nil
407
493
  raise ::ArgumentError, "request must be provided" if request.nil?
408
494
 
@@ -472,6 +558,22 @@ module Google
472
558
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]
473
559
  #
474
560
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
561
+ #
562
+ # @example Basic example
563
+ # require "google/cloud/monitoring/dashboard/v1"
564
+ #
565
+ # # Create a client object. The client can be reused for multiple calls.
566
+ # client = Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Rest::Client.new
567
+ #
568
+ # # Create a request. To set request fields, pass in keyword arguments.
569
+ # request = Google::Cloud::Monitoring::Dashboard::V1::UpdateDashboardRequest.new
570
+ #
571
+ # # Call the update_dashboard method.
572
+ # result = client.update_dashboard request
573
+ #
574
+ # # The returned object is of type Google::Cloud::Monitoring::Dashboard::V1::Dashboard.
575
+ # p result
576
+ #
475
577
  def update_dashboard request, options = nil
476
578
  raise ::ArgumentError, "request must be provided" if request.nil?
477
579
 
@@ -537,9 +639,9 @@ module Google
537
639
  # end
538
640
  #
539
641
  # @!attribute [rw] endpoint
540
- # The hostname or hostname:port of the service endpoint.
541
- # Defaults to `"monitoring.googleapis.com"`.
542
- # @return [::String]
642
+ # A custom service endpoint, as a hostname or hostname:port. The default is
643
+ # nil, indicating to use the default endpoint in the current universe domain.
644
+ # @return [::String,nil]
543
645
  # @!attribute [rw] credentials
544
646
  # Credentials to send with calls. You may provide any of the following types:
545
647
  # * (`String`) The path to a service account key file in JSON format
@@ -576,13 +678,20 @@ module Google
576
678
  # @!attribute [rw] quota_project
577
679
  # A separate project against which to charge quota.
578
680
  # @return [::String]
681
+ # @!attribute [rw] universe_domain
682
+ # The universe domain within which to make requests. This determines the
683
+ # default endpoint URL. The default value of nil uses the environment
684
+ # universe (usually the default "googleapis.com" universe).
685
+ # @return [::String,nil]
579
686
  #
580
687
  class Configuration
581
688
  extend ::Gapic::Config
582
689
 
690
+ # @private
691
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
583
692
  DEFAULT_ENDPOINT = "monitoring.googleapis.com"
584
693
 
585
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
694
+ config_attr :endpoint, nil, ::String, nil
586
695
  config_attr :credentials, nil do |value|
587
696
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
588
697
  allowed.any? { |klass| klass === value }
@@ -594,6 +703,7 @@ module Google
594
703
  config_attr :metadata, nil, ::Hash, nil
595
704
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
596
705
  config_attr :quota_project, nil, ::String, nil
706
+ config_attr :universe_domain, nil, ::String, nil
597
707
 
598
708
  # @private
599
709
  def initialize parent_config = nil
data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service/rest/service_stub.rb CHANGED
@@ -31,16 +31,28 @@ module Google
31
31
  # including transcoding, making the REST call, and deserialing the response.
32
32
  #
33
33
  class ServiceStub
34
- def initialize endpoint:, credentials:
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
35
35
  # These require statements are intentionally placed here to initialize
36
36
  # the REST modules only when it's required.
37
37
  require "gapic/rest"
38
38
 
39
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
39
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
40
+ endpoint_template: endpoint_template,
41
+ universe_domain: universe_domain,
42
+ credentials: credentials,
40
43
  numeric_enums: true,
41
44
  raise_faraday_errors: false
42
45
  end
43
46
 
47
+ ##
48
+ # The effective universe domain
49
+ #
50
+ # @return [String]
51
+ #
52
+ def universe_domain
53
+ @client_stub.universe_domain
54
+ end
55
+
44
56
  ##
45
57
  # Baseline implementation for the create_dashboard REST call
46
58
  #
data/lib/google/cloud/monitoring/dashboard/v1/version.rb CHANGED
@@ -22,7 +22,7 @@ module Google
22
22
  module Monitoring
23
23
  module Dashboard
24
24
  module V1
25
- VERSION = "0.12.1"
25
+ VERSION = "0.14.0"
26
26
  end
27
27
  end
28
28
  end
data/proto_docs/google/api/client.rb CHANGED
@@ -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
data/proto_docs/google/api/field_behavior.rb CHANGED
@@ -66,6 +66,20 @@ module Google
66
66
  # a non-empty value will be returned. The user will not be aware of what
67
67
  # non-empty value to expect.
68
68
  NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
69
83
  end
70
84
  end
71
85
  end
data/proto_docs/google/monitoring/dashboard/v1/metrics.rb CHANGED
@@ -69,6 +69,7 @@ module Google
69
69
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::PickTimeSeriesFilter]
70
70
  # Ranking based time series filter.
71
71
  # @!attribute [rw] statistical_time_series_filter
72
+ # @deprecated This field is deprecated and may be removed in the next major version update.
72
73
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::StatisticalTimeSeriesFilter]
73
74
  # Statistics based time series filter.
74
75
  # Note: This field is deprecated and completely ignored by the API.
@@ -93,6 +94,7 @@ module Google
93
94
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::PickTimeSeriesFilter]
94
95
  # Ranking based time series filter.
95
96
  # @!attribute [rw] statistical_time_series_filter
97
+ # @deprecated This field is deprecated and may be removed in the next major version update.
96
98
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::StatisticalTimeSeriesFilter]
97
99
  # Statistics based time series filter.
98
100
  # Note: This field is deprecated and completely ignored by the API.
data/proto_docs/google/monitoring/dashboard/v1/table_display_options.rb CHANGED
@@ -24,6 +24,7 @@ module Google
24
24
  module V1
25
25
  # Table display options that can be reused.
26
26
  # @!attribute [rw] shown_columns
27
+ # @deprecated This field is deprecated and may be removed in the next major version update.
27
28
  # @return [::Array<::String>]
28
29
  # Optional. This field is unused and has been replaced by
29
30
  # TimeSeriesTable.column_settings
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-monitoring-dashboard-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.12.1
4
+ version: 0.14.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: 2023-06-06 00:00:00.000000000 Z
11
+ date: 2024-01-11 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.19.1
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.19.1
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -240,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
240
240
  - !ruby/object:Gem::Version
241
241
  version: '0'
242
242
  requirements: []
243
- rubygems_version: 3.4.2
243
+ rubygems_version: 3.5.3
244
244
  signing_key:
245
245
  specification_version: 4
246
246
  summary: Manages your Cloud Monitoring data and configurations.