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

<h1><a href="recommender_v1.html">Recommender API</a> . <a href="recommender_v1.projects.html">projects</a> . <a href="recommender_v1.projects.locations.html">locations</a> . <a href="recommender_v1.projects.locations.recommenders.html">recommenders</a> . <a href="recommender_v1.projects.locations.recommenders.recommendations.html">recommendations</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

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

80

81

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

82

<p class="firstline">Lists recommendations for a Cloud project. Requires the recommender.*.list</p>

83

84

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

85

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

86

87

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

88

<p class="firstline">Marks the Recommendation State as Claimed. Users can use this method to</p>

89

90

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

91

<p class="firstline">Marks the Recommendation State as Failed. Users can use this method to</p>

92

93

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

94

<p class="firstline">Marks the Recommendation State as Succeeded. Users can use this method to</p>

95

<h3>Method Details</h3>

96

97

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

98

<pre>Gets the requested recommendation. Requires the recommender.*.get

99

IAM permission for the specified recommender.

Args:

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

110

111

{ # A recommendation along with a suggested action. E.g., a rightsizing

112

# recommendation for an underutilized VM, IAM role recommendations, etc

113

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

114

# optimize for one category.

115

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

116

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

117

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost

118

# units indicate cost savings and positive cost units indicate increase.

119

# See google.type.Money documentation for positive/negative units.

120

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

121

"nanos": 42, # Number of nano (10^-9) units of the amount.

122

# The value must be between -999,999,999 and +999,999,999 inclusive.

123

# If `units` is positive, `nanos` must be positive or zero.

124

# If `units` is zero, `nanos` can be positive, zero, or negative.

125

# If `units` is negative, `nanos` must be negative or zero.

126

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

127

"units": "A String", # The whole units of the amount.

128

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

129

},

130

},

131

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

132

},

133

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

134

# in the first place.

135

"recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the

136

# same recommender. Subtype is a function of content and impact, meaning a

137

# new subtype might be added when significant changes to `content` or

138

# `primary_impact.category` are introduced. See the Recommenders section

139

# to see a list of subtypes for a given Recommender.

140

#

141

# Examples:

142

# For recommender = "google.iam.policy.Recommender",

143

# recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE"

144

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

145

# characters.

146

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

147

"operationGroups": [ # Operations to one or more Google Cloud resources grouped in such a way

148

# that, all operations within one group are expected to be performed

149

# atomically and in an order.

150

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

151

"operations": [ # List of operations across one or more resources that belong to this group.

152

# Loosely based on RFC6902 and should be performed in the order they appear.

153

{ # Contains an operation for a resource loosely based on the JSON-PATCH format

154

# with support for:

155

#

156

# * Custom filters for describing partial array patch.

157

# * Extended path values for describing nested arrays.

158

# * Custom fields for describing the resource for which the operation is being

159

# described.

160

# * Allows extension to custom operations not natively supported by RFC6902.

161

# See https://tools.ietf.org/html/rfc6902 for details on the original RFC.

162

"pathValueMatchers": { # Similar to path_filters, this contains set of filters to apply if `path`

163

# field referes to array elements. This is meant to support value matching

164

# beyond exact match. To perform exact match, use path_filters.

165

# When both path_filters and path_value_matchers are set, an implicit AND

166

# must be performed.

167

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

168

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the

169

# Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be

170

# used with RE2::FullMatch

171

},

172

},

173

"pathFilters": { # Set of filters to apply if `path` refers to array elements or nested array

174

# elements in order to narrow down to a single unique element that is being

175

# tested/modified.

176

# This is intended to be an exact match per filter. To perform advanced

177

# matching, use path_value_matchers.

178

#

179

# * Example: {

180

# "/versions/*/name" : "it-123"

181

# "/versions/*/targetSize/percent": 20

182

# }

183

# * Example: {

184

# "/bindings/*/role": "roles/admin"

185

# "/bindings/*/condition" : null

186

# }

187

# * Example: {

188

# "/bindings/*/role": "roles/admin"

189

# "/bindings/*/members/*" : ["x@google.com", "y@google.com"]

190

# }

191

# When both path_filters and path_value_matchers are set, an implicit AND

# must be performed.

"a_key": "",

},

"action": "A String", # Type of this operation. Contains one of 'and', 'remove', 'replace', 'move',

196

# 'copy', 'test' and custom operations. This field is case-insensitive and

197

# always populated.

198

"resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated.

199

# Example: cloudresourcemanager.googleapis.com/Project,

200

# compute.googleapis.com/Instance

201

"sourcePath": "A String", # Can be set with action 'copy' or 'move' to indicate the source field within

202

# resource or source_resource, ignored if provided for other operation types.

203

"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

204

# 'path' field. Either this or `value` will be set for 'test' operation.

205

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the

206

# Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be

207

# used with RE2::FullMatch

208

},

209

"value": "", # Value for the `path` field. Will be set for actions:'add'/'replace'.

210

# Maybe set for action: 'test'. Either this or `value_matcher` will be set

211

# for 'test' operation. An exact match must be performed.

212

"sourceResource": "A String", # Can be set with action 'copy' to copy resource configuration across

213

# different resources of the same type. Example: A resource clone can be

214

# done via action = 'copy', path = "/", from = "/",

215

# source_resource = <source> and resource_name = <target>.

216

# This field is empty for all other values of `action`.

217

"resource": "A String", # Contains the fully qualified resource name. This field is always populated.

218

# ex: //cloudresourcemanager.googleapis.com/projects/foo.

219

"path": "A String", # Path to the target field being operated on. If the operation is at the

220

# resource level, then path should be "/". This field is always populated.

},

],

},

],

},

"additionalImpact": [ # Optional set of additional impact that this recommendation may have when

227

# trying to optimize for the primary category. These may be positive

228

# or negative.

229

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

230

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

231

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

232

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost

233

# units indicate cost savings and positive cost units indicate increase.

234

# See google.type.Money documentation for positive/negative units.

235

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

236

"nanos": 42, # Number of nano (10^-9) units of the amount.

237

# The value must be between -999,999,999 and +999,999,999 inclusive.

238

# If `units` is positive, `nanos` must be positive or zero.

239

# If `units` is zero, `nanos` can be positive, zero, or negative.

240

# If `units` is negative, `nanos` must be negative or zero.

241

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

242

"units": "A String", # The whole units of the amount.

243

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

244

},

245

},

246

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

247

},

248

],

249

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

250

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

251

# updating states.

252

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

253

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

254

"a_key": "A String",

255

},

256

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

257

},

258

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

259

{ # Reference to an associated insight.

260

"insight": "A String", # Insight resource name, e.g.

261

# projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]

},

],

}</pre>

</div>

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

269

<pre>Lists recommendations for a Cloud project. Requires the recommender.*.list

270

IAM permission for the specified recommender.

271

272

Args:

273

parent: string, Required. The container resource on which to execute the request.

Acceptable formats:

1.

"projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]",

278

279

LOCATION here refers to GCP Locations:

280

https://cloud.google.com/about/locations/ (required)

281

filter: string, Filter expression to restrict the recommendations returned. Supported

282

filter fields: state_info.state

283

Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"

284

pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to

285

this method. `page_token` must be the value of `next_page_token` from the

286

previous response. The values of other method parameters must be identical

287

to those in the previous call.

288

pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive

289

values are ignored. If not specified, the server will determine the number

290

of results to return.

291

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

298

299

{ # Response to the `ListRecommendations` method.

300

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

301

{ # A recommendation along with a suggested action. E.g., a rightsizing

302

# recommendation for an underutilized VM, IAM role recommendations, etc

303

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

304

# optimize for one category.

305

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

306

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

307

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost

308

# units indicate cost savings and positive cost units indicate increase.

309

# See google.type.Money documentation for positive/negative units.

310

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

311

"nanos": 42, # Number of nano (10^-9) units of the amount.

312

# The value must be between -999,999,999 and +999,999,999 inclusive.

313

# If `units` is positive, `nanos` must be positive or zero.

314

# If `units` is zero, `nanos` can be positive, zero, or negative.

315

# If `units` is negative, `nanos` must be negative or zero.

316

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

317

"units": "A String", # The whole units of the amount.

318

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

319

},

320

},

321

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

322

},

323

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

324

# in the first place.

325

"recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the

326

