public final class PolicySpec extends GeneratedMessageV3 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
Static Fields
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INHERIT_FROM_PARENT_FIELD_NUMBER
public static final int INHERIT_FROM_PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RESET_FIELD_NUMBER
public static final int RESET_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static PolicySpec getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PolicySpec.Builder newBuilder()
newBuilder(PolicySpec prototype)
public static PolicySpec.Builder newBuilder(PolicySpec prototype)
public static PolicySpec parseDelimitedFrom(InputStream input)
public static PolicySpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PolicySpec parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PolicySpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PolicySpec parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PolicySpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PolicySpec parseFrom(CodedInputStream input)
public static PolicySpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PolicySpec parseFrom(InputStream input)
public static PolicySpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PolicySpec parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PolicySpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PolicySpec> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public PolicySpec getDefaultInstanceForType()
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 |
|---|
| 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;
| 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, 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 |
|---|
| Type | Description |
boolean | The inheritFromParent.
|
getParserForType()
public Parser<PolicySpec> getParserForType()
Overrides
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)
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| 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;
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| Type | Description |
List<? extends com.google.cloud.orgpolicy.v2.PolicySpec.PolicyRuleOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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.
|
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];
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PolicySpec.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PolicySpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public PolicySpec.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
