google-cloud-monitoring-v3 0.7.1 → 0.8.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: 9118910b6876838ce61d06e0f12b91062daeba4194646f59272c98d7cfcd780c
4
- data.tar.gz: b7085b7f4af99e5c86a8266fabc523e5411462a2978afc08e22c16e2605bfde6
3
+ metadata.gz: cc642d3d7315e0a382336093e3f69bb4407c29d9f6808769275bb821c80f755b
4
+ data.tar.gz: cba250876fd1086ff6fb2d28fba1e60d20822c3aed42ec8060cf5797863dd32d
5
5
  SHA512:
6
- metadata.gz: 011ab25cc96ec2e7f7e008cdabc0badb5ee70c737457b268daf262a20141522280073c8e5eb72df62242b0453bc7a532294ab6770c97c55fc29af3460caf4f13
7
- data.tar.gz: 0eeca157c6c8b942179ed064788dfcfcd32c22ee11b76e76f6aea6b35f94a98a1f7b1870d922d8a59fd145ad60a5e3e2a7cd65f0564648525030200af408a606
6
+ metadata.gz: 8b72c1012cd1f700cefef00f1442a30998abdc827812bfac8c39451416f83187cfc1d8a1e60deb11adb1e8c85948e07e4a93bc47275cf9c5f108d096594b36d9
7
+ data.tar.gz: 1754dd7ebb46e41496b92564dde07cbd383a7d4b81a43071e45ba18f9416146350ea3a202f84152d29178b14380e6810ea95b2b84a5462f825d1be67a3cea865
data/README.md CHANGED
@@ -37,7 +37,7 @@ request = ::Google::Cloud::Monitoring::V3::ListAlertPoliciesRequest.new # (reque
37
37
  response = client.list_alert_policies request
38
38
  ```
39
39
 
40
- View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-monitoring-v3/latest)
40
+ View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest)
41
41
  for class and method documentation.
42
42
 
43
43
  See also the [Product Documentation](https://cloud.google.com/monitoring)
@@ -69,16 +69,21 @@ module GRPC
69
69
  end
70
70
  ```
71
71
 
72
+
73
+ ## Google Cloud Samples
74
+
75
+ To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
76
+
72
77
  ## Supported Ruby Versions
73
78
 
74
- This library is supported on Ruby 2.5+.
79
+ This library is supported on Ruby 2.6+.
75
80
 
76
81
  Google provides official support for Ruby versions that are actively supported
77
82
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
78
- in security maintenance, and not end of life. Currently, this means Ruby 2.5
79
- and later. Older versions of Ruby _may_ still work, but are unsupported and not
80
- recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
81
- about the Ruby support schedule.
83
+ in security maintenance, and not end of life. Older versions of Ruby _may_
84
+ still work, but are unsupported and not recommended. See
85
+ https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
86
+ support schedule.
82
87
 
83
88
  ## Which client should I use?
84
89
 
@@ -195,8 +195,9 @@ module Google
195
195
  # the default parameter values, pass an empty Hash as a request object (see above).
196
196
  #
197
197
  # @param parent [::String]
198
- # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name)
199
- # whose Uptime check configurations are listed. The format is:
198
+ # Required. The
199
+ # [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
200
+ # Uptime check configurations are listed. The format is:
200
201
  #
201
202
  # projects/[PROJECT_ID_OR_NUMBER]
202
203
  # @param page_size [::Integer]
@@ -386,8 +387,9 @@ module Google
386
387
  # the default parameter values, pass an empty Hash as a request object (see above).
387
388
  #
388
389
  # @param parent [::String]
389
- # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in
390
- # which to create the Uptime check. The format is:
390
+ # Required. The
391
+ # [project](https://cloud.google.com/monitoring/api/v3#project_name) in which
392
+ # to create the Uptime check. The format is:
391
393
  #
392
394
  # projects/[PROJECT_ID_OR_NUMBER]
393
395
  # @param uptime_check_config [::Google::Cloud::Monitoring::V3::UptimeCheckConfig, ::Hash]
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Monitoring
23
23
  module V3
24
- VERSION = "0.7.1"
24
+ VERSION = "0.8.0"
25
25
  end
26
26
  end
27
27
  end
@@ -31,6 +31,8 @@ module Google
31
31
  ##
32
32
  # To load this package, including all its services, and instantiate a client:
