- 2.53.0 (latest)
- 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 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PolicySpec.BuilderImplements
PolicySpecOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
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;
Name | Description |
values | Iterable<? extends com.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule> |
Type | Description |
PolicySpec.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PolicySpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
PolicySpec.Builder |
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;
Name | Description |
value | PolicySpec.PolicyRule |
Type | Description |
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;
Name | Description |
builderForValue | PolicySpec.PolicyRule.Builder |
Type | Description |
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;
Name | Description |
index | int |
value | PolicySpec.PolicyRule |
Type | Description |
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;
Name | Description |
index | int |
builderForValue | PolicySpec.PolicyRule.Builder |
Type | Description |
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;
Type | Description |
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;
Name | Description |
index | int |
Type | Description |
PolicySpec.PolicyRule.Builder |
build()
public PolicySpec build()
Type | Description |
PolicySpec |
buildPartial()
public PolicySpec buildPartial()
Type | Description |
PolicySpec |
clear()
public PolicySpec.Builder clear()
Type | Description |
PolicySpec.Builder |
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;
Type | Description |
PolicySpec.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public PolicySpec.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
PolicySpec.Builder |
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;
Type | Description |
PolicySpec.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public PolicySpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
PolicySpec.Builder |
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;
Type | Description |
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;
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];
Type | Description |
PolicySpec.Builder |
clone()
public PolicySpec.Builder clone()
Type | Description |
PolicySpec.Builder |
getDefaultInstanceForType()
public PolicySpec getDefaultInstanceForType()
Type | Description |
PolicySpec |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
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;
Type | Description |
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;
Type | Description |
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;
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;
Type | Description |
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;
Name | Description |
index | int |
Type | Description |
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;
Name | Description |
index | int |
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Name | Description |
index | int |
Type | Description |
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;
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];
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];
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];
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];
Type | Description |
boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(PolicySpec other)
public PolicySpec.Builder mergeFrom(PolicySpec other)
Name | Description |
other | PolicySpec |
Type | Description |
PolicySpec.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PolicySpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
PolicySpec.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public PolicySpec.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
PolicySpec.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PolicySpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
PolicySpec.Builder |
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];
Name | Description |
value | Timestamp |
Type | Description |
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;
Name | Description |
index | int |
Type | Description |
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;
Name | Description |
value | String The etag to set. |
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 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;
Name | Description |
value | ByteString The bytes for etag to set. |
Type | Description |
PolicySpec.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public PolicySpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
PolicySpec.Builder |
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;
Name | Description |
value | boolean The inheritFromParent to set. |
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)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
PolicySpec.Builder |
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;
Name | Description |
value | boolean The reset to set. |
Type | Description |
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;
Name | Description |
index | int |
value | PolicySpec.PolicyRule |
Type | Description |
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;
Name | Description |
index | int |
builderForValue | PolicySpec.PolicyRule.Builder |
Type | Description |
PolicySpec.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final PolicySpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
PolicySpec.Builder |
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];
Name | Description |
value | Timestamp |
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];
Name | Description |
builderForValue | Builder |
Type | Description |
PolicySpec.Builder |