REST Resource: projects.locations.autoProtectionPolicies.bindings

Resource: AutoProtectionPolicyBinding

An AutoprotectionPolicyBinding (APPA) acts as the bridge between an AutoprotectionPolicy and the scope (Project, Folder, or Organization) where the policy should be applied.

JSON representation
{
  "name": string,
  "description": string,
  "state": enum (State),
  "scope": string,
  "bindingEvaluationSummary": {
    object (BindingEvaluationSummary)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string
}
Fields
name

string

Identifier. The resource name of the AutoProtectionPolicyBinding. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{autoProtectionPolicy}/bindings/{binding}

description

string

Optional. A description of the binding.

state

enum (State)

Output only. The current state of the AutoProtectionPolicyBinding.

scope

string

Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{projectId}

bindingEvaluationSummary

object (BindingEvaluationSummary)

Output only. Summaries of the last policy application when the job has run, with one entry per resource type specified in the AutoProtectionPolicy.

createTime

string (Timestamp format)

Output only. The timestamp when the binding was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The timestamp when the binding was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

etag

string

Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag.

State

The state of an AutoProtectionPolicyBinding.

Enums
STATE_UNSPECIFIED The state of the binding is unspecified.
CREATING The binding is being created.
ACTIVE The binding is active.
DELETION_INITIATED The binding deletion is initiated.

BindingEvaluationSummary

BindingEvaluationSummary contains the summary of the last run of job that applies policy to matching resources for a given binding.

JSON representation
{
  "matchingResourceCount": string,
  "protectedResourceCount": string,
  "failedResourceCount": string
}
Fields
matchingResourceCount

string (int64 format)

Output only. The number of resources that currently match the policy's criteria.

protectedResourceCount

string (int64 format)

Output only. The number of matching resources that are successfully protected.

failedResourceCount

string (int64 format)

Output only. The number of matching resources whose protection failed during job run.

Methods

create

Creates a new AutoProtectionPolicyBinding in a given project and location.

get

Returns the auto protection policy binding read from the CCFE tables.

initiateDelete

InitiateDeleteAutoProtectionPolicyBinding initiates delete for AutoProtectionPolicy Binding

list

Returns the auto protection policy bindings read from the CCFE tables.