33
33
  #
34
+ # @example
35
+ #
34
36
  # require "google/cloud/monitoring/v3"
35
37
  # client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new
36
38
  #
@@ -1,6 +1,8 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/alert.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/api/field_behavior_pb'
5
7
  require 'google/api/resource_pb'
6
8
  require 'google/monitoring/v3/common_pb'
@@ -8,7 +10,6 @@ require 'google/monitoring/v3/mutation_record_pb'
8
10
  require 'google/protobuf/duration_pb'
9
11
  require 'google/protobuf/wrappers_pb'
10
12
  require 'google/rpc/status_pb'
11
- require 'google/protobuf'
12
13
 
13
14
  Google::Protobuf::DescriptorPool.generated_pool.build do
14
15
  add_file("google/monitoring/v3/alert.proto", :syntax => :proto3) do
@@ -1,6 +1,8 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/alert_service.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/api/annotations_pb'
5
7
  require 'google/api/client_pb'
6
8
  require 'google/api/field_behavior_pb'
@@ -8,7 +10,6 @@ require 'google/api/resource_pb'
8
10
  require 'google/monitoring/v3/alert_pb'
9
11
  require 'google/protobuf/empty_pb'
10
12
  require 'google/protobuf/field_mask_pb'
11
- require 'google/protobuf'
12
13
 
13
14
  Google::Protobuf::DescriptorPool.generated_pool.build do
14
15
  add_file("google/monitoring/v3/alert_service.proto", :syntax => :proto3) do
@@ -1,10 +1,11 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/common.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/api/distribution_pb'
5
7
  require 'google/protobuf/duration_pb'
6
8
  require 'google/protobuf/timestamp_pb'
7
- require 'google/protobuf'
8
9
 
9
10
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
11
  add_file("google/monitoring/v3/common.proto", :syntax => :proto3) do
@@ -1,9 +1,10 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/group.proto
3
3
 
4
- require 'google/api/resource_pb'
5
4
  require 'google/protobuf'
6
5
 
6
+ require 'google/api/resource_pb'
7
+
7
8
  Google::Protobuf::DescriptorPool.generated_pool.build do
8
9
  add_file("google/monitoring/v3/group.proto", :syntax => :proto3) do
9
10
  add_message "google.monitoring.v3.Group" do
@@ -1,6 +1,8 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/group_service.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/api/annotations_pb'
5
7
  require 'google/api/client_pb'
6
8
  require 'google/api/field_behavior_pb'
@@ -9,7 +11,6 @@ require 'google/api/resource_pb'
9
11
  require 'google/monitoring/v3/common_pb'
10
12
  require 'google/monitoring/v3/group_pb'
11
13
  require 'google/protobuf/empty_pb'
12
- require 'google/protobuf'
13
14
 
14
15
  Google::Protobuf::DescriptorPool.generated_pool.build do
15
16
  add_file("google/monitoring/v3/group_service.proto", :syntax => :proto3) do
@@ -1,13 +1,12 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/metric.proto
3
3
 
4
- require 'google/api/distribution_pb'
4
+ require 'google/protobuf'
5
+
5
6
  require 'google/api/label_pb'
6
7
  require 'google/api/metric_pb'
7
8
  require 'google/api/monitored_resource_pb'
8
9
  require 'google/monitoring/v3/common_pb'
9
- require 'google/protobuf/duration_pb'
10
- require 'google/protobuf'
11
10
 
12
11
  Google::Protobuf::DescriptorPool.generated_pool.build do
13
12
  add_file("google/monitoring/v3/metric.proto", :syntax => :proto3) do
@@ -1,19 +1,18 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/metric_service.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/api/annotations_pb'
5
7
  require 'google/api/client_pb'
6
8
  require 'google/api/field_behavior_pb'
7
9
  require 'google/api/metric_pb'
8
10
  require 'google/api/monitored_resource_pb'
9
11
  require 'google/api/resource_pb'
10
- require 'google/monitoring/v3/alert_pb'
11
12
  require 'google/monitoring/v3/common_pb'
12
13
  require 'google/monitoring/v3/metric_pb'
13
- require 'google/protobuf/duration_pb'
14
14
  require 'google/protobuf/empty_pb'
15
15
  require 'google/rpc/status_pb'
16
- require 'google/protobuf'
17
16
 
18
17
  Google::Protobuf::DescriptorPool.generated_pool.build do
19
18
  add_file("google/monitoring/v3/metric_service.proto", :syntax => :proto3) do
@@ -1,9 +1,10 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/mutation_record.proto
3
3
 
4
- require 'google/protobuf/timestamp_pb'
5
4
  require 'google/protobuf'
6
5
 
6
+ require 'google/protobuf/timestamp_pb'
7
+
7
8
  Google::Protobuf::DescriptorPool.generated_pool.build do
8
9
  add_file("google/monitoring/v3/mutation_record.proto", :syntax => :proto3) do
9
10
  add_message "google.monitoring.v3.MutationRecord" do
@@ -1,13 +1,14 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/notification.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/api/label_pb'
5
7
  require 'google/api/launch_stage_pb'
6
8
  require 'google/api/resource_pb'
7
9
  require 'google/monitoring/v3/common_pb'
8
10
  require 'google/monitoring/v3/mutation_record_pb'
9
11
  require 'google/protobuf/wrappers_pb'
10
- require 'google/protobuf'
11
12
 
12
13
  Google::Protobuf::DescriptorPool.generated_pool.build do
13
14
  add_file("google/monitoring/v3/notification.proto", :syntax => :proto3) do
@@ -1,6 +1,8 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/notification_service.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/api/annotations_pb'
5
7
  require 'google/api/client_pb'
6
8
  require 'google/api/field_behavior_pb'
@@ -8,9 +10,7 @@ require 'google/api/resource_pb'
8
10
  require 'google/monitoring/v3/notification_pb'
9
11
  require 'google/protobuf/empty_pb'
10
12
  require 'google/protobuf/field_mask_pb'
11
- require 'google/protobuf/struct_pb'
12
13
  require 'google/protobuf/timestamp_pb'
13
- require 'google/protobuf'
14
14
 
15
15
  Google::Protobuf::DescriptorPool.generated_pool.build do
16
16
  add_file("google/monitoring/v3/notification_service.proto", :syntax => :proto3) do
@@ -1,12 +1,11 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/query_service.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/api/annotations_pb'
5
- require 'google/api/label_pb'
6
- require 'google/monitoring/v3/metric_pb'
7
7
  require 'google/monitoring/v3/metric_service_pb'
8
8
  require 'google/api/client_pb'
9
- require 'google/protobuf'
10
9
 
11
10
  Google::Protobuf::DescriptorPool.generated_pool.build do
12
11
  add_file("google/monitoring/v3/query_service.proto", :syntax => :proto3) do
@@ -1,12 +1,11 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/service.proto
3
3
 
4
- require 'google/api/field_behavior_pb'
4
+ require 'google/protobuf'
5
+
5
6
  require 'google/api/resource_pb'
6
7
  require 'google/protobuf/duration_pb'
7
- require 'google/protobuf/timestamp_pb'
8
8
  require 'google/type/calendar_period_pb'
9
- require 'google/protobuf'
10
9
 
11
10
  Google::Protobuf::DescriptorPool.generated_pool.build do
12
11
  add_file("google/monitoring/v3/service.proto", :syntax => :proto3) do
@@ -1,6 +1,8 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/service_service.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/api/annotations_pb'
5
7
  require 'google/api/client_pb'
6
8
  require 'google/api/field_behavior_pb'
@@ -8,7 +10,6 @@ require 'google/api/resource_pb'
8
10
  require 'google/monitoring/v3/service_pb'
9
11
  require 'google/protobuf/empty_pb'
10
12
  require 'google/protobuf/field_mask_pb'
11
- require 'google/protobuf'
12
13
 
13
14
  Google::Protobuf::DescriptorPool.generated_pool.build do
14
15
  add_file("google/monitoring/v3/service_service.proto", :syntax => :proto3) do
@@ -1,10 +1,11 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/uptime.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/api/monitored_resource_pb'
5
7
  require 'google/api/resource_pb'
6
8
  require 'google/protobuf/duration_pb'
7
- require 'google/protobuf'
8
9
 
9
10
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
11
  add_file("google/monitoring/v3/uptime.proto", :syntax => :proto3) do
@@ -1,16 +1,15 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/uptime_service.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/api/annotations_pb'
5
7
  require 'google/api/client_pb'
6
8
  require 'google/api/field_behavior_pb'
7
9
  require 'google/api/resource_pb'
