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

<h1><a href="recommender_v1beta1.html">Recommender API</a> . <a href="recommender_v1beta1.projects.html">projects</a> . <a href="recommender_v1beta1.projects.locations.html">locations</a> . <a href="recommender_v1beta1.projects.locations.recommenders.html">recommenders</a> . <a href="recommender_v1beta1.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, pageSize=None, pageToken=None, filter=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

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

114

{ # Reference to an associated insight.

115

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

116

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

117

},

118

],

119

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

120

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

121

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

122

# atomically and in an order.

123

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

124

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

125

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

126

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

127

# with support for:

128

#

129

# * Custom filters for describing partial array patch.

130

# * Extended path values for describing nested arrays.

131

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

132

# described.

133

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

134

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

135

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

136

# Example: cloudresourcemanager.googleapis.com/Project,

137

# compute.googleapis.com/Instance

138

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

139

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

140

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

141

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

142

# tested/modified.

143

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

144

# matching, use path_value_matchers.

145

#

146

# * Example: {

147

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

148

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

149

# }

150

# * Example: {

151

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

152

# "/bindings/*/condition" : null

153

# }

154

# * Example: {

155

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

156

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

157

# }

158

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

# must be performed.

"a_key": "",

},

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

163

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

164

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

165

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

166

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

167

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

168

# must be performed.

169

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

170

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

171

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

172

# used with RE2::FullMatch

173

},

174

},

175

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

176

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

177

# always populated.

178

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

179

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

180

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

181

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

182

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

183

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

184

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

185

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

186

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

187

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

188

"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

189

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

190

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

191

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

192

# used with RE2::FullMatch

},

},

],

},

],

},

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

200

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

201

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

202

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

203

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

204

#

205

# Examples:

206

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

207

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

208

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

209

# updating states.

210

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

211

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

212

# optimize for one category.

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

},

},

},

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

232

# characters.

233

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

234

# in the first place.

235

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

236

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

237

# or negative.

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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

252

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

253

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

},

},

},

],

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

259

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

260

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

"a_key": "A String",

},

},

}</pre>

</div>

<code class="details" id="list">list(parent, pageSize=None, pageToken=None, filter=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

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

282

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

283

of results to return.

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

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

289

filter fields: state_info.state

290

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

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

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

301

# empty if there are no additional results.

302

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

303

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

304

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

305

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

306

{ # Reference to an associated insight.

307

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

308

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

309

},

310

],

311

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

312

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

313

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

314

# atomically and in an order.

315

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

316

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

317

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

318

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

319

# with support for:

320

#

321

# * Custom filters for describing partial array patch.

322

# * Extended path values for describing nested arrays.

323

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

324

# described.

325

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

326

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

327

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

328

# Example: cloudresourcemanager.googleapis.com/Project,

329

# compute.googleapis.com/Instance

330

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

331

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

332

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

333

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

334

# tested/modified.

335

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

336

# matching, use path_value_matchers.

337

#

338

# * Example: {

339

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

340

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

341

# }

342

# * Example: {

343

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

344

# "/bindings/*/condition" : null

345

# }

346

# * Example: {

347

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

348

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

349

# }

350

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

# must be performed.

"a_key": "",

},

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

355

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

356

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

357

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

358

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

359

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

360

# must be performed.

361

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

362

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

363

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

364

# used with RE2::FullMatch

365

},

366

},

367

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

368

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

369

# always populated.

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

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

378

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

379

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

380

"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

381

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

382

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

383

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

384

# used with RE2::FullMatch

},

},

],

},

],

},

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

392

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

393

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

394

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

395

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

396

#

397

# Examples:

398

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

399

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

400

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

401

# updating states.

402

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

403

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

404

# optimize for one category.

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

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

414

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

415

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

416

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

417

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

418

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

419

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

},

},

},

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

424

# characters.

425

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

426

# in the first place.

427

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

428

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

429

# or negative.

430

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

431

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

432

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

433

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

434

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

435

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

436

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

437

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

438

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

439

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

440

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

441

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

442

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

443

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

444

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

445

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

},

},

},

],

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

451

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

452

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

"a_key": "A String",

},

},

},

],

}</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 or

483

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

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

514

{ # Reference to an associated insight.

515

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

516

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

517

},

518

],

519

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

520

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

521

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

522

# atomically and in an order.

523

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

524

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

525

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

526

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

527

# with support for:

528

#

529

# * Custom filters for describing partial array patch.

530

# * Extended path values for describing nested arrays.

531

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

532

# described.

533

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

534

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

535

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

536

# Example: cloudresourcemanager.googleapis.com/Project,

537

# compute.googleapis.com/Instance

538

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

539

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

540

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

541

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

542

# tested/modified.

543

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

544

# matching, use path_value_matchers.

545

#

546

# * Example: {

547

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

548

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

549

# }

550

# * Example: {

551

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

552

# "/bindings/*/condition" : null

553

# }

554

# * Example: {

555

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

556

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

557

# }

558

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

# must be performed.

"a_key": "",

},

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

563

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

564

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

565

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

566

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

567

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

568

