google-cloud-recommender-v1 0.3.2 → 0.3.3
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 +4 -4
- data/AUTHENTICATION.md +6 -6
- data/README.md +1 -1
- data/lib/google/cloud/recommender/v1.rb +1 -1
- data/lib/google/cloud/recommender/v1/recommender.rb +1 -1
- data/lib/google/cloud/recommender/v1/recommender/client.rb +126 -126
- data/lib/google/cloud/recommender/v1/recommender/credentials.rb +1 -1
- data/lib/google/cloud/recommender/v1/recommender/paths.rb +7 -7
- data/lib/google/cloud/recommender/v1/version.rb +1 -1
- data/proto_docs/google/api/resource.rb +12 -12
- data/proto_docs/google/cloud/recommender/v1/recommendation.rb +56 -56
- data/proto_docs/google/cloud/recommender/v1/recommender_service.rb +40 -40
- data/proto_docs/google/protobuf/duration.rb +4 -4
- data/proto_docs/google/protobuf/struct.rb +18 -18
- data/proto_docs/google/protobuf/timestamp.rb +4 -4
- data/proto_docs/google/type/money.rb +5 -5
- metadata +2 -2
@@ -24,7 +24,7 @@ module Google
|
|
24
24
|
module V1
|
25
25
|
module Recommender
|
26
26
|
# Credentials for the Recommender API.
|
27
|
-
class Credentials < Google::Auth::Credentials
|
27
|
+
class Credentials < ::Google::Auth::Credentials
|
28
28
|
self.scope = [
|
29
29
|
"https://www.googleapis.com/auth/cloud-platform"
|
30
30
|
]
|
@@ -36,11 +36,11 @@ module Google
|
|
36
36
|
# @param recommender [String]
|
37
37
|
# @param recommendation [String]
|
38
38
|
#
|
39
|
-
# @return [String]
|
39
|
+
# @return [::String]
|
40
40
|
def recommendation_path project:, location:, recommender:, recommendation:
|
41
|
-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
42
|
-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
43
|
-
raise ArgumentError, "recommender cannot contain /" if recommender.to_s.include? "/"
|
41
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
42
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
43
|
+
raise ::ArgumentError, "recommender cannot contain /" if recommender.to_s.include? "/"
|
44
44
|
|
45
45
|
"projects/#{project}/locations/#{location}/recommenders/#{recommender}/recommendations/#{recommendation}"
|
46
46
|
end
|
@@ -56,10 +56,10 @@ module Google
|
|
56
56
|
# @param location [String]
|
57
57
|
# @param recommender [String]
|
58
58
|
#
|
59
|
-
# @return [String]
|
59
|
+
# @return [::String]
|
60
60
|
def recommender_path project:, location:, recommender:
|
61
|
-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
62
|
-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
61
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
62
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
63
63
|
|
64
64
|
"projects/#{project}/locations/#{location}/recommenders/#{recommender}"
|
65
65
|
end
|
@@ -128,7 +128,7 @@ module Google
|
|
128
128
|
# - pattern: "shelves/{shelf}"
|
129
129
|
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
130
130
|
# @!attribute [rw] type
|
131
|
-
# @return [String]
|
131
|
+
# @return [::String]
|
132
132
|
# The resource type. It must be in the format of
|
133
133
|
# \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
|
134
134
|
# singular and must not include version numbers.
|
@@ -140,7 +140,7 @@ module Google
|
|
140
140
|
# should use PascalCase (UpperCamelCase). The maximum number of
|
141
141
|
# characters allowed for the `resource_type_kind` is 100.
|
142
142
|
# @!attribute [rw] pattern
|
143
|
-
# @return [Array
|
143
|
+
# @return [::Array<::String>]
|
144
144
|
# Optional. The relative resource name pattern associated with this resource
|
145
145
|
# type. The DNS prefix of the full resource name shouldn't be specified here.
|
146
146
|
#
|
@@ -161,11 +161,11 @@ module Google
|
|
161
161
|
# the same component name (e.g. "project") refers to IDs of the same
|
162
162
|
# type of resource.
|
163
163
|
# @!attribute [rw] name_field
|
164
|
-
# @return [String]
|
164
|
+
# @return [::String]
|
165
165
|
# Optional. The field on the resource that designates the resource name
|
166
166
|
# field. If omitted, this is assumed to be "name".
|
167
167
|
# @!attribute [rw] history
|
168
|
-
# @return [Google::Api::ResourceDescriptor::History]
|
168
|
+
# @return [::Google::Api::ResourceDescriptor::History]
|
169
169
|
# Optional. The historical or future-looking state of the resource pattern.
|
170
170
|
#
|
171
171
|
# Example:
|
@@ -182,19 +182,19 @@ module Google
|
|
182
182
|
# };
|
183
183
|
# }
|
184
184
|
# @!attribute [rw] plural
|
185
|
-
# @return [String]
|
185
|
+
# @return [::String]
|
186
186
|
# The plural name used in the resource name, such as 'projects' for
|
187
187
|
# the name of 'projects/\\{project}'. It is the same concept of the `plural`
|
188
188
|
# field in k8s CRD spec
|
189
189
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
190
190
|
# @!attribute [rw] singular
|
191
|
-
# @return [String]
|
191
|
+
# @return [::String]
|
192
192
|
# The same concept of the `singular` field in k8s CRD spec
|
193
193
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
194
194
|
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
195
195
|
class ResourceDescriptor
|
196
|
-
include Google::Protobuf::MessageExts
|
197
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
196
|
+
include ::Google::Protobuf::MessageExts
|
197
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
198
198
|
|
199
199
|
# A description of the historical or future-looking state of the
|
200
200
|
# resource pattern.
|
@@ -216,7 +216,7 @@ module Google
|
|
216
216
|
# Defines a proto annotation that describes a string field that refers to
|
217
217
|
# an API resource.
|
218
218
|
# @!attribute [rw] type
|
219
|
-
# @return [String]
|
219
|
+
# @return [::String]
|
220
220
|
# The resource type that the annotated field references.
|
221
221
|
#
|
222
222
|
# Example:
|
@@ -227,7 +227,7 @@ module Google
|
|
227
227
|
# }];
|
228
228
|
# }
|
229
229
|
# @!attribute [rw] child_type
|
230
|
-
# @return [String]
|
230
|
+
# @return [::String]
|
231
231
|
# The resource type of a child collection that the annotated field
|
232
232
|
# references. This is useful for annotating the `parent` field that
|
233
233
|
# doesn't have a fixed resource type.
|
@@ -240,8 +240,8 @@ module Google
|
|
240
240
|
# };
|
241
241
|
# }
|
242
242
|
class ResourceReference
|
243
|
-
include Google::Protobuf::MessageExts
|
244
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
243
|
+
include ::Google::Protobuf::MessageExts
|
244
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
245
245
|
end
|
246
246
|
end
|
247
247
|
end
|
@@ -24,14 +24,14 @@ module Google
|
|
24
24
|
# A recommendation along with a suggested action. E.g., a rightsizing
|
25
25
|
# recommendation for an underutilized VM, IAM role recommendations, etc
|
26
26
|
# @!attribute [rw] name
|
27
|
-
# @return [String]
|
27
|
+
# @return [::String]
|
28
28
|
# Name of recommendation.
|
29
29
|
# @!attribute [rw] description
|
30
|
-
# @return [String]
|
30
|
+
# @return [::String]
|
31
31
|
# Free-form human readable summary in English. The maximum length is 500
|
32
32
|
# characters.
|
33
33
|
# @!attribute [rw] recommender_subtype
|
34
|
-
# @return [String]
|
34
|
+
# @return [::String]
|
35
35
|
# Contains an identifier for a subtype of recommendations produced for the
|
36
36
|
# same recommender. Subtype is a function of content and impact, meaning a
|
37
37
|
# new subtype might be added when significant changes to `content` or
|
@@ -42,52 +42,52 @@ module Google
|
|
42
42
|
# For recommender = "google.iam.policy.Recommender",
|
43
43
|
# recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE"
|
44
44
|
# @!attribute [rw] last_refresh_time
|
45
|
-
# @return [Google::Protobuf::Timestamp]
|
45
|
+
# @return [::Google::Protobuf::Timestamp]
|
46
46
|
# Last time this recommendation was refreshed by the system that created it
|
47
47
|
# in the first place.
|
48
48
|
# @!attribute [rw] primary_impact
|
49
|
-
# @return [Google::Cloud::Recommender::V1::Impact]
|
49
|
+
# @return [::Google::Cloud::Recommender::V1::Impact]
|
50
50
|
# The primary impact that this recommendation can have while trying to
|
51
51
|
# optimize for one category.
|
52
52
|
# @!attribute [rw] additional_impact
|
53
|
-
# @return [Array
|
53
|
+
# @return [::Array<::Google::Cloud::Recommender::V1::Impact>]
|
54
54
|
# Optional set of additional impact that this recommendation may have when
|
55
55
|
# trying to optimize for the primary category. These may be positive
|
56
56
|
# or negative.
|
57
57
|
# @!attribute [rw] content
|
58
|
-
# @return [Google::Cloud::Recommender::V1::RecommendationContent]
|
58
|
+
# @return [::Google::Cloud::Recommender::V1::RecommendationContent]
|
59
59
|
# Content of the recommendation describing recommended changes to resources.
|
60
60
|
# @!attribute [rw] state_info
|
61
|
-
# @return [Google::Cloud::Recommender::V1::RecommendationStateInfo]
|
61
|
+
# @return [::Google::Cloud::Recommender::V1::RecommendationStateInfo]
|
62
62
|
# Information for state. Contains state and metadata.
|
63
63
|
# @!attribute [rw] etag
|
64
|
-
# @return [String]
|
64
|
+
# @return [::String]
|
65
65
|
# Fingerprint of the Recommendation. Provides optimistic locking when
|
66
66
|
# updating states.
|
67
67
|
class Recommendation
|
68
|
-
include Google::Protobuf::MessageExts
|
69
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
68
|
+
include ::Google::Protobuf::MessageExts
|
69
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
70
70
|
end
|
71
71
|
|
72
72
|
# Contains what resources are changing and how they are changing.
|
73
73
|
# @!attribute [rw] operation_groups
|
74
|
-
# @return [Array
|
74
|
+
# @return [::Array<::Google::Cloud::Recommender::V1::OperationGroup>]
|
75
75
|
# Operations to one or more Google Cloud resources grouped in such a way
|
76
76
|
# that, all operations within one group are expected to be performed
|
77
77
|
# atomically and in an order.
|
78
78
|
class RecommendationContent
|
79
|
-
include Google::Protobuf::MessageExts
|
80
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
79
|
+
include ::Google::Protobuf::MessageExts
|
80
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
81
81
|
end
|
82
82
|
|
83
83
|
# Group of operations that need to be performed atomically.
|
84
84
|
# @!attribute [rw] operations
|
85
|
-
# @return [Array
|
85
|
+
# @return [::Array<::Google::Cloud::Recommender::V1::Operation>]
|
86
86
|
# List of operations across one or more resources that belong to this group.
|
87
87
|
# Loosely based on RFC6902 and should be performed in the order they appear.
|
88
88
|
class OperationGroup
|
89
|
-
include Google::Protobuf::MessageExts
|
90
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
89
|
+
include ::Google::Protobuf::MessageExts
|
90
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
91
91
|
end
|
92
92
|
|
93
93
|
# Contains an operation for a resource loosely based on the JSON-PATCH format
|
@@ -100,45 +100,45 @@ module Google
|
|
100
100
|
# * Allows extension to custom operations not natively supported by RFC6902.
|
101
101
|
# See https://tools.ietf.org/html/rfc6902 for details on the original RFC.
|
102
102
|
# @!attribute [rw] action
|
103
|
-
# @return [String]
|
103
|
+
# @return [::String]
|
104
104
|
# Type of this operation. Contains one of 'and', 'remove', 'replace', 'move',
|
105
105
|
# 'copy', 'test' and custom operations. This field is case-insensitive and
|
106
106
|
# always populated.
|
107
107
|
# @!attribute [rw] resource_type
|
108
|
-
# @return [String]
|
108
|
+
# @return [::String]
|
109
109
|
# Type of GCP resource being modified/tested. This field is always populated.
|
110
110
|
# Example: cloudresourcemanager.googleapis.com/Project,
|
111
111
|
# compute.googleapis.com/Instance
|
112
112
|
# @!attribute [rw] resource
|
113
|
-
# @return [String]
|
113
|
+
# @return [::String]
|
114
114
|
# Contains the fully qualified resource name. This field is always populated.
|
115
115
|
# ex: //cloudresourcemanager.googleapis.com/projects/foo.
|
116
116
|
# @!attribute [rw] path
|
117
|
-
# @return [String]
|
117
|
+
# @return [::String]
|
118
118
|
# Path to the target field being operated on. If the operation is at the
|
119
119
|
# resource level, then path should be "/". This field is always populated.
|
120
120
|
# @!attribute [rw] source_resource
|
121
|
-
# @return [String]
|
121
|
+
# @return [::String]
|
122
122
|
# Can be set with action 'copy' to copy resource configuration across
|
123
123
|
# different resources of the same type. Example: A resource clone can be
|
124
124
|
# done via action = 'copy', path = "/", from = "/",
|
125
125
|
# source_resource = <source> and resource_name = <target>.
|
126
126
|
# This field is empty for all other values of `action`.
|
127
127
|
# @!attribute [rw] source_path
|
128
|
-
# @return [String]
|
128
|
+
# @return [::String]
|
129
129
|
# Can be set with action 'copy' or 'move' to indicate the source field within
|
130
130
|
# resource or source_resource, ignored if provided for other operation types.
|
131
131
|
# @!attribute [rw] value
|
132
|
-
# @return [Google::Protobuf::Value]
|
132
|
+
# @return [::Google::Protobuf::Value]
|
133
133
|
# Value for the `path` field. Will be set for actions:'add'/'replace'.
|
134
134
|
# Maybe set for action: 'test'. Either this or `value_matcher` will be set
|
135
135
|
# for 'test' operation. An exact match must be performed.
|
136
136
|
# @!attribute [rw] value_matcher
|
137
|
-
# @return [Google::Cloud::Recommender::V1::ValueMatcher]
|
137
|
+
# @return [::Google::Cloud::Recommender::V1::ValueMatcher]
|
138
138
|
# Can be set for action 'test' for advanced matching for the value of
|
139
139
|
# 'path' field. Either this or `value` will be set for 'test' operation.
|
140
140
|
# @!attribute [rw] path_filters
|
141
|
-
# @return [Google::Protobuf::Map{String => Google::Protobuf::Value}]
|
141
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
|
142
142
|
# Set of filters to apply if `path` refers to array elements or nested array
|
143
143
|
# elements in order to narrow down to a single unique element that is being
|
144
144
|
# tested/modified.
|
@@ -160,70 +160,70 @@ module Google
|
|
160
160
|
# When both path_filters and path_value_matchers are set, an implicit AND
|
161
161
|
# must be performed.
|
162
162
|
# @!attribute [rw] path_value_matchers
|
163
|
-
# @return [Google::Protobuf::Map{String => Google::Cloud::Recommender::V1::ValueMatcher}]
|
163
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Recommender::V1::ValueMatcher}]
|
164
164
|
# Similar to path_filters, this contains set of filters to apply if `path`
|
165
165
|
# field referes to array elements. This is meant to support value matching
|
166
166
|
# beyond exact match. To perform exact match, use path_filters.
|
167
167
|
# When both path_filters and path_value_matchers are set, an implicit AND
|
168
168
|
# must be performed.
|
169
169
|
class Operation
|
170
|
-
include Google::Protobuf::MessageExts
|
171
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
170
|
+
include ::Google::Protobuf::MessageExts
|
171
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
172
172
|
|
173
173
|
# @!attribute [rw] key
|
174
|
-
# @return [String]
|
174
|
+
# @return [::String]
|
175
175
|
# @!attribute [rw] value
|
176
|
-
# @return [Google::Protobuf::Value]
|
176
|
+
# @return [::Google::Protobuf::Value]
|
177
177
|
class PathFiltersEntry
|
178
|
-
include Google::Protobuf::MessageExts
|
179
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
178
|
+
include ::Google::Protobuf::MessageExts
|
179
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
180
180
|
end
|
181
181
|
|
182
182
|
# @!attribute [rw] key
|
183
|
-
# @return [String]
|
183
|
+
# @return [::String]
|
184
184
|
# @!attribute [rw] value
|
185
|
-
# @return [Google::Cloud::Recommender::V1::ValueMatcher]
|
185
|
+
# @return [::Google::Cloud::Recommender::V1::ValueMatcher]
|
186
186
|
class PathValueMatchersEntry
|
187
|
-
include Google::Protobuf::MessageExts
|
188
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
187
|
+
include ::Google::Protobuf::MessageExts
|
188
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
189
189
|
end
|
190
190
|
end
|
191
191
|
|
192
192
|
# Contains various matching options for values for a GCP resource field.
|
193
193
|
# @!attribute [rw] matches_pattern
|
194
|
-
# @return [String]
|
194
|
+
# @return [::String]
|
195
195
|
# To be used for full regex matching. The regular expression is using the
|
196
196
|
# Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be
|
197
197
|
# used with RE2::FullMatch
|
198
198
|
class ValueMatcher
|
199
|
-
include Google::Protobuf::MessageExts
|
200
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
199
|
+
include ::Google::Protobuf::MessageExts
|
200
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
201
201
|
end
|
202
202
|
|
203
203
|
# Contains metadata about how much money a recommendation can save or incur.
|
204
204
|
# @!attribute [rw] cost
|
205
|
-
# @return [Google::Type::Money]
|
205
|
+
# @return [::Google::Type::Money]
|
206
206
|
# An approximate projection on amount saved or amount incurred. Negative cost
|
207
207
|
# units indicate cost savings and positive cost units indicate increase.
|
208
208
|
# See google.type.Money documentation for positive/negative units.
|
209
209
|
# @!attribute [rw] duration
|
210
|
-
# @return [Google::Protobuf::Duration]
|
210
|
+
# @return [::Google::Protobuf::Duration]
|
211
211
|
# Duration for which this cost applies.
|
212
212
|
class CostProjection
|
213
|
-
include Google::Protobuf::MessageExts
|
214
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
213
|
+
include ::Google::Protobuf::MessageExts
|
214
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
215
215
|
end
|
216
216
|
|
217
217
|
# Contains the impact a recommendation can have for a given category.
|
218
218
|
# @!attribute [rw] category
|
219
|
-
# @return [Google::Cloud::Recommender::V1::Impact::Category]
|
219
|
+
# @return [::Google::Cloud::Recommender::V1::Impact::Category]
|
220
220
|
# Category that is being targeted.
|
221
221
|
# @!attribute [rw] cost_projection
|
222
|
-
# @return [Google::Cloud::Recommender::V1::CostProjection]
|
222
|
+
# @return [::Google::Cloud::Recommender::V1::CostProjection]
|
223
223
|
# Use with CategoryType.COST
|
224
224
|
class Impact
|
225
|
-
include Google::Protobuf::MessageExts
|
226
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
225
|
+
include ::Google::Protobuf::MessageExts
|
226
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
227
227
|
|
228
228
|
# The category of the impact.
|
229
229
|
module Category
|
@@ -246,22 +246,22 @@ module Google
|
|
246
246
|
|
247
247
|
# Information for state. Contains state and metadata.
|
248
248
|
# @!attribute [rw] state
|
249
|
-
# @return [Google::Cloud::Recommender::V1::RecommendationStateInfo::State]
|
249
|
+
# @return [::Google::Cloud::Recommender::V1::RecommendationStateInfo::State]
|
250
250
|
# The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.
|
251
251
|
# @!attribute [rw] state_metadata
|
252
|
-
# @return [Google::Protobuf::Map{String => String}]
|
252
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
253
253
|
# A map of metadata for the state, provided by user or automations systems.
|
254
254
|
class RecommendationStateInfo
|
255
|
-
include Google::Protobuf::MessageExts
|
256
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
255
|
+
include ::Google::Protobuf::MessageExts
|
256
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
257
257
|
|
258
258
|
# @!attribute [rw] key
|
259
|
-
# @return [String]
|
259
|
+
# @return [::String]
|
260
260
|
# @!attribute [rw] value
|
261
|
-
# @return [String]
|
261
|
+
# @return [::String]
|
262
262
|
class StateMetadataEntry
|
263
|
-
include Google::Protobuf::MessageExts
|
264
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
263
|
+
include ::Google::Protobuf::MessageExts
|
264
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
265
265
|
end
|
266
266
|
|
267
267
|
# Represents Recommendation State
|
@@ -23,7 +23,7 @@ module Google
|
|
23
23
|
module V1
|
24
24
|
# Request for the `ListRecommendations` method.
|
25
25
|
# @!attribute [rw] parent
|
26
|
-
# @return [String]
|
26
|
+
# @return [::String]
|
27
27
|
# Required. The container resource on which to execute the request.
|
28
28
|
# Acceptable formats:
|
29
29
|
#
|
@@ -33,126 +33,126 @@ module Google
|
|
33
33
|
# LOCATION here refers to GCP Locations:
|
34
34
|
# https://cloud.google.com/about/locations/
|
35
35
|
# @!attribute [rw] page_size
|
36
|
-
# @return [Integer]
|
36
|
+
# @return [::Integer]
|
37
37
|
# Optional. The maximum number of results to return from this request. Non-positive
|
38
38
|
# values are ignored. If not specified, the server will determine the number
|
39
39
|
# of results to return.
|
40
40
|
# @!attribute [rw] page_token
|
41
|
-
# @return [String]
|
41
|
+
# @return [::String]
|
42
42
|
# Optional. If present, retrieves the next batch of results from the preceding call to
|
43
43
|
# this method. `page_token` must be the value of `next_page_token` from the
|
44
44
|
# previous response. The values of other method parameters must be identical
|
45
45
|
# to those in the previous call.
|
46
46
|
# @!attribute [rw] filter
|
47
|
-
# @return [String]
|
47
|
+
# @return [::String]
|
48
48
|
# Filter expression to restrict the recommendations returned. Supported
|
49
49
|
# filter fields: state_info.state
|
50
50
|
# Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"
|
51
51
|
class ListRecommendationsRequest
|
52
|
-
include Google::Protobuf::MessageExts
|
53
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
52
|
+
include ::Google::Protobuf::MessageExts
|
53
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
54
54
|
end
|
55
55
|
|
56
56
|
# Response to the `ListRecommendations` method.
|
57
57
|
# @!attribute [rw] recommendations
|
58
|
-
# @return [Array
|
58
|
+
# @return [::Array<::Google::Cloud::Recommender::V1::Recommendation>]
|
59
59
|
# The set of recommendations for the `parent` resource.
|
60
60
|
# @!attribute [rw] next_page_token
|
61
|
-
# @return [String]
|
61
|
+
# @return [::String]
|
62
62
|
# A token that can be used to request the next page of results. This field is
|
63
63
|
# empty if there are no additional results.
|
64
64
|
class ListRecommendationsResponse
|
65
|
-
include Google::Protobuf::MessageExts
|
66
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
65
|
+
include ::Google::Protobuf::MessageExts
|
66
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
67
67
|
end
|
68
68
|
|
69
69
|
# Request to the `GetRecommendation` method.
|
70
70
|
# @!attribute [rw] name
|
71
|
-
# @return [String]
|
71
|
+
# @return [::String]
|
72
72
|
# Required. Name of the recommendation.
|
73
73
|
class GetRecommendationRequest
|
74
|
-
include Google::Protobuf::MessageExts
|
75
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
74
|
+
include ::Google::Protobuf::MessageExts
|
75
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
76
76
|
end
|
77
77
|
|
78
78
|
# Request for the `MarkRecommendationClaimed` Method.
|
79
79
|
# @!attribute [rw] name
|
80
|
-
# @return [String]
|
80
|
+
# @return [::String]
|
81
81
|
# Required. Name of the recommendation.
|
82
82
|
# @!attribute [rw] state_metadata
|
83
|
-
# @return [Google::Protobuf::Map{String => String}]
|
83
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
84
84
|
# State properties to include with this state. Overwrites any existing
|
85
85
|
# `state_metadata`.
|
86
86
|
# Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\{0,62}$/.
|
87
87
|
# Values must match the regex /^[a-zA-Z0-9_./-]\\{0,255}$/.
|
88
88
|
# @!attribute [rw] etag
|
89
|
-
# @return [String]
|
89
|
+
# @return [::String]
|
90
90
|
# Required. Fingerprint of the Recommendation. Provides optimistic locking.
|
91
91
|
class MarkRecommendationClaimedRequest
|
92
|
-
include Google::Protobuf::MessageExts
|
93
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
92
|
+
include ::Google::Protobuf::MessageExts
|
93
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
94
94
|
|
95
95
|
# @!attribute [rw] key
|
96
|
-
# @return [String]
|
96
|
+
# @return [::String]
|
97
97
|
# @!attribute [rw] value
|
98
|
-
# @return [String]
|
98
|
+
# @return [::String]
|
99
99
|
class StateMetadataEntry
|
100
|
-
include Google::Protobuf::MessageExts
|
101
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
100
|
+
include ::Google::Protobuf::MessageExts
|
101
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
102
102
|
end
|
103
103
|
end
|
104
104
|
|
105
105
|
# Request for the `MarkRecommendationSucceeded` Method.
|
106
106
|
# @!attribute [rw] name
|
107
|
-
# @return [String]
|
107
|
+
# @return [::String]
|
108
108
|
# Required. Name of the recommendation.
|
109
109
|
# @!attribute [rw] state_metadata
|
110
|
-
# @return [Google::Protobuf::Map{String => String}]
|
110
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
111
111
|
# State properties to include with this state. Overwrites any existing
|
112
112
|
# `state_metadata`.
|
113
113
|
# Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\{0,62}$/.
|
114
114
|
# Values must match the regex /^[a-zA-Z0-9_./-]\\{0,255}$/.
|
115
115
|
# @!attribute [rw] etag
|
116
|
-
# @return [String]
|
116
|
+
# @return [::String]
|
117
117
|
# Required. Fingerprint of the Recommendation. Provides optimistic locking.
|
118
118
|
class MarkRecommendationSucceededRequest
|
119
|
-
include Google::Protobuf::MessageExts
|
120
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
119
|
+
include ::Google::Protobuf::MessageExts
|
120
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
121
121
|
|
122
122
|
# @!attribute [rw] key
|
123
|
-
# @return [String]
|
123
|
+
# @return [::String]
|
124
124
|
# @!attribute [rw] value
|
125
|
-
# @return [String]
|
125
|
+
# @return [::String]
|
126
126
|
class StateMetadataEntry
|
127
|
-
include Google::Protobuf::MessageExts
|
128
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
127
|
+
include ::Google::Protobuf::MessageExts
|
128
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
129
129
|
end
|
130
130
|
end
|
131
131
|
|
132
132
|
# Request for the `MarkRecommendationFailed` Method.
|
133
133
|
# @!attribute [rw] name
|
134
|
-
# @return [String]
|
134
|
+
# @return [::String]
|
135
135
|
# Required. Name of the recommendation.
|
136
136
|
# @!attribute [rw] state_metadata
|
137
|
-
# @return [Google::Protobuf::Map{String => String}]
|
137
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
138
138
|
# State properties to include with this state. Overwrites any existing
|
139
139
|
# `state_metadata`.
|
140
140
|
# Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\{0,62}$/.
|
141
141
|
# Values must match the regex /^[a-zA-Z0-9_./-]\\{0,255}$/.
|
142
142
|
# @!attribute [rw] etag
|
143
|
-
# @return [String]
|
143
|
+
# @return [::String]
|
144
144
|
# Required. Fingerprint of the Recommendation. Provides optimistic locking.
|
145
145
|
class MarkRecommendationFailedRequest
|
146
|
-
include Google::Protobuf::MessageExts
|
147
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
146
|
+
include ::Google::Protobuf::MessageExts
|
147
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
148
148
|
|
149
149
|
# @!attribute [rw] key
|
150
|
-
# @return [String]
|
150
|
+
# @return [::String]
|
151
151
|
# @!attribute [rw] value
|
152
|
-
# @return [String]
|
152
|
+
# @return [::String]
|
153
153
|
class StateMetadataEntry
|
154
|
-
include Google::Protobuf::MessageExts
|
155
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
154
|
+
include ::Google::Protobuf::MessageExts
|
155
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
156
156
|
end
|
157
157
|
end
|
158
158
|
end
|