This repository has been archived by the owner on Sep 5, 2023. It is now read-only.
/
recommender_service.py
282 lines (210 loc) · 9.42 KB
/
recommender_service.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# -*- coding: utf-8 -*-
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import proto # type: ignore
from google.cloud.recommender_v1.types import insight
from google.cloud.recommender_v1.types import recommendation
__protobuf__ = proto.module(
package="google.cloud.recommender.v1",
manifest={
"ListInsightsRequest",
"ListInsightsResponse",
"GetInsightRequest",
"MarkInsightAcceptedRequest",
"ListRecommendationsRequest",
"ListRecommendationsResponse",
"GetRecommendationRequest",
"MarkRecommendationClaimedRequest",
"MarkRecommendationSucceededRequest",
"MarkRecommendationFailedRequest",
},
)
class ListInsightsRequest(proto.Message):
r"""Request for the ``ListInsights`` method.
Attributes:
parent (str):
Required. The container resource on which to execute the
request. Acceptable formats:
1.
"projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]",
LOCATION here refers to GCP Locations:
https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID
refers to supported insight types:
https://cloud.google.com/recommender/docs/insights/insight-types.)
page_size (int):
Optional. The maximum number of results to
return from this request. Non-positive values
are ignored. If not specified, the server will
determine the number of results to return.
page_token (str):
Optional. If present, retrieves the next batch of results
from the preceding call to this method. ``page_token`` must
be the value of ``next_page_token`` from the previous
response. The values of other method parameters must be
identical to those in the previous call.
filter (str):
Optional. Filter expression to restrict the insights
returned. Supported filter fields: state Eg:
\`state:"DISMISSED" or state:"ACTIVE".
"""
parent = proto.Field(proto.STRING, number=1)
page_size = proto.Field(proto.INT32, number=2)
page_token = proto.Field(proto.STRING, number=3)
filter = proto.Field(proto.STRING, number=4)
class ListInsightsResponse(proto.Message):
r"""Response to the ``ListInsights`` method.
Attributes:
insights (Sequence[~.insight.Insight]):
The set of insights for the ``parent`` resource.
next_page_token (str):
A token that can be used to request the next
page of results. This field is empty if there
are no additional results.
"""
@property
def raw_page(self):
return self
insights = proto.RepeatedField(proto.MESSAGE, number=1, message=insight.Insight,)
next_page_token = proto.Field(proto.STRING, number=2)
class GetInsightRequest(proto.Message):
r"""Request to the ``GetInsight`` method.
Attributes:
name (str):
Required. Name of the insight.
"""
name = proto.Field(proto.STRING, number=1)
class MarkInsightAcceptedRequest(proto.Message):
r"""Request for the ``MarkInsightAccepted`` method.
Attributes:
name (str):
Required. Name of the insight.
state_metadata (Sequence[~.recommender_service.MarkInsightAcceptedRequest.StateMetadataEntry]):
Optional. State properties user wish to include with this
state. Full replace of the current state_metadata.
etag (str):
Required. Fingerprint of the Insight.
Provides optimistic locking.
"""
name = proto.Field(proto.STRING, number=1)
state_metadata = proto.MapField(proto.STRING, proto.STRING, number=2)
etag = proto.Field(proto.STRING, number=3)
class ListRecommendationsRequest(proto.Message):
r"""Request for the ``ListRecommendations`` method.
Attributes:
parent (str):
Required. The container resource on which to execute the
request. Acceptable formats:
1.
"projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]",
LOCATION here refers to GCP Locations:
https://cloud.google.com/about/locations/ RECOMMENDER_ID
refers to supported recommenders:
https://cloud.google.com/recommender/docs/recommenders.
page_size (int):
Optional. The maximum number of results to
return from this request. Non-positive values
are ignored. If not specified, the server will
determine the number of results to return.
page_token (str):
Optional. If present, retrieves the next batch of results
from the preceding call to this method. ``page_token`` must
be the value of ``next_page_token`` from the previous
response. The values of other method parameters must be
identical to those in the previous call.
filter (str):
Filter expression to restrict the recommendations returned.
Supported filter fields: state_info.state Eg:
\`state_info.state:"DISMISSED" or state_info.state:"FAILED".
"""
parent = proto.Field(proto.STRING, number=1)
page_size = proto.Field(proto.INT32, number=2)
page_token = proto.Field(proto.STRING, number=3)
filter = proto.Field(proto.STRING, number=5)
class ListRecommendationsResponse(proto.Message):
r"""Response to the ``ListRecommendations`` method.
Attributes:
recommendations (Sequence[~.recommendation.Recommendation]):
The set of recommendations for the ``parent`` resource.
next_page_token (str):
A token that can be used to request the next
page of results. This field is empty if there
are no additional results.
"""
@property
def raw_page(self):
return self
recommendations = proto.RepeatedField(
proto.MESSAGE, number=1, message=recommendation.Recommendation,
)
next_page_token = proto.Field(proto.STRING, number=2)
class GetRecommendationRequest(proto.Message):
r"""Request to the ``GetRecommendation`` method.
Attributes:
name (str):
Required. Name of the recommendation.
"""
name = proto.Field(proto.STRING, number=1)
class MarkRecommendationClaimedRequest(proto.Message):
r"""Request for the ``MarkRecommendationClaimed`` Method.
Attributes:
name (str):
Required. Name of the recommendation.
state_metadata (Sequence[~.recommender_service.MarkRecommendationClaimedRequest.StateMetadataEntry]):
State properties to include with this state. Overwrites any
existing ``state_metadata``. Keys must match the regex
``/^[a-z0-9][a-z0-9_.-]{0,62}$/``. Values must match the regex
``/^[a-zA-Z0-9_./-]{0,255}$/``.
etag (str):
Required. Fingerprint of the Recommendation.
Provides optimistic locking.
"""
name = proto.Field(proto.STRING, number=1)
state_metadata = proto.MapField(proto.STRING, proto.STRING, number=2)
etag = proto.Field(proto.STRING, number=3)
class MarkRecommendationSucceededRequest(proto.Message):
r"""Request for the ``MarkRecommendationSucceeded`` Method.
Attributes:
name (str):
Required. Name of the recommendation.
state_metadata (Sequence[~.recommender_service.MarkRecommendationSucceededRequest.StateMetadataEntry]):
State properties to include with this state. Overwrites any
existing ``state_metadata``. Keys must match the regex
``/^[a-z0-9][a-z0-9_.-]{0,62}$/``. Values must match the regex
``/^[a-zA-Z0-9_./-]{0,255}$/``.
etag (str):
Required. Fingerprint of the Recommendation.
Provides optimistic locking.
"""
name = proto.Field(proto.STRING, number=1)
state_metadata = proto.MapField(proto.STRING, proto.STRING, number=2)
etag = proto.Field(proto.STRING, number=3)
class MarkRecommendationFailedRequest(proto.Message):
r"""Request for the ``MarkRecommendationFailed`` Method.
Attributes:
name (str):
Required. Name of the recommendation.
state_metadata (Sequence[~.recommender_service.MarkRecommendationFailedRequest.StateMetadataEntry]):
State properties to include with this state. Overwrites any
existing ``state_metadata``. Keys must match the regex
``/^[a-z0-9][a-z0-9_.-]{0,62}$/``. Values must match the regex
``/^[a-zA-Z0-9_./-]{0,255}$/``.
etag (str):
Required. Fingerprint of the Recommendation.
Provides optimistic locking.
"""
name = proto.Field(proto.STRING, number=1)
state_metadata = proto.MapField(proto.STRING, proto.STRING, number=2)
etag = proto.Field(proto.STRING, number=3)
__all__ = tuple(sorted(__protobuf__.manifest))