# must be performed.

569

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

570

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

571

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

572

# used with RE2::FullMatch

573

},

574

},

575

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

576

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

577

# always populated.

578

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

579

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

580

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

581

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

582

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

583

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

584

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

585

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

586

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

587

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

588

"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

589

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

590

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

591

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

592

# used with RE2::FullMatch

},

},

],

},

],

},

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

600

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

601

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

602

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

603

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

604

#

605

# Examples:

606

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

607

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

608

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

609

# updating states.

610

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

611

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

612

# optimize for one category.

613

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

614

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

615

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

616

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

617

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

618

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

619

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

620

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

621

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

622

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

623

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

624

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

625

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

626

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

627

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

},

},

},

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

632

# characters.

633

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

634

# in the first place.

635

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

636

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

637

# or negative.

638

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

639

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

640

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

641

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

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

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

653

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

},

},

},

],

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

659

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

660

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

"a_key": "A String",

},

},

}</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

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

688

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

689

# `state_metadata`.

690

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

691

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

703

704

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

705

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

706

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

707

{ # Reference to an associated insight.

708

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

709

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

710

},

711

],

712

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

713

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

714

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

715

# atomically and in an order.

716

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

717

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

718

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

719

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

720

# with support for:

721

#

722

# * Custom filters for describing partial array patch.

723

# * Extended path values for describing nested arrays.

724

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

725

# described.

726

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

727

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

728

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

729

# Example: cloudresourcemanager.googleapis.com/Project,

730

# compute.googleapis.com/Instance

731

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

732

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

733

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

734

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

735

# tested/modified.

736

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

737

# matching, use path_value_matchers.

738

#

739

# * Example: {

740

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

741

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

742

# }

743

# * Example: {

744

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

745

# "/bindings/*/condition" : null

746

# }

747

# * Example: {

748

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

749

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

750

# }

751

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

# must be performed.

"a_key": "",

},

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

756

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

757

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

758

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

759

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

760

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

761

# must be performed.

762

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

763

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

764

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

765

# used with RE2::FullMatch

766

},

767

},

768

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

769

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

770

# always populated.

771

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

772

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

773

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

774

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

775

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

776

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

777

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

778

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

779

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

780

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

781

"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

782

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

783

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

784

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

785

# used with RE2::FullMatch

},

},

],

},

],

},

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

793

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

794

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

795

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

796

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

797

#

798

# Examples:

799

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

800

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

801

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

802

# updating states.

803

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

804

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

805

# optimize for one category.

806

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

807

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

808

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

809

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

810

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

811

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

812

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

813

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

814

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

815

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

816

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

817

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

818

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

819

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

820

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

},

},

},

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

825

# characters.

826

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

827

# in the first place.

828

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

829

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

830

# or negative.

831

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

832

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

833

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

834

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

835

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

836

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

837

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

838

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

839

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

840

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

841

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

842

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

843

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

844

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

845

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

846

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

},

},

},

],

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

852

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

853

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

"a_key": "A String",

},

},

}</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

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

900

{ # Reference to an associated insight.

901

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

902

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

903

},

904

],

905

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

906

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

907

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

908

# atomically and in an order.

909

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

910

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

911

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

912

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

913

# with support for:

914

#

915

# * Custom filters for describing partial array patch.

916

# * Extended path values for describing nested arrays.

917

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

918

# described.

919

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

920

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

921

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

922

# Example: cloudresourcemanager.googleapis.com/Project,

923

# compute.googleapis.com/Instance

924

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

925

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

926

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

927

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

928

# tested/modified.

929

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

930

# matching, use path_value_matchers.

931

#

932

# * Example: {

933

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

934

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

935

# }

936

# * Example: {

937

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

938

# "/bindings/*/condition" : null

939

# }

940

# * Example: {

941

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

942

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

943

# }

944

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

# must be performed.

"a_key": "",

},

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

949

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

950

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

951

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

952

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

953

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

954

# must be performed.

955

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

956

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

957

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

958

# used with RE2::FullMatch

959

},

960

},

961

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

962

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

963

# always populated.

964

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

965

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

966

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

967

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

968

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

969

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

970

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

971

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

972

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

973

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

974

"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

975

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

976

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

977

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

978

# used with RE2::FullMatch

},

},

],

},

],

},

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

986

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

987

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

988

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

989

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

990

#

991

# Examples:

992

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

993

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

994

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

995

# updating states.

996

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

997

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

998

# optimize for one category.

999

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

1000

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

1001

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

1002

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

1003

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

1004

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

1005

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

1006

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

1007

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

1008

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

1009

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

1010

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

1011

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

1012

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

1013

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

},

},

},

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

1018

# characters.

1019

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

1020

# in the first place.

1021

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

1022

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

1023

# or negative.

1024

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

1025

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

1026

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

1027

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

1028

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

1029

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

1030

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

1031

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

1032

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

1033

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

1034

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

1035

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

1036

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

1037

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

1038

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

1039

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

},

},

},

],

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

1045

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

1046

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

"a_key": "A String",

},

},

}</pre>

</div>

</body></html>