# same recommender. Subtype is a function of content and impact, meaning a

327

# new subtype might be added when significant changes to `content` or

328

# `primary_impact.category` are introduced. See the Recommenders section

329

# to see a list of subtypes for a given Recommender.

330

#

331

# Examples:

332

# For recommender = "google.iam.policy.Recommender",

333

# recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE"

334

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

335

# characters.

336

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

337

"operationGroups": [ # Operations to one or more Google Cloud resources grouped in such a way

338

# that, all operations within one group are expected to be performed

339

# atomically and in an order.

340

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

341

"operations": [ # List of operations across one or more resources that belong to this group.

342

# Loosely based on RFC6902 and should be performed in the order they appear.

343

{ # Contains an operation for a resource loosely based on the JSON-PATCH format

344

# with support for:

345

#

346

# * Custom filters for describing partial array patch.

347

# * Extended path values for describing nested arrays.

348

# * Custom fields for describing the resource for which the operation is being

349

# described.

350

# * Allows extension to custom operations not natively supported by RFC6902.

351

# See https://tools.ietf.org/html/rfc6902 for details on the original RFC.

352

"pathValueMatchers": { # Similar to path_filters, this contains set of filters to apply if `path`

353

# field referes to array elements. This is meant to support value matching

354

# beyond exact match. To perform exact match, use path_filters.

355

# When both path_filters and path_value_matchers are set, an implicit AND

356

# must be performed.

357

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

358

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the

359

# Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be

360

# used with RE2::FullMatch

361

},

362

},

363

"pathFilters": { # Set of filters to apply if `path` refers to array elements or nested array

364

# elements in order to narrow down to a single unique element that is being

365

# tested/modified.

366

# This is intended to be an exact match per filter. To perform advanced

367

# matching, use path_value_matchers.

368

#

369

# * Example: {

370

# "/versions/*/name" : "it-123"

371

# "/versions/*/targetSize/percent": 20

372

# }

373

# * Example: {

374

# "/bindings/*/role": "roles/admin"

375

# "/bindings/*/condition" : null

376

# }

377

# * Example: {

378

# "/bindings/*/role": "roles/admin"

379

# "/bindings/*/members/*" : ["x@google.com", "y@google.com"]

380

# }

381

# When both path_filters and path_value_matchers are set, an implicit AND

# must be performed.

"a_key": "",

},

"action": "A String", # Type of this operation. Contains one of 'and', 'remove', 'replace', 'move',

386

# 'copy', 'test' and custom operations. This field is case-insensitive and

387

# always populated.

388

"resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated.

389

# Example: cloudresourcemanager.googleapis.com/Project,

390

# compute.googleapis.com/Instance

391

"sourcePath": "A String", # Can be set with action 'copy' or 'move' to indicate the source field within

392

# resource or source_resource, ignored if provided for other operation types.

393

"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

394

# '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

396

# Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be

397

# used with RE2::FullMatch

398

},

399

"value": "", # Value for the `path` field. Will be set for actions:'add'/'replace'.

400

# Maybe set for action: 'test'. Either this or `value_matcher` will be set

401

# for 'test' operation. An exact match must be performed.

402

"sourceResource": "A String", # Can be set with action 'copy' to copy resource configuration across

403

# different resources of the same type. Example: A resource clone can be

404

# done via action = 'copy', path = "/", from = "/",

405

# source_resource = <source> and resource_name = <target>.

406

# This field is empty for all other values of `action`.

407

"resource": "A String", # Contains the fully qualified resource name. This field is always populated.

408

# ex: //cloudresourcemanager.googleapis.com/projects/foo.

409

"path": "A String", # Path to the target field being operated on. If the operation is at the

410

# resource level, then path should be "/". This field is always populated.

},

],

},

],

},

"additionalImpact": [ # Optional set of additional impact that this recommendation may have when

417

# trying to optimize for the primary category. These may be positive

418

# or negative.

419

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

420

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

421

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

422

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost

423

# units indicate cost savings and positive cost units indicate increase.

424

# See google.type.Money documentation for positive/negative units.

425

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

426

"nanos": 42, # Number of nano (10^-9) units of the amount.

427

# The value must be between -999,999,999 and +999,999,999 inclusive.

428

# If `units` is positive, `nanos` must be positive or zero.

429

# If `units` is zero, `nanos` can be positive, zero, or negative.

430

# If `units` is negative, `nanos` must be negative or zero.

431

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

432

"units": "A String", # The whole units of the amount.

433

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

434

},

435

},

436

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

437

},

438

],

439

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

440

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

441

# updating states.

442

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

443

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

444

"a_key": "A String",

445

},

446

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

447

},

448

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

449

{ # Reference to an associated insight.

450

"insight": "A String", # Insight resource name, e.g.

451

# projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]

},

],

},

],

"nextPageToken": "A String", # A token that can be used to request the next page of results. This field is

457

# empty if there are no additional results.

}</pre>

</div>

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

463

<pre>Retrieves the next page of results.

464

465

Args:

466

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

467

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

468

469

Returns:

470

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

471

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>

477

<pre>Marks the Recommendation State as Claimed. Users can use this method to

478

indicate to the Recommender API that they are starting to apply the

479

recommendation themselves. This stops the recommendation content from being

480

updated. Associated insights are frozen and placed in the ACCEPTED state.

481

482

MarkRecommendationClaimed can be applied to recommendations in CLAIMED,

483

SUCCEEDED, FAILED, or ACTIVE state.

484

485

Requires the recommender.*.update IAM permission for the specified

recommender.

Args:

body: object, The request body.

491

The object takes the form of:

492

493

{ # Request for the `MarkRecommendationClaimed` Method.

494

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

495

"stateMetadata": { # State properties to include with this state. Overwrites any existing

496

# `state_metadata`.

497

# Keys must match the regex /^a-z0-9{0,62}$/.

498

# Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.

"a_key": "A String",

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

510

511

{ # A recommendation along with a suggested action. E.g., a rightsizing

512

# recommendation for an underutilized VM, IAM role recommendations, etc

513

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

514

# optimize for one category.

515

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

516

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

517

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost

518

# units indicate cost savings and positive cost units indicate increase.

519

# See google.type.Money documentation for positive/negative units.

520

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

521

"nanos": 42, # Number of nano (10^-9) units of the amount.

522

# The value must be between -999,999,999 and +999,999,999 inclusive.

523

# If `units` is positive, `nanos` must be positive or zero.

524

# If `units` is zero, `nanos` can be positive, zero, or negative.

525

# If `units` is negative, `nanos` must be negative or zero.

526

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

527

"units": "A String", # The whole units of the amount.

528

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

529

},

530

},

531

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

532

},

533

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

534

# in the first place.

535

"recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the

536

# same recommender. Subtype is a function of content and impact, meaning a

537

# new subtype might be added when significant changes to `content` or

538

# `primary_impact.category` are introduced. See the Recommenders section

539

# to see a list of subtypes for a given Recommender.

540

#

541

# Examples:

542

# For recommender = "google.iam.policy.Recommender",

543

# recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE"

544

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

545

# characters.

546

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

547

"operationGroups": [ # Operations to one or more Google Cloud resources grouped in such a way

548

# that, all operations within one group are expected to be performed

549

# atomically and in an order.

550

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

551

"operations": [ # List of operations across one or more resources that belong to this group.

552

# Loosely based on RFC6902 and should be performed in the order they appear.

553

{ # Contains an operation for a resource loosely based on the JSON-PATCH format

554

# with support for:

555

#

556

# * Custom filters for describing partial array patch.

557

# * Extended path values for describing nested arrays.

558

# * Custom fields for describing the resource for which the operation is being

559

# described.

560

# * Allows extension to custom operations not natively supported by RFC6902.

561

# See https://tools.ietf.org/html/rfc6902 for details on the original RFC.

562

"pathValueMatchers": { # Similar to path_filters, this contains set of filters to apply if `path`

563

# field referes to array elements. This is meant to support value matching

564

# beyond exact match. To perform exact match, use path_filters.

565

# When both path_filters and path_value_matchers are set, an implicit AND

566

# must be performed.

567

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

568

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the

569

# Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be

570

# used with RE2::FullMatch

571

},

572

},

573

"pathFilters": { # Set of filters to apply if `path` refers to array elements or nested array

574

# elements in order to narrow down to a single unique element that is being

575

# tested/modified.

576

# This is intended to be an exact match per filter. To perform advanced

577

# matching, use path_value_matchers.

578

#

579

# * Example: {

580

# "/versions/*/name" : "it-123"

581

# "/versions/*/targetSize/percent": 20

582

# }

583

# * Example: {

584

# "/bindings/*/role": "roles/admin"

585

# "/bindings/*/condition" : null

586

# }

587

# * Example: {

588

# "/bindings/*/role": "roles/admin"

589

# "/bindings/*/members/*" : ["x@google.com", "y@google.com"]

590

# }

591

# When both path_filters and path_value_matchers are set, an implicit AND

# must be performed.

"a_key": "",

},

"action": "A String", # Type of this operation. Contains one of 'and', 'remove', 'replace', 'move',

596

# 'copy', 'test' and custom operations. This field is case-insensitive and

597

# always populated.

598

"resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated.

599

# Example: cloudresourcemanager.googleapis.com/Project,

600

# compute.googleapis.com/Instance

601

"sourcePath": "A String", # Can be set with action 'copy' or 'move' to indicate the source field within

602

# resource or source_resource, ignored if provided for other operation types.

603

"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

604

# 'path' field. Either this or `value` will be set for 'test' operation.

605

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the

606

# Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be

607

# used with RE2::FullMatch

608

},

609

"value": "", # Value for the `path` field. Will be set for actions:'add'/'replace'.

610

# Maybe set for action: 'test'. Either this or `value_matcher` will be set

611

# for 'test' operation. An exact match must be performed.

612

"sourceResource": "A String", # Can be set with action 'copy' to copy resource configuration across

613

# different resources of the same type. Example: A resource clone can be

614

# done via action = 'copy', path = "/", from = "/",

615

# source_resource = <source> and resource_name = <target>.

616

# This field is empty for all other values of `action`.

617

"resource": "A String", # Contains the fully qualified resource name. This field is always populated.

618

# ex: //cloudresourcemanager.googleapis.com/projects/foo.

619

"path": "A String", # Path to the target field being operated on. If the operation is at the

620

# resource level, then path should be "/". This field is always populated.

},

],

},

],

},

"additionalImpact": [ # Optional set of additional impact that this recommendation may have when

627

# trying to optimize for the primary category. These may be positive

628

# or negative.

629

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

630

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

631

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

632

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost

633

# units indicate cost savings and positive cost units indicate increase.

634

# See google.type.Money documentation for positive/negative units.

635

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

636

"nanos": 42, # Number of nano (10^-9) units of the amount.

637

# The value must be between -999,999,999 and +999,999,999 inclusive.

638

# If `units` is positive, `nanos` must be positive or zero.

639

# If `units` is zero, `nanos` can be positive, zero, or negative.

640

# If `units` is negative, `nanos` must be negative or zero.

641

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

642

"units": "A String", # The whole units of the amount.

643

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

644

},

645

},

646

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

647

},

648

],

649

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

650

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

651

# updating states.

652

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

653

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

654

"a_key": "A String",

655

},

656

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

657

},

658

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

659

{ # Reference to an associated insight.

660

"insight": "A String", # Insight resource name, e.g.

661

# projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]

},

],

}</pre>

</div>

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

669

<pre>Marks the Recommendation State as Failed. Users can use this method to

670

indicate to the Recommender API that they have applied the recommendation

671

themselves, and the operation failed. This stops the recommendation content

672

from being updated. Associated insights are frozen and placed in the

673

ACCEPTED state.

674

675

MarkRecommendationFailed can be applied to recommendations in ACTIVE,

676

CLAIMED, SUCCEEDED, or FAILED state.

677

678

Requires the recommender.*.update IAM permission for the specified

recommender.

Args:

body: object, The request body.

684

The object takes the form of:

685

686

{ # Request for the `MarkRecommendationFailed` Method.

687

"stateMetadata": { # State properties to include with this state. Overwrites any existing

688

# `state_metadata`.

689

# Keys must match the regex /^a-z0-9{0,62}$/.

690

# Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.

691

"a_key": "A String",

692

},

693

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

694

}

695

696

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

703

704

{ # A recommendation along with a suggested action. E.g., a rightsizing

705

# recommendation for an underutilized VM, IAM role recommendations, etc

706

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

707

# optimize for one category.

708

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

709

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

710

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost

711

# units indicate cost savings and positive cost units indicate increase.

712

# See google.type.Money documentation for positive/negative units.

713

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

714

"nanos": 42, # Number of nano (10^-9) units of the amount.

715

# The value must be between -999,999,999 and +999,999,999 inclusive.

716

# If `units` is positive, `nanos` must be positive or zero.

717

# If `units` is zero, `nanos` can be positive, zero, or negative.

718

# If `units` is negative, `nanos` must be negative or zero.

719

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

720

"units": "A String", # The whole units of the amount.

721

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

722

},

723

},

724

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

725

},

726

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

727

# in the first place.

728

"recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the

729

# same recommender. Subtype is a function of content and impact, meaning a

730

# new subtype might be added when significant changes to `content` or

731

# `primary_impact.category` are introduced. See the Recommenders section

732

# to see a list of subtypes for a given Recommender.

733

#

734

# Examples:

735

# For recommender = "google.iam.policy.Recommender",

736

# recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE"

737

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

738

# characters.

739

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

740

"operationGroups": [ # Operations to one or more Google Cloud resources grouped in such a way

741

# that, all operations within one group are expected to be performed

742

# atomically and in an order.

743

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

744

"operations": [ # List of operations across one or more resources that belong to this group.

745

# Loosely based on RFC6902 and should be performed in the order they appear.

746

{ # Contains an operation for a resource loosely based on the JSON-PATCH format

747

# with support for:

748

#

749

# * Custom filters for describing partial array patch.

750

# * Extended path values for describing nested arrays.

751

# * Custom fields for describing the resource for which the operation is being

752

# described.

753

# * Allows extension to custom operations not natively supported by RFC6902.

754

# See https://tools.ietf.org/html/rfc6902 for details on the original RFC.

755

"pathValueMatchers": { # Similar to path_filters, this contains set of filters to apply if `path`

756

# field referes to array elements. This is meant to support value matching

757

# beyond exact match. To perform exact match, use path_filters.

758

# When both path_filters and path_value_matchers are set, an implicit AND

759

# must be performed.

760

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

761

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the

762

# Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be

763

# used with RE2::FullMatch

764

},

765

},

766

"pathFilters": { # Set of filters to apply if `path` refers to array elements or nested array

767

# elements in order to narrow down to a single unique element that is being

768

# tested/modified.

769

# This is intended to be an exact match per filter. To perform advanced

770

# matching, use path_value_matchers.

771

#

772

# * Example: {

773

# "/versions/*/name" : "it-123"

774

# "/versions/*/targetSize/percent": 20

775

# }

776

# * Example: {

777

# "/bindings/*/role": "roles/admin"

778

# "/bindings/*/condition" : null

779

# }

780

# * Example: {

781

# "/bindings/*/role": "roles/admin"

782

# "/bindings/*/members/*" : ["x@google.com", "y@google.com"]

783

# }

784

# When both path_filters and path_value_matchers are set, an implicit AND

# must be performed.

"a_key": "",

},

"action": "A String", # Type of this operation. Contains one of 'and', 'remove', 'replace', 'move',

789

# 'copy', 'test' and custom operations. This field is case-insensitive and

790

# always populated.

791

"resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated.

792

# Example: cloudresourcemanager.googleapis.com/Project,

793

# compute.googleapis.com/Instance

794

"sourcePath": "A String", # Can be set with action 'copy' or 'move' to indicate the source field within

795

# resource or source_resource, ignored if provided for other operation types.

796

"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

797

# 'path' field. Either this or `value` will be set for 'test' operation.

798

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the

799

# Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be

800

# used with RE2::FullMatch

801

},

802

"value": "", # Value for the `path` field. Will be set for actions:'add'/'replace'.

803

# Maybe set for action: 'test'. Either this or `value_matcher` will be set

804

# for 'test' operation. An exact match must be performed.

805

"sourceResource": "A String", # Can be set with action 'copy' to copy resource configuration across

806

# different resources of the same type. Example: A resource clone can be

807

# done via action = 'copy', path = "/", from = "/",

808

# source_resource = <source> and resource_name = <target>.

809

# This field is empty for all other values of `action`.

810

"resource": "A String", # Contains the fully qualified resource name. This field is always populated.

811

# ex: //cloudresourcemanager.googleapis.com/projects/foo.

812

"path": "A String", # Path to the target field being operated on. If the operation is at the

813

# resource level, then path should be "/". This field is always populated.

},

],

},

],

},

"additionalImpact": [ # Optional set of additional impact that this recommendation may have when

820

# trying to optimize for the primary category. These may be positive

821

# or negative.

822

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

823

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

824

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

825

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost

826

# units indicate cost savings and positive cost units indicate increase.

827

# See google.type.Money documentation for positive/negative units.

828

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

829

"nanos": 42, # Number of nano (10^-9) units of the amount.

830

# The value must be between -999,999,999 and +999,999,999 inclusive.

831

# If `units` is positive, `nanos` must be positive or zero.

832

# If `units` is zero, `nanos` can be positive, zero, or negative.

833

# If `units` is negative, `nanos` must be negative or zero.

834

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

835

"units": "A String", # The whole units of the amount.

836

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

837

},

838

},

839

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

840

},

841

],

842

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

843

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

844

# updating states.

845

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

846

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

847

"a_key": "A String",

848

},

849

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

850

},

851

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

852

{ # Reference to an associated insight.

853

"insight": "A String", # Insight resource name, e.g.

854

# projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]

},

],

}</pre>

</div>

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

862

<pre>Marks the Recommendation State as Succeeded. Users can use this method to

863

indicate to the Recommender API that they have applied the recommendation

864

themselves, and the operation was successful. This stops the recommendation

865

content from being updated. Associated insights are frozen and placed in

866

the ACCEPTED state.

867

868

MarkRecommendationSucceeded can be applied to recommendations in ACTIVE,

869

CLAIMED, SUCCEEDED, or FAILED state.

870

871

Requires the recommender.*.update IAM permission for the specified

recommender.

Args:

body: object, The request body.

877

The object takes the form of:

878

879

{ # Request for the `MarkRecommendationSucceeded` Method.

880

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

881

"stateMetadata": { # State properties to include with this state. Overwrites any existing

882

# `state_metadata`.

883

# Keys must match the regex /^a-z0-9{0,62}$/.

884

# Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/.

"a_key": "A String",

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

896

897

{ # A recommendation along with a suggested action. E.g., a rightsizing

898

# recommendation for an underutilized VM, IAM role recommendations, etc

899

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

900

# optimize for one category.

901

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

902

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

903

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost

904

# units indicate cost savings and positive cost units indicate increase.

905

# See google.type.Money documentation for positive/negative units.

906

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

907

"nanos": 42, # Number of nano (10^-9) units of the amount.

908

# The value must be between -999,999,999 and +999,999,999 inclusive.

909

# If `units` is positive, `nanos` must be positive or zero.

910

# If `units` is zero, `nanos` can be positive, zero, or negative.

911

# If `units` is negative, `nanos` must be negative or zero.

912

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

913

"units": "A String", # The whole units of the amount.

914

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

915

},

916

},

917

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

918

},

919

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

920

# in the first place.

921

"recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the

922

# same recommender. Subtype is a function of content and impact, meaning a

923

# new subtype might be added when significant changes to `content` or

924

# `primary_impact.category` are introduced. See the Recommenders section

925

# to see a list of subtypes for a given Recommender.

926

#

927

# Examples:

928

# For recommender = "google.iam.policy.Recommender",

929

# recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE"

930

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

931

# characters.

932

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

933

"operationGroups": [ # Operations to one or more Google Cloud resources grouped in such a way

934

# that, all operations within one group are expected to be performed

935

# atomically and in an order.

936

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

937

"operations": [ # List of operations across one or more resources that belong to this group.

938

# Loosely based on RFC6902 and should be performed in the order they appear.

939

{ # Contains an operation for a resource loosely based on the JSON-PATCH format

940

# with support for:

941

#

942

# * Custom filters for describing partial array patch.

943

# * Extended path values for describing nested arrays.

944

# * Custom fields for describing the resource for which the operation is being

945

# described.

946

# * Allows extension to custom operations not natively supported by RFC6902.

947

# See https://tools.ietf.org/html/rfc6902 for details on the original RFC.

948

"pathValueMatchers": { # Similar to path_filters, this contains set of filters to apply if `path`

949

# field referes to array elements. This is meant to support value matching

950

# beyond exact match. To perform exact match, use path_filters.

951

# When both path_filters and path_value_matchers are set, an implicit AND

952

# must be performed.

953

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

954

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the

955

# Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be

956

# used with RE2::FullMatch

957

},

958

},

959

"pathFilters": { # Set of filters to apply if `path` refers to array elements or nested array

960

# elements in order to narrow down to a single unique element that is being

961

# tested/modified.

962

# This is intended to be an exact match per filter. To perform advanced

963

# matching, use path_value_matchers.

964

#

965

# * Example: {

966

# "/versions/*/name" : "it-123"

967

# "/versions/*/targetSize/percent": 20

968

# }

969

# * Example: {

970

# "/bindings/*/role": "roles/admin"

971

# "/bindings/*/condition" : null

972

# }

973

# * Example: {

974

# "/bindings/*/role": "roles/admin"

975

# "/bindings/*/members/*" : ["x@google.com", "y@google.com"]

976

# }

977

# When both path_filters and path_value_matchers are set, an implicit AND

# must be performed.

"a_key": "",

},

"action": "A String", # Type of this operation. Contains one of 'and', 'remove', 'replace', 'move',

982

# 'copy', 'test' and custom operations. This field is case-insensitive and

983

# always populated.

984

"resourceType": "A String", # Type of GCP resource being modified/tested. This field is always populated.

985

# Example: cloudresourcemanager.googleapis.com/Project,

986

# compute.googleapis.com/Instance

987

"sourcePath": "A String", # Can be set with action 'copy' or 'move' to indicate the source field within

988

# resource or source_resource, ignored if provided for other operation types.

989

"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

990

# 'path' field. Either this or `value` will be set for 'test' operation.

991

"matchesPattern": "A String", # To be used for full regex matching. The regular expression is using the

992

# Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be

993

# used with RE2::FullMatch

994

},

995

"value": "", # Value for the `path` field. Will be set for actions:'add'/'replace'.

996

# Maybe set for action: 'test'. Either this or `value_matcher` will be set

997

# for 'test' operation. An exact match must be performed.

998

"sourceResource": "A String", # Can be set with action 'copy' to copy resource configuration across

999

# different resources of the same type. Example: A resource clone can be

1000

# done via action = 'copy', path = "/", from = "/",

1001

# source_resource = <source> and resource_name = <target>.

1002

# This field is empty for all other values of `action`.

1003

"resource": "A String", # Contains the fully qualified resource name. This field is always populated.

1004

# ex: //cloudresourcemanager.googleapis.com/projects/foo.

1005

"path": "A String", # Path to the target field being operated on. If the operation is at the

1006

# resource level, then path should be "/". This field is always populated.

},

],

},

],

},

"additionalImpact": [ # Optional set of additional impact that this recommendation may have when

1013

# trying to optimize for the primary category. These may be positive

1014

# or negative.

1015

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

1016

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

1017

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

1018

"cost": { # Represents an amount of money with its currency type. # An approximate projection on amount saved or amount incurred. Negative cost

1019

# units indicate cost savings and positive cost units indicate increase.

1020

# See google.type.Money documentation for positive/negative units.

1021

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

1022

"nanos": 42, # Number of nano (10^-9) units of the amount.

1023

# The value must be between -999,999,999 and +999,999,999 inclusive.

1024

# If `units` is positive, `nanos` must be positive or zero.

1025

# If `units` is zero, `nanos` can be positive, zero, or negative.

1026

# If `units` is negative, `nanos` must be negative or zero.

1027

# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

1028

"units": "A String", # The whole units of the amount.

1029

# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

1030

},

1031

},

1032

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

1033

},

1034

],

1035

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

1036

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

1037

# updating states.

1038

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

1039

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

1040

"a_key": "A String",

1041

},

1042

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

1043

},

1044

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

1045

{ # Reference to an associated insight.

1046

"insight": "A String", # Insight resource name, e.g.

1047

# projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]

},

],

}</pre>

</div>

</body></html>