Class PolicySpec.Builder (2.43.0) 

public static final class PolicySpec.Builder extends GeneratedMessageV3.Builder<PolicySpec.Builder> implements PolicySpecOrBuilder

Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources.

Protobuf type google.cloud.orgpolicy.v2.PolicySpec

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PolicySpec.Builder

Implements

PolicySpecOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllRules(Iterable<? extends PolicySpec.PolicyRule> values)

public PolicySpec.Builder addAllRules(Iterable<? extends PolicySpec.PolicyRule> values)

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
values Iterable<? extends com.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule>
Returns
Type Description
PolicySpec.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PolicySpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PolicySpec.Builder
Overrides

addRules(PolicySpec.PolicyRule value)

public PolicySpec.Builder addRules(PolicySpec.PolicyRule value)

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
value PolicySpec.PolicyRule
Returns
Type Description
PolicySpec.Builder

addRules(PolicySpec.PolicyRule.Builder builderForValue)

public PolicySpec.Builder addRules(PolicySpec.PolicyRule.Builder builderForValue)

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
builderForValue PolicySpec.PolicyRule.Builder
Returns
Type Description
PolicySpec.Builder

addRules(int index, PolicySpec.PolicyRule value)

public PolicySpec.Builder addRules(int index, PolicySpec.PolicyRule value)

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;

Parameters
Name Description
index int
value PolicySpec.PolicyRule
Returns
Type Description
PolicySpec.Builder

addRules(int index, PolicySpec.PolicyRule.Builder builderForValue)

public PolicySpec.Builder addRules(int index, PolicySpec.PolicyRule.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue PolicySpec.PolicyRule.Builder
Returns
Type Description
PolicySpec.Builder

addRulesBuilder()

public PolicySpec.PolicyRule.Builder addRulesBuilder()

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
PolicySpec.PolicyRule.Builder

addRulesBuilder(int index)

public PolicySpec.PolicyRule.Builder addRulesBuilder(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.Builder

build()

public PolicySpec build()
Returns
Type Description
PolicySpec

buildPartial()

public PolicySpec buildPartial()
Returns
Type Description
PolicySpec

clear()

public PolicySpec.Builder clear()
Returns
Type Description
PolicySpec.Builder
Overrides

clearEtag()

public PolicySpec.Builder clearEtag()

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
PolicySpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PolicySpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PolicySpec.Builder
Overrides

clearInheritFromParent()

public PolicySpec.Builder clearInheritFromParent()

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
PolicySpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PolicySpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PolicySpec.Builder
Overrides

clearReset()

public PolicySpec.Builder clearReset()

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
PolicySpec.Builder

This builder for chaining.

clearRules()

public PolicySpec.Builder clearRules()

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
PolicySpec.Builder

clearUpdateTime()

public PolicySpec.Builder clearUpdateTime()

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
PolicySpec.Builder

clone()

public PolicySpec.Builder clone()
Returns
Type Description
PolicySpec.Builder
Overrides

getDefaultInstanceForType()

public PolicySpec getDefaultInstanceForType()
Returns
Type Description
PolicySpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEtag()

public 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 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 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 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 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

getRulesBuilder(int index)

public PolicySpec.PolicyRule.Builder getRulesBuilder(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.Builder

getRulesBuilderList()

public List<PolicySpec.PolicyRule.Builder> getRulesBuilderList()

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<Builder>

getRulesCount()

public 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 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 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 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 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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

getUpdateTimeOrBuilder()

public 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PolicySpec other)

public PolicySpec.Builder mergeFrom(PolicySpec other)
Parameter
Name Description
other PolicySpec
Returns
Type Description
PolicySpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PolicySpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PolicySpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PolicySpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PolicySpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PolicySpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PolicySpec.Builder
Overrides

mergeUpdateTime(Timestamp value)

public PolicySpec.Builder mergeUpdateTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
PolicySpec.Builder

removeRules(int index)

public PolicySpec.Builder removeRules(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.Builder

setEtag(String value)

public PolicySpec.Builder setEtag(String value)

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;

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
PolicySpec.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public PolicySpec.Builder setEtagBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for etag to set.
Returns
Type Description
PolicySpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PolicySpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PolicySpec.Builder
Overrides

setInheritFromParent(boolean value)

public PolicySpec.Builder setInheritFromParent(boolean value)

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;

Parameter
Name Description
value boolean

The inheritFromParent to set.
Returns
Type Description
PolicySpec.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PolicySpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PolicySpec.Builder
Overrides

setReset(boolean value)

public PolicySpec.Builder setReset(boolean value)

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;

Parameter
Name Description
value boolean

The reset to set.
Returns
Type Description
PolicySpec.Builder

This builder for chaining.

setRules(int index, PolicySpec.PolicyRule value)

public PolicySpec.Builder setRules(int index, PolicySpec.PolicyRule value)

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;

Parameters
Name Description
index int
value PolicySpec.PolicyRule
Returns
Type Description
PolicySpec.Builder

setRules(int index, PolicySpec.PolicyRule.Builder builderForValue)

public PolicySpec.Builder setRules(int index, PolicySpec.PolicyRule.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue PolicySpec.PolicyRule.Builder
Returns
Type Description
PolicySpec.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final PolicySpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PolicySpec.Builder
Overrides

setUpdateTime(Timestamp value)

public PolicySpec.Builder setUpdateTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
PolicySpec.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public PolicySpec.Builder setUpdateTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PolicySpec.Builder