Class PolicySpec.PolicyRule (2.11.0)

Version 2.11.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 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.PolicyRule extends GeneratedMessageV3 implements PolicySpec.PolicyRuleOrBuilder

A rule used to express this policy.

Protobuf type google.cloud.orgpolicy.v2.PolicySpec.PolicyRule

Inheritance

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

Implements

PolicySpec.PolicyRuleOrBuilder

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)

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)

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)

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

ALLOW_ALL_FIELD_NUMBER

public static final int ALLOW_ALL_FIELD_NUMBER

Field Value

Type	Description
int

CONDITION_FIELD_NUMBER

public static final int CONDITION_FIELD_NUMBER

Field Value

Type	Description
int

DENY_ALL_FIELD_NUMBER

public static final int DENY_ALL_FIELD_NUMBER

Field Value

Type	Description
int

ENFORCE_FIELD_NUMBER

public static final int ENFORCE_FIELD_NUMBER

Field Value

Type	Description
int

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static PolicySpec.PolicyRule getDefaultInstance()

Returns

Type	Description
PolicySpec.PolicyRule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static PolicySpec.PolicyRule.Builder newBuilder()

Returns

Type	Description
PolicySpec.PolicyRule.Builder

newBuilder(PolicySpec.PolicyRule prototype)

public static PolicySpec.PolicyRule.Builder newBuilder(PolicySpec.PolicyRule prototype)

Parameter

Name	Description
prototype	PolicySpec.PolicyRule

Returns

Type	Description
PolicySpec.PolicyRule.Builder

parseDelimitedFrom(InputStream input)

public static PolicySpec.PolicyRule parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
PolicySpec.PolicyRule

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PolicySpec.PolicyRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PolicySpec.PolicyRule

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static PolicySpec.PolicyRule parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
PolicySpec.PolicyRule

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PolicySpec.PolicyRule

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PolicySpec.PolicyRule parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
PolicySpec.PolicyRule

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PolicySpec.PolicyRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PolicySpec.PolicyRule

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PolicySpec.PolicyRule parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
PolicySpec.PolicyRule

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PolicySpec.PolicyRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PolicySpec.PolicyRule

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static PolicySpec.PolicyRule parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
PolicySpec.PolicyRule

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PolicySpec.PolicyRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PolicySpec.PolicyRule

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static PolicySpec.PolicyRule parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
PolicySpec.PolicyRule

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PolicySpec.PolicyRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PolicySpec.PolicyRule

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<PolicySpec.PolicyRule> parser()

Returns

Type	Description
Parser<PolicyRule>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAllowAll()

public boolean getAllowAll()

Setting this to true means that all values are allowed. This field can be set only in Policies for list constraints.

bool allow_all = 2;

Returns

Type	Description
boolean	The allowAll.

getCondition()

public Expr getCondition()

A condition which determines whether this rule is used in the evaluation of the policy. When set, the expression field in the `Expr' must include from 1 to 10 subexpressions, joined by the "||" or "&&" operators. Each subexpression must be of the form "resource.matchTag('<ORG_ID>/tag_key_short_name, 'tag_value_short_name')". or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". where key_name and value_name are the resource names for Label Keys and Values. These names are available from the Tag Manager Service. An example expression is: "resource.matchTag('123456789/environment, 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')".

.google.type.Expr condition = 5;

Returns

Type	Description
com.google.type.Expr	The condition.

getConditionOrBuilder()

public ExprOrBuilder getConditionOrBuilder()

A condition which determines whether this rule is used in the evaluation of the policy. When set, the expression field in the `Expr' must include from 1 to 10 subexpressions, joined by the "||" or "&&" operators. Each subexpression must be of the form "resource.matchTag('<ORG_ID>/tag_key_short_name, 'tag_value_short_name')". or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". where key_name and value_name are the resource names for Label Keys and Values. These names are available from the Tag Manager Service. An example expression is: "resource.matchTag('123456789/environment, 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')".

.google.type.Expr condition = 5;

Returns

Type	Description
com.google.type.ExprOrBuilder

getDefaultInstanceForType()

public PolicySpec.PolicyRule getDefaultInstanceForType()

Returns

Type	Description
PolicySpec.PolicyRule

getDenyAll()

public boolean getDenyAll()

Setting this to true means that all values are denied. This field can be set only in Policies for list constraints.

bool deny_all = 3;

Returns

Type	Description
boolean	The denyAll.

getEnforce()

public boolean getEnforce()

If true, then the Policy is enforced. If false, then any configuration is acceptable. This field can be set only in Policies for boolean constraints.

bool enforce = 4;

Returns

Type	Description
boolean	The enforce.

getKindCase()

public PolicySpec.PolicyRule.KindCase getKindCase()

Returns

Type	Description
PolicySpec.PolicyRule.KindCase

getParserForType()

public Parser<PolicySpec.PolicyRule> getParserForType()

Returns

Type	Description
Parser<PolicyRule>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

getValues()

public PolicySpec.PolicyRule.StringValues getValues()

List of values to be used for this PolicyRule. This field can be set only in Policies for list constraints.

.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule.StringValues values = 1;

Returns

Type	Description
PolicySpec.PolicyRule.StringValues	The values.

getValuesOrBuilder()

public PolicySpec.PolicyRule.StringValuesOrBuilder getValuesOrBuilder()

List of values to be used for this PolicyRule. This field can be set only in Policies for list constraints.

.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule.StringValues values = 1;

Returns

Type	Description
PolicySpec.PolicyRule.StringValuesOrBuilder

hasAllowAll()

public boolean hasAllowAll()

Setting this to true means that all values are allowed. This field can be set only in Policies for list constraints.

bool allow_all = 2;

Returns

Type	Description
boolean	Whether the allowAll field is set.

hasCondition()

public boolean hasCondition()

A condition which determines whether this rule is used in the evaluation of the policy. When set, the expression field in the `Expr' must include from 1 to 10 subexpressions, joined by the "||" or "&&" operators. Each subexpression must be of the form "resource.matchTag('<ORG_ID>/tag_key_short_name, 'tag_value_short_name')". or "resource.matchTagId('tagKeys/key_id', 'tagValues/value_id')". where key_name and value_name are the resource names for Label Keys and Values. These names are available from the Tag Manager Service. An example expression is: "resource.matchTag('123456789/environment, 'prod')". or "resource.matchTagId('tagKeys/123', 'tagValues/456')".

.google.type.Expr condition = 5;

Returns

Type	Description
boolean	Whether the condition field is set.

hasDenyAll()

public boolean hasDenyAll()

Setting this to true means that all values are denied. This field can be set only in Policies for list constraints.

bool deny_all = 3;

Returns

Type	Description
boolean	Whether the denyAll field is set.

hasEnforce()

public boolean hasEnforce()

If true, then the Policy is enforced. If false, then any configuration is acceptable. This field can be set only in Policies for boolean constraints.

bool enforce = 4;

Returns

Type	Description
boolean	Whether the enforce field is set.

hasValues()

public boolean hasValues()

List of values to be used for this PolicyRule. This field can be set only in Policies for list constraints.

.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule.StringValues values = 1;

Returns

Type	Description
boolean	Whether the values 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.PolicyRule.Builder newBuilderForType()

Returns

Type	Description
PolicySpec.PolicyRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PolicySpec.PolicyRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
PolicySpec.PolicyRule.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.PolicyRule.Builder toBuilder()

Returns

Type	Description
PolicySpec.PolicyRule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException