com.google.cloud.orgpolicy.v2

Class Constraint

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.orgpolicy.v2.Constraint

All Implemented Interfaces:

ConstraintOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class Constraint
extends GeneratedMessageV3
implements ConstraintOrBuilder

 A `constraint` describes a way to restrict resource's configuration. For
 example, you could enforce a constraint that controls which cloud services
 can be activated across an organization, or whether a Compute Engine instance
 can have serial port connections established. `Constraints` can be configured
 by the organization's policy adminstrator to fit the needs of the organzation
 by setting a `policy` that includes `constraints` at different locations in
 the organization's resource hierarchy. Policies are inherited down the
 resource hierarchy from higher levels, but can also be overridden. For
 details about the inheritance rules please read about
 [`policies`][google.cloud.OrgPolicy.v2.Policy].
 `Constraints` have a default behavior determined by the `constraint_default`
 field, which is the enforcement behavior that is used in the absence of a
 `policy` being defined or inherited for the resource in question.
 

Protobuf type google.cloud.orgpolicy.v2.Constraint

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Constraint.BooleanConstraint A `Constraint` that is either enforced or not.
static interface	Constraint.BooleanConstraintOrBuilder
static class	Constraint.Builder A `constraint` describes a way to restrict resource's configuration.
static class	Constraint.ConstraintDefault Specifies the default behavior in the absence of any `Policy` for the `Constraint`.
static class	Constraint.ConstraintTypeCase
static class	Constraint.ListConstraint A `Constraint` that allows or disallows a list of string values, which are configured by an Organization's policy administrator with a `Policy`.
static interface	Constraint.ListConstraintOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOOLEAN_CONSTRAINT_FIELD_NUMBER
static int	CONSTRAINT_DEFAULT_FIELD_NUMBER
static int	DESCRIPTION_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	LIST_CONSTRAINT_FIELD_NUMBER
static int	NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Constraint.BooleanConstraint	getBooleanConstraint() Defines this constraint as being a BooleanConstraint.
Constraint.BooleanConstraintOrBuilder	getBooleanConstraintOrBuilder() Defines this constraint as being a BooleanConstraint.
Constraint.ConstraintDefault	getConstraintDefault() The evaluation behavior of this constraint in the absence of 'Policy'.
int	getConstraintDefaultValue() The evaluation behavior of this constraint in the absence of 'Policy'.
Constraint.ConstraintTypeCase	getConstraintTypeCase()
static Constraint	getDefaultInstance()
Constraint	getDefaultInstanceForType()
String	getDescription() Detailed description of what this `Constraint` controls as well as how and where it is enforced.
ByteString	getDescriptionBytes() Detailed description of what this `Constraint` controls as well as how and where it is enforced.
static Descriptors.Descriptor	getDescriptor()
String	getDisplayName() The human readable name.
ByteString	getDisplayNameBytes() The human readable name.
Constraint.ListConstraint	getListConstraint() Defines this constraint as being a ListConstraint.
Constraint.ListConstraintOrBuilder	getListConstraintOrBuilder() Defines this constraint as being a ListConstraint.
String	getName() Immutable.
ByteString	getNameBytes() Immutable.
Parser<Constraint>	getParserForType()
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
boolean	hasBooleanConstraint() Defines this constraint as being a BooleanConstraint.
int	hashCode()
boolean	hasListConstraint() Defines this constraint as being a ListConstraint.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Constraint.Builder	newBuilder()
static Constraint.Builder	newBuilder(Constraint prototype)
Constraint.Builder	newBuilderForType()
protected Constraint.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static Constraint	parseDelimitedFrom(InputStream input)
static Constraint	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Constraint	parseFrom(byte[] data)
static Constraint	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Constraint	parseFrom(ByteBuffer data)
static Constraint	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Constraint	parseFrom(ByteString data)
static Constraint	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Constraint	parseFrom(CodedInputStream input)
static Constraint	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Constraint	parseFrom(InputStream input)
static Constraint	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Constraint>	parser()
Constraint.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

CONSTRAINT_DEFAULT_FIELD_NUMBER

public static final int CONSTRAINT_DEFAULT_FIELD_NUMBER

See Also:

Constant Field Values

LIST_CONSTRAINT_FIELD_NUMBER

public static final int LIST_CONSTRAINT_FIELD_NUMBER

See Also:

Constant Field Values

BOOLEAN_CONSTRAINT_FIELD_NUMBER

public static final int BOOLEAN_CONSTRAINT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getConstraintTypeCase

public Constraint.ConstraintTypeCase getConstraintTypeCase()

Specified by:

getConstraintTypeCase in interface ConstraintOrBuilder

getName

public String getName()

 Immutable. The resource name of the Constraint. Must be in one of
 the following forms:
 * `projects/{project_number}/constraints/{constraint_name}`
 * `folders/{folder_id}/constraints/{constraint_name}`
 * `organizations/{organization_id}/constraints/{constraint_name}`
 For example, "/projects/123/constraints/compute.disableSerialPortAccess".
 

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Specified by:

getName in interface ConstraintOrBuilder

Returns:

The name.

getNameBytes

public ByteString getNameBytes()

 Immutable. The resource name of the Constraint. Must be in one of
 the following forms:
 * `projects/{project_number}/constraints/{constraint_name}`
 * `folders/{folder_id}/constraints/{constraint_name}`
 * `organizations/{organization_id}/constraints/{constraint_name}`
 For example, "/projects/123/constraints/compute.disableSerialPortAccess".
 

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Specified by:

getNameBytes in interface ConstraintOrBuilder

Returns:

The bytes for name.

getDisplayName

public String getDisplayName()

 The human readable name.
 Mutable.
 

string display_name = 2;

Specified by:

getDisplayName in interface ConstraintOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public ByteString getDisplayNameBytes()

 The human readable name.
 Mutable.
 

string display_name = 2;

Specified by:

getDisplayNameBytes in interface ConstraintOrBuilder

Returns:

The bytes for displayName.

getDescription

public String getDescription()

 Detailed description of what this `Constraint` controls as well as how and
 where it is enforced.
 Mutable.
 

string description = 3;

Specified by:

getDescription in interface ConstraintOrBuilder

Returns:

The description.

getDescriptionBytes

public ByteString getDescriptionBytes()

 Detailed description of what this `Constraint` controls as well as how and
 where it is enforced.
 Mutable.
 

string description = 3;

Specified by:

getDescriptionBytes in interface ConstraintOrBuilder

Returns:

The bytes for description.

getConstraintDefaultValue

public int getConstraintDefaultValue()

 The evaluation behavior of this constraint in the absence of 'Policy'.
 

.google.cloud.orgpolicy.v2.Constraint.ConstraintDefault constraint_default = 4;

Specified by:

getConstraintDefaultValue in interface ConstraintOrBuilder

Returns:

The enum numeric value on the wire for constraintDefault.

getConstraintDefault

public Constraint.ConstraintDefault getConstraintDefault()

 The evaluation behavior of this constraint in the absence of 'Policy'.
 

.google.cloud.orgpolicy.v2.Constraint.ConstraintDefault constraint_default = 4;

Specified by:

getConstraintDefault in interface ConstraintOrBuilder

Returns:

The constraintDefault.

hasListConstraint

public boolean hasListConstraint()

 Defines this constraint as being a ListConstraint.
 

.google.cloud.orgpolicy.v2.Constraint.ListConstraint list_constraint = 5;

Specified by:

hasListConstraint in interface ConstraintOrBuilder

Returns:

Whether the listConstraint field is set.

getListConstraint

public Constraint.ListConstraint getListConstraint()

 Defines this constraint as being a ListConstraint.
 

.google.cloud.orgpolicy.v2.Constraint.ListConstraint list_constraint = 5;

Specified by:

getListConstraint in interface ConstraintOrBuilder

Returns:

The listConstraint.

getListConstraintOrBuilder

public Constraint.ListConstraintOrBuilder getListConstraintOrBuilder()

 Defines this constraint as being a ListConstraint.
 

.google.cloud.orgpolicy.v2.Constraint.ListConstraint list_constraint = 5;

Specified by:

getListConstraintOrBuilder in interface ConstraintOrBuilder

hasBooleanConstraint

public boolean hasBooleanConstraint()

 Defines this constraint as being a BooleanConstraint.
 

.google.cloud.orgpolicy.v2.Constraint.BooleanConstraint boolean_constraint = 6;

Specified by:

hasBooleanConstraint in interface ConstraintOrBuilder

Returns:

Whether the booleanConstraint field is set.

getBooleanConstraint

public Constraint.BooleanConstraint getBooleanConstraint()

 Defines this constraint as being a BooleanConstraint.
 

.google.cloud.orgpolicy.v2.Constraint.BooleanConstraint boolean_constraint = 6;

Specified by:

getBooleanConstraint in interface ConstraintOrBuilder

Returns:

The booleanConstraint.

getBooleanConstraintOrBuilder

public Constraint.BooleanConstraintOrBuilder getBooleanConstraintOrBuilder()

 Defines this constraint as being a BooleanConstraint.
 

.google.cloud.orgpolicy.v2.Constraint.BooleanConstraint boolean_constraint = 6;

Specified by:

getBooleanConstraintOrBuilder in interface ConstraintOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static Constraint parseFrom(ByteBuffer data)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Constraint parseFrom(ByteBuffer data,
                                   ExtensionRegistryLite extensionRegistry)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Constraint parseFrom(ByteString data)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Constraint parseFrom(ByteString data,
                                   ExtensionRegistryLite extensionRegistry)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Constraint parseFrom(byte[] data)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Constraint parseFrom(byte[] data,
                                   ExtensionRegistryLite extensionRegistry)
                            throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Constraint parseFrom(InputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static Constraint parseFrom(InputStream input,
                                   ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static Constraint parseDelimitedFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static Constraint parseDelimitedFrom(InputStream input,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseFrom

public static Constraint parseFrom(CodedInputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static Constraint parseFrom(CodedInputStream input,
                                   ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

newBuilderForType

public Constraint.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Constraint.Builder newBuilder()

newBuilder

public static Constraint.Builder newBuilder(Constraint prototype)

toBuilder

public Constraint.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Constraint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Constraint getDefaultInstance()

parser

public static Parser<Constraint> parser()

getParserForType

public Parser<Constraint> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Constraint getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder