Class PolicySpec.Builder (2.1.2)

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

Defines a Cloud Organization PolicySpec which is used to specify Constraints for configurations of Cloud Platform resources.

Protobuf type google.cloud.orgpolicy.v2.PolicySpec

Implements

PolicySpecOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

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

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

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule>
Returns
TypeDescription
PolicySpec.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PolicySpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PolicySpec.Builder
Overrides

addRules(PolicySpec.PolicyRule value)

public PolicySpec.Builder addRules(PolicySpec.PolicyRule value)

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Parameter
NameDescription
valuePolicySpec.PolicyRule
Returns
TypeDescription
PolicySpec.Builder

addRules(PolicySpec.PolicyRule.Builder builderForValue)

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

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Parameter
NameDescription
builderForValuePolicySpec.PolicyRule.Builder
Returns
TypeDescription
PolicySpec.Builder

addRules(int index, PolicySpec.PolicyRule value)

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

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Parameters
NameDescription
indexint
valuePolicySpec.PolicyRule
Returns
TypeDescription
PolicySpec.Builder

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

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

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Parameters
NameDescription
indexint
builderForValuePolicySpec.PolicyRule.Builder
Returns
TypeDescription
PolicySpec.Builder

addRulesBuilder()

public PolicySpec.PolicyRule.Builder addRulesBuilder()

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Returns
TypeDescription
PolicySpec.PolicyRule.Builder

addRulesBuilder(int index)

public PolicySpec.PolicyRule.Builder addRulesBuilder(int index)

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PolicySpec.PolicyRule.Builder

build()

public PolicySpec build()
Returns
TypeDescription
PolicySpec

buildPartial()

public PolicySpec buildPartial()
Returns
TypeDescription
PolicySpec

clear()

public PolicySpec.Builder clear()
Returns
TypeDescription
PolicySpec.Builder
Overrides

clearEtag()

public PolicySpec.Builder clearEtag()

An opaque tag indicating the current version of the Policy, 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 Policy 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
TypeDescription
PolicySpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PolicySpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PolicySpec.Builder
Overrides

clearInheritFromParent()

public PolicySpec.Builder clearInheritFromParent()

Determines the inheritance behavior for this Policy. If inherit_from_parent is true, PolicyRules 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
TypeDescription
PolicySpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PolicySpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
PolicySpec.Builder

This builder for chaining.

clearRules()

public PolicySpec.Builder clearRules()

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

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

clone()

public PolicySpec.Builder clone()
Returns
TypeDescription
PolicySpec.Builder
Overrides

getDefaultInstanceForType()

public PolicySpec getDefaultInstanceForType()
Returns
TypeDescription
PolicySpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEtag()

public String getEtag()

An opaque tag indicating the current version of the Policy, 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 Policy 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
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

An opaque tag indicating the current version of the Policy, 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 Policy 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
TypeDescription
ByteString

The bytes for etag.

getInheritFromParent()

public boolean getInheritFromParent()

Determines the inheritance behavior for this Policy. If inherit_from_parent is true, PolicyRules 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
TypeDescription
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
TypeDescription
boolean

The reset.

getRules(int index)

public PolicySpec.PolicyRule getRules(int index)

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PolicySpec.PolicyRule

getRulesBuilder(int index)

public PolicySpec.PolicyRule.Builder getRulesBuilder(int index)

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PolicySpec.PolicyRule.Builder

getRulesBuilderList()

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

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Returns
TypeDescription
List<Builder>

getRulesCount()

public int getRulesCount()

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Returns
TypeDescription
int

getRulesList()

public List<PolicySpec.PolicyRule> getRulesList()

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Returns
TypeDescription
List<PolicyRule>

getRulesOrBuilder(int index)

public PolicySpec.PolicyRuleOrBuilder getRulesOrBuilder(int index)

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PolicySpec.PolicyRuleOrBuilder

getRulesOrBuilderList()

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

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PolicySpec other)

public PolicySpec.Builder mergeFrom(PolicySpec other)
Parameter
NameDescription
otherPolicySpec
Returns
TypeDescription
PolicySpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PolicySpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PolicySpec.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PolicySpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PolicySpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PolicySpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
PolicySpec.Builder

removeRules(int index)

public PolicySpec.Builder removeRules(int index)

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PolicySpec.Builder

setEtag(String value)

public PolicySpec.Builder setEtag(String value)

An opaque tag indicating the current version of the Policy, 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 Policy 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
NameDescription
valueString

The etag to set.

Returns
TypeDescription
PolicySpec.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public PolicySpec.Builder setEtagBytes(ByteString value)

An opaque tag indicating the current version of the Policy, 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 Policy 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
NameDescription
valueByteString

The bytes for etag to set.

Returns
TypeDescription
PolicySpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PolicySpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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, PolicyRules 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
NameDescription
valueboolean

The inheritFromParent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueboolean

The reset to set.

Returns
TypeDescription
PolicySpec.Builder

This builder for chaining.

setRules(int index, PolicySpec.PolicyRule value)

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

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Parameters
NameDescription
indexint
valuePolicySpec.PolicyRule
Returns
TypeDescription
PolicySpec.Builder

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

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

Up to 10 PolicyRules are allowed. In Policies for boolean constraints, the following requirements apply:

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

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

Parameters
NameDescription
indexint
builderForValuePolicySpec.PolicyRule.Builder
Returns
TypeDescription
PolicySpec.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final PolicySpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
PolicySpec.Builder