Google Cloud Backup Dr V1beta Client - Class AutoProtectionPolicyBinding (0.15.1)

Reference documentation and code samples for the Google Cloud Backup Dr V1beta Client class AutoProtectionPolicyBinding.

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

Generated from protobuf message google.cloud.backupdr.v1beta.AutoProtectionPolicyBinding

Namespace

Google \ Cloud \ BackupDR \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ description string

Optional. A description of the binding.

↳ state int

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

↳ binding_evaluation_summary BindingEvaluationSummary

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

↳ create_time Google\Protobuf\Timestamp

Output only. The timestamp when the binding was created.

↳ update_time Google\Protobuf\Timestamp

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

↳ etag string

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

getName

Identifier. The resource name of the AutoProtectionPolicyBinding.

Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}

Returns
Type Description
string

setName

Identifier. The resource name of the AutoProtectionPolicyBinding.

Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. A description of the binding.

Returns
Type Description
string

setDescription

Optional. A description of the binding.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The current state of the AutoProtectionPolicyBinding.

Returns
Type Description
int Enum of type State.

setState

Output only. The current state of the AutoProtectionPolicyBinding.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getScope

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

Returns
Type Description
string

setScope

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

Parameter
Name Description
var string
Returns
Type Description
$this

getBindingEvaluationSummary

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

Returns
Type Description
BindingEvaluationSummary|null

hasBindingEvaluationSummary

clearBindingEvaluationSummary

setBindingEvaluationSummary

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

Parameter
Name Description
var BindingEvaluationSummary
Returns
Type Description
$this

getCreateTime

Output only. The timestamp when the binding was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when the binding was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEtag

Optional. Output only. The etag for the binding.

If this is provided on update, it must match the server's etag.

Returns
Type Description
string

setEtag

Optional. Output only. The etag for the binding.

If this is provided on update, it must match the server's etag.

Parameter
Name Description
var string
Returns
Type Description
$this