8
- require 'google/longrunning/operations_pb'
9
10
  require 'google/monitoring/v3/uptime_pb'
10
- require 'google/protobuf/duration_pb'
11
11
  require 'google/protobuf/empty_pb'
12
12
  require 'google/protobuf/field_mask_pb'
13
- require 'google/protobuf'
14
13
 
15
14
  Google::Protobuf::DescriptorPool.generated_pool.build do
16
15
  add_file("google/monitoring/v3/uptime_service.proto", :syntax => :proto3) do
@@ -24,8 +24,9 @@ module Google
24
24
  # The protocol for the `ListUptimeCheckConfigs` request.
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
- # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name)
28
- # whose Uptime check configurations are listed. The format is:
27
+ # Required. The
28
+ # [project](https://cloud.google.com/monitoring/api/v3#project_name) whose
29
+ # Uptime check configurations are listed. The format is:
29
30
  #
30
31
  # projects/[PROJECT_ID_OR_NUMBER]
31
32
  # @!attribute [rw] page_size
@@ -78,8 +79,9 @@ module Google
78
79
  # The protocol for the `CreateUptimeCheckConfig` request.
79
80
  # @!attribute [rw] parent
80
81
  # @return [::String]
81
- # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in
82
- # which to create the Uptime check. The format is:
82
+ # Required. The
83
+ # [project](https://cloud.google.com/monitoring/api/v3#project_name) in which
84
+ # to create the Uptime check. The format is:
83
85
  #
84
86
  # projects/[PROJECT_ID_OR_NUMBER]
85
87
  # @!attribute [rw] uptime_check_config
@@ -44,7 +44,7 @@ module Google
44
44
  # foo = any.unpack(Foo.class);
45
45
  # }
46
46
  #
47
- # Example 3: Pack and unpack a message in Python.
47
+ # Example 3: Pack and unpack a message in Python.
48
48
  #
49
49
  # foo = Foo(...)
50
50
  # any = Any()
@@ -54,7 +54,7 @@ module Google
54
54
  # any.Unpack(foo)
55
55
  # ...
56
56
  #
57
- # Example 4: Pack and unpack a message in Go
57
+ # Example 4: Pack and unpack a message in Go
58
58
  #
59
59
  # foo := &pb.Foo{...}
60
60
  # any, err := anypb.New(foo)
@@ -75,7 +75,7 @@ module Google
75
75
  #
76
76
  #
77
77
  # JSON
78
- # ====
78
+ #
79
79
  # The JSON representation of an `Any` value uses the regular
80
80
  # representation of the deserialized, embedded message, with an
81
81
  # additional field `@type` which contains the type URL. Example:
@@ -46,8 +46,8 @@ module Google
46
46
 
47
47
  # `Value` represents a dynamically typed value which can be either
48
48
  # null, a number, a string, a boolean, a recursive struct value, or a
49
- # list of values. A producer of value is expected to set one of that
50
- # variants, absence of any variant indicates an error.
49
+ # list of values. A producer of value is expected to set one of these
50
+ # variants. Absence of any variant indicates an error.
51
51
  #
52
52
  # The JSON representation for `Value` is JSON value.
53
53
  # @!attribute [rw] null_value
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-monitoring-v3
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.7.1
4
+ version: 0.8.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: 2022-01-11 00:00:00.000000000 Z
11
+ date: 2022-07-05 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.7'
19
+ version: '0.10'
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.7'
29
+ version: '0.10'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -50,28 +50,28 @@ dependencies:
50
50
  requirements:
51
51
  - - "~>"
52
52
  - !ruby/object:Gem::Version
53
- version: 1.25.1
53
+ version: 1.26.1
54
54
  type: :development
55
55
  prerelease: false
56
56
  version_requirements: !ruby/object:Gem::Requirement
57
57
  requirements:
58
58
  - - "~>"
59
59
  - !ruby/object:Gem::Version
60
- version: 1.25.1
60
+ version: 1.26.1
61
61
  - !ruby/object:Gem::Dependency
62
62
  name: minitest
63
63
  requirement: !ruby/object:Gem::Requirement
64
64
  requirements:
65
65
  - - "~>"
66
66
  - !ruby/object:Gem::Version
67
- version: '5.14'
67
+ version: '5.16'
68
68
  type: :development
69
69
  prerelease: false
70
70
  version_requirements: !ruby/object:Gem::Requirement
