Interface PolicySpecOrBuilder (2.45.0)

Version 2.45.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.7-SNAPSHOT
• 2.2.1
• 2.1.2
• 2.0.10

public interface PolicySpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEtag()

public abstract String getEtag()

An opaque tag indicating the current version of the policySpec, used for concurrency control.

This field is ignored if used in a CreatePolicy request.

When the policy is returned from either a GetPolicy or a ListPolicies request, this etag indicates the version of the current policySpec to use when executing a read-modify-write loop.

When the policy is returned from a GetEffectivePolicy request, the etag will be unset.

string etag = 1;

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

An opaque tag indicating the current version of the policySpec, used for concurrency control.

This field is ignored if used in a CreatePolicy request.

When the policy is returned from either a GetPolicy or a ListPolicies request, this etag indicates the version of the current policySpec to use when executing a read-modify-write loop.

When the policy is returned from a GetEffectivePolicy request, the etag will be unset.

string etag = 1;

Returns
Type	Description
ByteString	The bytes for etag.

getInheritFromParent()

public abstract boolean getInheritFromParent()

Determines the inheritance behavior for this policy.

If inherit_from_parent is true, policy rules set higher up in the hierarchy (up to the closest root) are inherited and present in the effective policy. If it is false, then no rules are inherited, and this policy becomes the new root for evaluation. This field can be set only for policies which configure list constraints.

bool inherit_from_parent = 4;

Returns
Type	Description
boolean	The inheritFromParent.

getReset()

public abstract boolean getReset()

Ignores policies set above this resource and restores the constraint_default enforcement behavior of the specific constraint at this resource. This field can be set in policies for either list or boolean constraints. If set, rules must be empty and inherit_from_parent must be set to false.

bool reset = 5;

Returns
Type	Description
boolean	The reset.

getRules(int index)

public abstract PolicySpec.PolicyRule getRules(int index)

In policies for boolean constraints, the following requirements apply:

• There must be one and only one policy rule where condition is unset.
• Boolean policy rules with conditions must set enforced to the opposite of the policy rule without a condition.
• During policy evaluation, policy rules with conditions that are true for a target resource take precedence.

repeated .google.cloud.orgpolicy.v2.PolicySpec.PolicyRule rules = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
PolicySpec.PolicyRule

getRulesCount()

public abstract int getRulesCount()

In policies for boolean constraints, the following requirements apply:

• There must be one and only one policy rule where condition is unset.
• Boolean policy rules with conditions must set enforced to the opposite of the policy rule without a condition.
• During policy evaluation, policy rules with conditions that are true for a target resource take precedence.

repeated .google.cloud.orgpolicy.v2.PolicySpec.PolicyRule rules = 3;

Returns
Type	Description
int

getRulesList()

public abstract List<PolicySpec.PolicyRule> getRulesList()

In policies for boolean constraints, the following requirements apply:

• There must be one and only one policy rule where condition is unset.
• Boolean policy rules with conditions must set enforced to the opposite of the policy rule without a condition.
• During policy evaluation, policy rules with conditions that are true for a target resource take precedence.

repeated .google.cloud.orgpolicy.v2.PolicySpec.PolicyRule rules = 3;

Returns
Type	Description
List<PolicyRule>

getRulesOrBuilder(int index)

public abstract PolicySpec.PolicyRuleOrBuilder getRulesOrBuilder(int index)

In policies for boolean constraints, the following requirements apply:

• There must be one and only one policy rule where condition is unset.
• Boolean policy rules with conditions must set enforced to the opposite of the policy rule without a condition.
• During policy evaluation, policy rules with conditions that are true for a target resource take precedence.

repeated .google.cloud.orgpolicy.v2.PolicySpec.PolicyRule rules = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
PolicySpec.PolicyRuleOrBuilder

getRulesOrBuilderList()

public abstract List<? extends PolicySpec.PolicyRuleOrBuilder> getRulesOrBuilderList()

In policies for boolean constraints, the following requirements apply:

• There must be one and only one policy rule where condition is unset.
• Boolean policy rules with conditions must set enforced to the opposite of the policy rule without a condition.
• During policy evaluation, policy rules with conditions that are true for a target resource take precedence.

repeated .google.cloud.orgpolicy.v2.PolicySpec.PolicyRule rules = 3;

Returns
Type	Description
List<? extends com.google.cloud.orgpolicy.v2.PolicySpec.PolicyRuleOrBuilder>

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time stamp this was previously updated. This represents the last time a call to CreatePolicy or UpdatePolicy was made for that policy.

.google.protobuf.Timestamp update_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time stamp this was previously updated. This represents the last time a call to CreatePolicy or UpdatePolicy was made for that policy.

.google.protobuf.Timestamp update_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time stamp this was previously updated. This represents the last time a call to CreatePolicy or UpdatePolicy was made for that policy.

.google.protobuf.Timestamp update_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.