Blame - docs/dyn/recommender_v1.projects.locations.recommenders.recommendations.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

80

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

81

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

82

<p class="firstline">Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.</p>

83

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

84

<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

yoshi-code-bot

2021-05-27 00:38:02 -0700

[diff] [blame]

85

<p class="firstline">Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.</p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

86

87

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

88

<p class="firstline">Retrieves the next page of results.</p>

89

90

<code><a href="#markClaimed">markClaimed(name, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

91

<p class="firstline">Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.</p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

92

93

<code><a href="#markFailed">markFailed(name, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

94

<p class="firstline">Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.</p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

95

96

<code><a href="#markSucceeded">markSucceeded(name, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

97

<p class="firstline">Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.</p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

98

<h3>Method Details</h3>

99

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

100

<code class="details" id="close">close()</code>

101

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

105

<code class="details" id="get">get(name, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

106

<pre>Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

Args:

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

117

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

118

{ # A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

119

"additionalImpact": [ # Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative.

120

{ # Contains the impact a recommendation can have for a given category.

121

"category": "A String", # Category that is being targeted.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

122

"costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST

123

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

124

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

125

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

126

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

127

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

128

"duration": "A String", # Duration for which this cost applies.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

129

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

130

"securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY

131

"details": { # Additional security impact details that is provided by the recommender.

132

"a_key": "", # Properties of the object.

133

},

134

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

135

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

136

],

137

"associatedInsights": [ # Insights that led to this recommendation.

138

{ # Reference to an associated insight.

139

"insight": "A String", # Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]

140

},

141

],

142

"content": { # Contains what resources are changing and how they are changing. # Content of the recommendation describing recommended changes to resources.

143

"operationGroups": [ # Operations to one or more Google Cloud resources grouped in such a way that, all operations within one group are expected to be performed atomically and in an order.

144

{ # Group of operations that need to be performed atomically.

145

"operations": [ # List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear.

146

{ # Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array patch. * Extended path values for describing nested arrays. * Custom fields for describing the resource for which the operation is being described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC.

yoshi-code-bot

2021-05-27 00:38:02 -0700

[diff] [blame]

147

"action": "A String", # Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

148

"path": "A String", # Path to the target field being operated on. If the operation is at the resource level, then path should be "/". This field is always populated.

149

"pathFilters": { # Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { "/versions/*/name" : "it-123" "/versions/*/targetSize/percent": 20 } * Example: { "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null } * Example: { "/bindings/*/role": "roles/owner" "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } When both path_filters and path_value_matchers are set, an implicit AND must be performed.

150

"a_key": "",

151

},

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

152

"pathValueMatchers": { # Similar to path_filters, this contains set of filters to apply if `path` field refers to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

153

"a_key": { # Contains various matching options for values for a GCP resource field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

154

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch

155

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

156

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

157

"resource": "A String", # Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.

158

"resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance

159

"sourcePath": "A String", # Can be set with action 'copy' or 'move' to indicate the source field within resource or source_resource, ignored if provided for other operation types.

160

"sourceResource": "A String", # Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = "/", from = "/", source_resource = and resource_name = . This field is empty for all other values of `action`.

161

"value": "", # Value for the `path` field. Will be set for actions:'add'/'replace'. Maybe set for action: 'test'. Either this or `value_matcher` will be set for 'test' operation. An exact match must be performed.

162

"valueMatcher": { # Contains various matching options for values for a GCP resource field. # Can be set for action 'test' for advanced matching for the value of 'path' field. Either this or `value` will be set for 'test' operation.

163

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch

},

},

],

},

],

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame]

169

"overview": { # Condensed overview information about the recommendation.

170

"a_key": "", # Properties of the object.

171

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

172

},

173

"description": "A String", # Free-form human readable summary in English. The maximum length is 500 characters.

174

"etag": "A String", # Fingerprint of the Recommendation. Provides optimistic locking when updating states.

175

"lastRefreshTime": "A String", # Last time this recommendation was refreshed by the system that created it in the first place.

176

"name": "A String", # Name of recommendation.

177

"primaryImpact": { # Contains the impact a recommendation can have for a given category. # The primary impact that this recommendation can have while trying to optimize for one category.

178

"category": "A String", # Category that is being targeted.

179

"costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST

180

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units.

181

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

182

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

183

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

184

},

185

"duration": "A String", # Duration for which this cost applies.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

186

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

187

"securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY

188

"details": { # Additional security impact details that is provided by the recommender.

189

"a_key": "", # Properties of the object.

190

},

191

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

192

},

yoshi-code-bot

2021-05-08 07:21:27 -0700

[diff] [blame]

193

"priority": "A String", # Recommendation's priority.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

194

"recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE"

195

"stateInfo": { # Information for state. Contains state and metadata. # Information for state. Contains state and metadata.

196

"state": "A String", # The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.

197

"stateMetadata": { # A map of metadata for the state, provided by user or automations systems.

"a_key": "A String",

},

},

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

205

<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

yoshi-code-bot

2021-05-27 00:38:02 -0700

[diff] [blame]

206

<pre>Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

207

208

Args:

yoshi-code-bot

04bafe1

2021-06-29 00:20:25 -0700

[diff] [blame]

209

parent: string, Required. The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/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. (required)

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

210

filter: string, Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160)

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

211

pageSize: integer, 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.

212

pageToken: string, 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

213

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

220

221

{ # Response to the `ListRecommendations` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

222

"nextPageToken": "A String", # A token that can be used to request the next page of results. This field is empty if there are no additional results.

223

"recommendations": [ # The set of recommendations for the `parent` resource.

224

{ # A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc

225

"additionalImpact": [ # Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative.

226

{ # Contains the impact a recommendation can have for a given category.

227

"category": "A String", # Category that is being targeted.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

228

"costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST

229

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

230

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

231

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

232

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

233

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

234

"duration": "A String", # Duration for which this cost applies.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

235

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

236

"securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY

237

"details": { # Additional security impact details that is provided by the recommender.

238

"a_key": "", # Properties of the object.

239

},

240

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

241

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

242

],

243

"associatedInsights": [ # Insights that led to this recommendation.

244

{ # Reference to an associated insight.

245

"insight": "A String", # Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]

246

},

247

],

248

"content": { # Contains what resources are changing and how they are changing. # Content of the recommendation describing recommended changes to resources.

249

"operationGroups": [ # Operations to one or more Google Cloud resources grouped in such a way that, all operations within one group are expected to be performed atomically and in an order.

250

{ # Group of operations that need to be performed atomically.

251

"operations": [ # List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear.

252

{ # Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array patch. * Extended path values for describing nested arrays. * Custom fields for describing the resource for which the operation is being described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC.

yoshi-code-bot

2021-05-27 00:38:02 -0700

[diff] [blame]

253

"action": "A String", # Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

254

"path": "A String", # Path to the target field being operated on. If the operation is at the resource level, then path should be "/". This field is always populated.

255

"pathFilters": { # Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { "/versions/*/name" : "it-123" "/versions/*/targetSize/percent": 20 } * Example: { "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null } * Example: { "/bindings/*/role": "roles/owner" "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } When both path_filters and path_value_matchers are set, an implicit AND must be performed.

256

"a_key": "",

257

},

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

258

"pathValueMatchers": { # Similar to path_filters, this contains set of filters to apply if `path` field refers to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

259

"a_key": { # Contains various matching options for values for a GCP resource field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

260

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch

261

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

262

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

263

"resource": "A String", # Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.

264

"resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance

265

"sourcePath": "A String", # Can be set with action 'copy' or 'move' to indicate the source field within resource or source_resource, ignored if provided for other operation types.

266

"sourceResource": "A String", # Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = "/", from = "/", source_resource = and resource_name = . This field is empty for all other values of `action`.

267

"value": "", # Value for the `path` field. Will be set for actions:'add'/'replace'. Maybe set for action: 'test'. Either this or `value_matcher` will be set for 'test' operation. An exact match must be performed.

268

"valueMatcher": { # Contains various matching options for values for a GCP resource field. # Can be set for action 'test' for advanced matching for the value of 'path' field. Either this or `value` will be set for 'test' operation.

269

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch

},

},

],

},

],

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame]

275

"overview": { # Condensed overview information about the recommendation.

276

"a_key": "", # Properties of the object.

277

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

278

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

279

"description": "A String", # Free-form human readable summary in English. The maximum length is 500 characters.

280

"etag": "A String", # Fingerprint of the Recommendation. Provides optimistic locking when updating states.

281

"lastRefreshTime": "A String", # Last time this recommendation was refreshed by the system that created it in the first place.

282

"name": "A String", # Name of recommendation.

283

"primaryImpact": { # Contains the impact a recommendation can have for a given category. # The primary impact that this recommendation can have while trying to optimize for one category.

284

"category": "A String", # Category that is being targeted.

285

"costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST

286

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units.

287

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

288

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

289

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

290

},

291

"duration": "A String", # Duration for which this cost applies.

292

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

293

"securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY

294

"details": { # Additional security impact details that is provided by the recommender.

295

"a_key": "", # Properties of the object.

296

},

297

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

298

},

yoshi-code-bot

2021-05-08 07:21:27 -0700

[diff] [blame]

299

"priority": "A String", # Recommendation's priority.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

300

"recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE"

301

"stateInfo": { # Information for state. Contains state and metadata. # Information for state. Contains state and metadata.

302

"state": "A String", # The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.

303

"stateMetadata": { # A map of metadata for the state, provided by user or automations systems.

"a_key": "A String",

},

},

},

],

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

314

<pre>Retrieves the next page of results.

315

316

Args:

317

previous_request: The request for the previous page. (required)

318

previous_response: The response from the request for the previous page. (required)

319

320

Returns:

321

A request object that you can call 'execute()' on to request the next

322

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="markClaimed">markClaimed(name, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

328

<pre>Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

Args:

body: object, The request body.

333

The object takes the form of:

334

335

{ # Request for the `MarkRecommendationClaimed` Method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

336

"etag": "A String", # Required. Fingerprint of the Recommendation. Provides optimistic locking.

337

"stateMetadata": { # State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.

338

"a_key": "A String",

339

},

340

}

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

341

342

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

349

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

350

{ # A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

351

"additionalImpact": [ # Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative.

352

{ # Contains the impact a recommendation can have for a given category.

353

"category": "A String", # Category that is being targeted.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

354

"costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST

355

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

356

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

357

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

358

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

359

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

360

"duration": "A String", # Duration for which this cost applies.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

361

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

362

"securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY

363

"details": { # Additional security impact details that is provided by the recommender.

364

"a_key": "", # Properties of the object.

365

},

366

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

367

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

368

],

369

"associatedInsights": [ # Insights that led to this recommendation.

370

{ # Reference to an associated insight.

371

"insight": "A String", # Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]

372

},

373

],

374

"content": { # Contains what resources are changing and how they are changing. # Content of the recommendation describing recommended changes to resources.

375

"operationGroups": [ # Operations to one or more Google Cloud resources grouped in such a way that, all operations within one group are expected to be performed atomically and in an order.

376

{ # Group of operations that need to be performed atomically.

377

"operations": [ # List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear.

378

{ # Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array patch. * Extended path values for describing nested arrays. * Custom fields for describing the resource for which the operation is being described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC.

yoshi-code-bot

2021-05-27 00:38:02 -0700

[diff] [blame]

379

"action": "A String", # Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

380

"path": "A String", # Path to the target field being operated on. If the operation is at the resource level, then path should be "/". This field is always populated.

381

"pathFilters": { # Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { "/versions/*/name" : "it-123" "/versions/*/targetSize/percent": 20 } * Example: { "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null } * Example: { "/bindings/*/role": "roles/owner" "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } When both path_filters and path_value_matchers are set, an implicit AND must be performed.

382

"a_key": "",

383

},

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

384

"pathValueMatchers": { # Similar to path_filters, this contains set of filters to apply if `path` field refers to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

385

"a_key": { # Contains various matching options for values for a GCP resource field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

386

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch

387

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

388

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

389

"resource": "A String", # Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.

390

"resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance

391

"sourcePath": "A String", # Can be set with action 'copy' or 'move' to indicate the source field within resource or source_resource, ignored if provided for other operation types.

392

"sourceResource": "A String", # Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = "/", from = "/", source_resource = and resource_name = . This field is empty for all other values of `action`.

393

"value": "", # Value for the `path` field. Will be set for actions:'add'/'replace'. Maybe set for action: 'test'. Either this or `value_matcher` will be set for 'test' operation. An exact match must be performed.

394

"valueMatcher": { # Contains various matching options for values for a GCP resource field. # Can be set for action 'test' for advanced matching for the value of 'path' field. Either this or `value` will be set for 'test' operation.

395

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch

},

},

],

},

],

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame]

401

"overview": { # Condensed overview information about the recommendation.

402

"a_key": "", # Properties of the object.

403

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

404

},

405

"description": "A String", # Free-form human readable summary in English. The maximum length is 500 characters.

406

"etag": "A String", # Fingerprint of the Recommendation. Provides optimistic locking when updating states.

407

"lastRefreshTime": "A String", # Last time this recommendation was refreshed by the system that created it in the first place.

408

"name": "A String", # Name of recommendation.

409

"primaryImpact": { # Contains the impact a recommendation can have for a given category. # The primary impact that this recommendation can have while trying to optimize for one category.

410

"category": "A String", # Category that is being targeted.

411

"costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST

412

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units.

413

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

414

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

415

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

416

},

417

"duration": "A String", # Duration for which this cost applies.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

418

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

419

"securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY

420

"details": { # Additional security impact details that is provided by the recommender.

421

"a_key": "", # Properties of the object.

422

},

423

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

424

},

yoshi-code-bot

2021-05-08 07:21:27 -0700

[diff] [blame]

425

"priority": "A String", # Recommendation's priority.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

426

"recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE"

427

"stateInfo": { # Information for state. Contains state and metadata. # Information for state. Contains state and metadata.

428

"state": "A String", # The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.

429

"stateMetadata": { # A map of metadata for the state, provided by user or automations systems.

"a_key": "A String",

},

},

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

<code class="details" id="markFailed">markFailed(name, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

438

<pre>Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

Args:

body: object, The request body.

443

The object takes the form of:

444

445

{ # Request for the `MarkRecommendationFailed` Method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

446

"etag": "A String", # Required. Fingerprint of the Recommendation. Provides optimistic locking.

447

"stateMetadata": { # State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.

448

"a_key": "A String",

449

},

450

}

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

451

452

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

459

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

460

{ # A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

461

"additionalImpact": [ # Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative.

462

{ # Contains the impact a recommendation can have for a given category.

463

"category": "A String", # Category that is being targeted.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

464

"costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST

465

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

466

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

467

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

468

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

469

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

470

"duration": "A String", # Duration for which this cost applies.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

471

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

472

"securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY

473

"details": { # Additional security impact details that is provided by the recommender.

474

"a_key": "", # Properties of the object.

475

},

476

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

477

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

478

],

479

"associatedInsights": [ # Insights that led to this recommendation.

480

{ # Reference to an associated insight.

481

"insight": "A String", # Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]

482

},

483

],

484

"content": { # Contains what resources are changing and how they are changing. # Content of the recommendation describing recommended changes to resources.

485

"operationGroups": [ # Operations to one or more Google Cloud resources grouped in such a way that, all operations within one group are expected to be performed atomically and in an order.

486

{ # Group of operations that need to be performed atomically.

487

"operations": [ # List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear.

488

{ # Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array patch. * Extended path values for describing nested arrays. * Custom fields for describing the resource for which the operation is being described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC.

yoshi-code-bot

2021-05-27 00:38:02 -0700

[diff] [blame]

489

"action": "A String", # Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

490

"path": "A String", # Path to the target field being operated on. If the operation is at the resource level, then path should be "/". This field is always populated.

491

"pathFilters": { # Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { "/versions/*/name" : "it-123" "/versions/*/targetSize/percent": 20 } * Example: { "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null } * Example: { "/bindings/*/role": "roles/owner" "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } When both path_filters and path_value_matchers are set, an implicit AND must be performed.

492

"a_key": "",

493

},

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

494

"pathValueMatchers": { # Similar to path_filters, this contains set of filters to apply if `path` field refers to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

495

"a_key": { # Contains various matching options for values for a GCP resource field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

496

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch

497

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

498

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

499

"resource": "A String", # Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.

500

"resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance

501

"sourcePath": "A String", # Can be set with action 'copy' or 'move' to indicate the source field within resource or source_resource, ignored if provided for other operation types.

502

"sourceResource": "A String", # Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = "/", from = "/", source_resource = and resource_name = . This field is empty for all other values of `action`.

503

"value": "", # Value for the `path` field. Will be set for actions:'add'/'replace'. Maybe set for action: 'test'. Either this or `value_matcher` will be set for 'test' operation. An exact match must be performed.

504

"valueMatcher": { # Contains various matching options for values for a GCP resource field. # Can be set for action 'test' for advanced matching for the value of 'path' field. Either this or `value` will be set for 'test' operation.

505

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch

},

},

],

},

],

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame]

511

"overview": { # Condensed overview information about the recommendation.

512

"a_key": "", # Properties of the object.

513

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

514

},

515

"description": "A String", # Free-form human readable summary in English. The maximum length is 500 characters.

516

"etag": "A String", # Fingerprint of the Recommendation. Provides optimistic locking when updating states.

517

"lastRefreshTime": "A String", # Last time this recommendation was refreshed by the system that created it in the first place.

518

"name": "A String", # Name of recommendation.

519

"primaryImpact": { # Contains the impact a recommendation can have for a given category. # The primary impact that this recommendation can have while trying to optimize for one category.

520

"category": "A String", # Category that is being targeted.

521

"costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST

522

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units.

523

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

524

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

525

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

526

},

527

"duration": "A String", # Duration for which this cost applies.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

528

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

529

"securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY

530

"details": { # Additional security impact details that is provided by the recommender.

531

"a_key": "", # Properties of the object.

532

},

533

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

534

},

yoshi-code-bot

2021-05-08 07:21:27 -0700

[diff] [blame]

535

"priority": "A String", # Recommendation's priority.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

536

"recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE"

537

"stateInfo": { # Information for state. Contains state and metadata. # Information for state. Contains state and metadata.

538

"state": "A String", # The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.

539

"stateMetadata": { # A map of metadata for the state, provided by user or automations systems.

"a_key": "A String",

},

},

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

<code class="details" id="markSucceeded">markSucceeded(name, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

548

<pre>Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

Args:

body: object, The request body.

553

The object takes the form of:

554

555

{ # Request for the `MarkRecommendationSucceeded` Method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

556

"etag": "A String", # Required. Fingerprint of the Recommendation. Provides optimistic locking.

557

"stateMetadata": { # State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^a-z0-9{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.

558

"a_key": "A String",

559

},

560

}

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

561

562

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

569

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

570

{ # A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

571

"additionalImpact": [ # Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative.

572

{ # Contains the impact a recommendation can have for a given category.

573

"category": "A String", # Category that is being targeted.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

574

"costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST

575

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

576

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

577

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

578

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

579

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

580

"duration": "A String", # Duration for which this cost applies.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

581

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

582

"securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY

583

"details": { # Additional security impact details that is provided by the recommender.

584

"a_key": "", # Properties of the object.

585

},

586

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

587

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

588

],

589

"associatedInsights": [ # Insights that led to this recommendation.

590

{ # Reference to an associated insight.

591

"insight": "A String", # Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]

592

},

593

],

594

"content": { # Contains what resources are changing and how they are changing. # Content of the recommendation describing recommended changes to resources.

595

"operationGroups": [ # Operations to one or more Google Cloud resources grouped in such a way that, all operations within one group are expected to be performed atomically and in an order.

596

{ # Group of operations that need to be performed atomically.

597

"operations": [ # List of operations across one or more resources that belong to this group. Loosely based on RFC6902 and should be performed in the order they appear.

598

{ # Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array patch. * Extended path values for describing nested arrays. * Custom fields for describing the resource for which the operation is being described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC.

yoshi-code-bot

2021-05-27 00:38:02 -0700

[diff] [blame]

599

"action": "A String", # Type of this operation. Contains one of 'add', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

600

"path": "A String", # Path to the target field being operated on. If the operation is at the resource level, then path should be "/". This field is always populated.

601

"pathFilters": { # Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { "/versions/*/name" : "it-123" "/versions/*/targetSize/percent": 20 } * Example: { "/bindings/*/role": "roles/owner" "/bindings/*/condition" : null } * Example: { "/bindings/*/role": "roles/owner" "/bindings/*/members/*" : ["x@example.com", "y@example.com"] } When both path_filters and path_value_matchers are set, an implicit AND must be performed.

602

"a_key": "",

603

},

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

604

"pathValueMatchers": { # Similar to path_filters, this contains set of filters to apply if `path` field refers to array elements. This is meant to support value matching beyond exact match. To perform exact match, use path_filters. When both path_filters and path_value_matchers are set, an implicit AND must be performed.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

605

"a_key": { # Contains various matching options for values for a GCP resource field.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

606

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch

607

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

608

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

609

"resource": "A String", # Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.

610

"resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance

611

"sourcePath": "A String", # Can be set with action 'copy' or 'move' to indicate the source field within resource or source_resource, ignored if provided for other operation types.

612

"sourceResource": "A String", # Can be set with action 'copy' to copy resource configuration across different resources of the same type. Example: A resource clone can be done via action = 'copy', path = "/", from = "/", source_resource = and resource_name = . This field is empty for all other values of `action`.

613

"value": "", # Value for the `path` field. Will be set for actions:'add'/'replace'. Maybe set for action: 'test'. Either this or `value_matcher` will be set for 'test' operation. An exact match must be performed.

614

"valueMatcher": { # Contains various matching options for values for a GCP resource field. # Can be set for action 'test' for advanced matching for the value of 'path' field. Either this or `value` will be set for 'test' operation.

615

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2::FullMatch

},

},

],

},

],

yoshi-code-bot

2021-08-10 00:22:29 -0700

[diff] [blame]

621

"overview": { # Condensed overview information about the recommendation.

622

"a_key": "", # Properties of the object.

623

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

624

},

625

"description": "A String", # Free-form human readable summary in English. The maximum length is 500 characters.

626

"etag": "A String", # Fingerprint of the Recommendation. Provides optimistic locking when updating states.

627

"lastRefreshTime": "A String", # Last time this recommendation was refreshed by the system that created it in the first place.

628

"name": "A String", # Name of recommendation.

629

"primaryImpact": { # Contains the impact a recommendation can have for a given category. # The primary impact that this recommendation can have while trying to optimize for one category.

630

"category": "A String", # Category that is being targeted.

631

"costProjection": { # Contains metadata about how much money a recommendation can save or incur. # Use with CategoryType.COST

632

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost units indicate cost savings and positive cost units indicate increase. See google.type.Money documentation for positive/negative units.

633

"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.

634

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

635

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

636

},

637

"duration": "A String", # Duration for which this cost applies.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

638

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

639

"securityProjection": { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY

640

"details": { # Additional security impact details that is provided by the recommender.

641

"a_key": "", # Properties of the object.

642

},

643

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

644

},

yoshi-code-bot

2021-05-08 07:21:27 -0700

[diff] [blame]

645

"priority": "A String", # Recommendation's priority.

Yoshi Automation Bot