71
71
  requirements:
72
72
  - - "~>"
73
73
  - !ruby/object:Gem::Version
74
- version: '5.14'
74
+ version: '5.16'
75
75
  - !ruby/object:Gem::Dependency
76
76
  name: minitest-focus
77
77
  requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
106
106
  requirements:
107
107
  - - ">="
108
108
  - !ruby/object:Gem::Version
109
- version: '12.0'
109
+ version: '13.0'
110
110
  type: :development
111
111
  prerelease: false
112
112
  version_requirements: !ruby/object:Gem::Requirement
113
113
  requirements:
114
114
  - - ">="
115
115
  - !ruby/object:Gem::Version
116
- version: '12.0'
116
+ version: '13.0'
117
117
  - !ruby/object:Gem::Dependency
118
118
  name: redcarpet
119
119
  requirement: !ruby/object:Gem::Requirement
@@ -232,7 +232,6 @@ files:
232
232
  - proto_docs/google/api/metric.rb
233
233
  - proto_docs/google/api/monitored_resource.rb
234
234
  - proto_docs/google/api/resource.rb
235
- - proto_docs/google/longrunning/operations.rb
236
235
  - proto_docs/google/monitoring/v3/alert.rb
237
236
  - proto_docs/google/monitoring/v3/alert_service.rb
238
237
  - proto_docs/google/monitoring/v3/common.rb
@@ -270,14 +269,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
270
269
  requirements:
271
270
  - - ">="
272
271
  - !ruby/object:Gem::Version
273
- version: '2.5'
272
+ version: '2.6'
274
273
  required_rubygems_version: !ruby/object:Gem::Requirement
275
274
  requirements:
276
275
  - - ">="
277
276
  - !ruby/object:Gem::Version
278
277
  version: '0'
279
278
  requirements: []
280
- rubygems_version: 3.3.4
279
+ rubygems_version: 3.3.14
281
280
  signing_key:
282
281
  specification_version: 4
283
282
  summary: API Client library for the Cloud Monitoring V3 API
