Class PolicySpec (2.31.0)

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

Inheritance

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

Implements

PolicySpecOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

Returns
Type	Description
`PolicySpec`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static PolicySpec.Builder newBuilder()

Returns
Type	Description
`PolicySpec.Builder`

newBuilder(PolicySpec prototype)

public static PolicySpec.Builder newBuilder(PolicySpec prototype)

Parameter
Name	Description
`prototype`	`PolicySpec`

Returns
Type	Description
`PolicySpec.Builder`

parseDelimitedFrom(InputStream input)

public static PolicySpec parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`PolicySpec`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PolicySpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PolicySpec`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static PolicySpec parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`PolicySpec`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PolicySpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PolicySpec`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static PolicySpec parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`PolicySpec`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PolicySpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PolicySpec`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static PolicySpec parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`PolicySpec`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PolicySpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PolicySpec`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static PolicySpec parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`PolicySpec`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PolicySpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PolicySpec`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static PolicySpec parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`PolicySpec`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PolicySpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PolicySpec`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<PolicySpec> parser()

Returns
Type	Description
`Parser<PolicySpec>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public PolicySpec getDefaultInstanceForType()

Returns
Type	Description
`PolicySpec`

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
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()

Returns
Type	Description
`Parser<PolicySpec>`

Overrides

GeneratedMessageV3.getParserForType()

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`

Returns
Type	Description
`PolicySpec.PolicyRule`

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;

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

Parameter
Name	Description
`index`	`int`

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

Returns
Type	Description
`List<? extends com.google.cloud.orgpolicy.v2.PolicySpec.PolicyRuleOrBuilder>`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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

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.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public PolicySpec.Builder newBuilderForType()

Returns
Type	Description
`PolicySpec.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PolicySpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`PolicySpec.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public PolicySpec.Builder toBuilder()

Returns
Type	Description
`PolicySpec.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`