Send feedback
Class PolicySpec (2.37.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.37.0 keyboard_arrow_down
public final class PolicySpec extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 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.
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 )
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
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;
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
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 >
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
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
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]