@@ -1,164 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # Copyright 2021 Google LLC
4
- #
5
- # Licensed under the Apache License, Version 2.0 (the "License");
6
- # you may not use this file except in compliance with the License.
7
- # You may obtain a copy of the License at
8
- #
9
- # https://www.apache.org/licenses/LICENSE-2.0
10
- #
11
- # Unless required by applicable law or agreed to in writing, software
12
- # distributed under the License is distributed on an "AS IS" BASIS,
13
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- # See the License for the specific language governing permissions and
15
- # limitations under the License.
16
-
17
- # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
-
19
-
20
- module Google
21
- module Longrunning
22
- # This resource represents a long-running operation that is the result of a
23
- # network API call.
24
- # @!attribute [rw] name
25
- # @return [::String]
26
- # The server-assigned name, which is only unique within the same service that
27
- # originally returns it. If you use the default HTTP mapping, the
28
- # `name` should be a resource name ending with `operations/{unique_id}`.
29
- # @!attribute [rw] metadata
30
- # @return [::Google::Protobuf::Any]
31
- # Service-specific metadata associated with the operation. It typically
32
- # contains progress information and common metadata such as create time.
33
- # Some services might not provide such metadata. Any method that returns a
34
- # long-running operation should document the metadata type, if any.
35
- # @!attribute [rw] done
36
- # @return [::Boolean]
37
- # If the value is `false`, it means the operation is still in progress.
38
- # If `true`, the operation is completed, and either `error` or `response` is
39
- # available.
40
- # @!attribute [rw] error
41
- # @return [::Google::Rpc::Status]
42
- # The error result of the operation in case of failure or cancellation.
43
- # @!attribute [rw] response
44
- # @return [::Google::Protobuf::Any]
45
- # The normal response of the operation in case of success. If the original
46
- # method returns no data on success, such as `Delete`, the response is
47
- # `google.protobuf.Empty`. If the original method is standard
48
- # `Get`/`Create`/`Update`, the response should be the resource. For other
49
- # methods, the response should have the type `XxxResponse`, where `Xxx`
50
- # is the original method name. For example, if the original method name
51
- # is `TakeSnapshot()`, the inferred response type is
52
- # `TakeSnapshotResponse`.
53
- class Operation
54
- include ::Google::Protobuf::MessageExts
55
- extend ::Google::Protobuf::MessageExts::ClassMethods
56
- end
57
-
58
- # The request message for Operations.GetOperation.
59
- # @!attribute [rw] name
60
- # @return [::String]
61
- # The name of the operation resource.
62
- class GetOperationRequest
63
- include ::Google::Protobuf::MessageExts
64
- extend ::Google::Protobuf::MessageExts::ClassMethods
65
- end
66
-
67
- # The request message for Operations.ListOperations.
68
- # @!attribute [rw] name
69
- # @return [::String]
70
- # The name of the operation's parent resource.
71
- # @!attribute [rw] filter
72
- # @return [::String]
73
- # The standard list filter.
74
- # @!attribute [rw] page_size
75
- # @return [::Integer]
76
- # The standard list page size.
77
- # @!attribute [rw] page_token
78
- # @return [::String]
79
- # The standard list page token.
80
- class ListOperationsRequest
81
- include ::Google::Protobuf::MessageExts
82
- extend ::Google::Protobuf::MessageExts::ClassMethods
83
- end
84
-
85
- # The response message for Operations.ListOperations.
86
- # @!attribute [rw] operations
87
- # @return [::Array<::Google::Longrunning::Operation>]
88
- # A list of operations that matches the specified filter in the request.
89
- # @!attribute [rw] next_page_token
90
- # @return [::String]
91
- # The standard List next-page token.
92
- class ListOperationsResponse
93
- include ::Google::Protobuf::MessageExts
94
- extend ::Google::Protobuf::MessageExts::ClassMethods
95
- end
96
-
97
- # The request message for Operations.CancelOperation.
98
- # @!attribute [rw] name
99
- # @return [::String]
100
- # The name of the operation resource to be cancelled.
101
- class CancelOperationRequest
102
- include ::Google::Protobuf::MessageExts
103
- extend ::Google::Protobuf::MessageExts::ClassMethods
104
- end
105
-
106
- # The request message for Operations.DeleteOperation.
107
- # @!attribute [rw] name
108
- # @return [::String]
109
- # The name of the operation resource to be deleted.
110
- class DeleteOperationRequest
111
- include ::Google::Protobuf::MessageExts
112
- extend ::Google::Protobuf::MessageExts::ClassMethods
113
- end
114
-
115
- # The request message for Operations.WaitOperation.
116
- # @!attribute [rw] name
117
- # @return [::String]
118
- # The name of the operation resource to wait on.
119
- # @!attribute [rw] timeout
120
- # @return [::Google::Protobuf::Duration]
121
- # The maximum duration to wait before timing out. If left blank, the wait
122
- # will be at most the time permitted by the underlying HTTP/RPC protocol.
123
- # If RPC context deadline is also specified, the shorter one will be used.
124
- class WaitOperationRequest
125
- include ::Google::Protobuf::MessageExts
126
- extend ::Google::Protobuf::MessageExts::ClassMethods
127
- end
128
-
129
- # A message representing the message types used by a long-running operation.
130
- #
131
- # Example:
132
- #
133
- # rpc LongRunningRecognize(LongRunningRecognizeRequest)
134
- # returns (google.longrunning.Operation) {
135
- # option (google.longrunning.operation_info) = {
136
- # response_type: "LongRunningRecognizeResponse"
137
- # metadata_type: "LongRunningRecognizeMetadata"
138
- # };
139
- # }
140
- # @!attribute [rw] response_type
141
- # @return [::String]
142
- # Required. The message name of the primary return type for this
143
- # long-running operation.
144
- # This type will be used to deserialize the LRO's response.
145
- #
146
- # If the response is in a different package from the rpc, a fully-qualified
147
- # message name must be used (e.g. `google.protobuf.Struct`).
148
- #
149
- # Note: Altering this value constitutes a breaking change.
150
- # @!attribute [rw] metadata_type
151
- # @return [::String]
152
- # Required. The message name of the metadata type for this long-running
153
- # operation.
154
- #
155
- # If the response is in a different package from the rpc, a fully-qualified
156
- # message name must be used (e.g. `google.protobuf.Struct`).
157
- #
158
- # Note: Altering this value constitutes a breaking change.
159
- class OperationInfo
160
- include ::Google::Protobuf::MessageExts
161
- extend ::Google::Protobuf::MessageExts::ClassMethods
162
- end
163
- end
164
- end