com.google.cloud.orgpolicy.v2

Class CustomConstraint

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.orgpolicy.v2.CustomConstraint

All Implemented Interfaces:

CustomConstraintOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class CustomConstraint
extends com.google.protobuf.GeneratedMessageV3
implements CustomConstraintOrBuilder

 A custom constraint defined by customers which can *only* be applied to the
 given resource types and organization.

 By creating a custom constraint, customers can apply policies of this
 custom constraint. *Creating a custom constraint itself does NOT apply any
 policy enforcement*.
 

Protobuf type google.cloud.orgpolicy.v2.CustomConstraint

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomConstraint.ActionType Allow or deny type.
static class	CustomConstraint.Builder A custom constraint defined by customers which can *only* be applied to the given resource types and organization.
static class	CustomConstraint.MethodType The operation for which this constraint will be applied.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTION_TYPE_FIELD_NUMBER
static int	CONDITION_FIELD_NUMBER
static int	DESCRIPTION_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	METHOD_TYPES_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	RESOURCE_TYPES_FIELD_NUMBER
static int	UPDATE_TIME_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)
CustomConstraint.ActionType	getActionType() Allow or deny type.
int	getActionTypeValue() Allow or deny type.
String	getCondition() Org policy condition/expression.
com.google.protobuf.ByteString	getConditionBytes() Org policy condition/expression.
static CustomConstraint	getDefaultInstance()
CustomConstraint	getDefaultInstanceForType()
String	getDescription() Detailed information about this custom policy constraint.
com.google.protobuf.ByteString	getDescriptionBytes() Detailed information about this custom policy constraint.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() One line display name for the UI.
com.google.protobuf.ByteString	getDisplayNameBytes() One line display name for the UI.
CustomConstraint.MethodType	getMethodTypes(int index) All the operations being applied for this constraint.
int	getMethodTypesCount() All the operations being applied for this constraint.
List<CustomConstraint.MethodType>	getMethodTypesList() All the operations being applied for this constraint.
int	getMethodTypesValue(int index) All the operations being applied for this constraint.
List<Integer>	getMethodTypesValueList() All the operations being applied for this constraint.
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
com.google.protobuf.Parser<CustomConstraint>	getParserForType()
String	getResourceTypes(int index) Immutable.
com.google.protobuf.ByteString	getResourceTypesBytes(int index) Immutable.
int	getResourceTypesCount() Immutable.
com.google.protobuf.ProtocolStringList	getResourceTypesList() Immutable.
int	getSerializedSize()
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
int	hashCode()
boolean	hasUpdateTime() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CustomConstraint.Builder	newBuilder()
static CustomConstraint.Builder	newBuilder(CustomConstraint prototype)
CustomConstraint.Builder	newBuilderForType()
protected CustomConstraint.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CustomConstraint	parseDelimitedFrom(InputStream input)
static CustomConstraint	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomConstraint	parseFrom(byte[] data)
static CustomConstraint	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomConstraint	parseFrom(ByteBuffer data)
static CustomConstraint	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomConstraint	parseFrom(com.google.protobuf.ByteString data)
static CustomConstraint	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomConstraint	parseFrom(com.google.protobuf.CodedInputStream input)
static CustomConstraint	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomConstraint	parseFrom(InputStream input)
static CustomConstraint	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CustomConstraint>	parser()
CustomConstraint.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, getUnknownFields, 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

RESOURCE_TYPES_FIELD_NUMBER

public static final int RESOURCE_TYPES_FIELD_NUMBER

See Also:

Constant Field Values

METHOD_TYPES_FIELD_NUMBER

public static final int METHOD_TYPES_FIELD_NUMBER

See Also:

Constant Field Values

CONDITION_FIELD_NUMBER

public static final int CONDITION_FIELD_NUMBER

See Also:

Constant Field Values

ACTION_TYPE_FIELD_NUMBER

public static final int ACTION_TYPE_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

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 Immutable. Name of the constraint. This is unique within the organization.
 Format of the name should be

 * `organizations/{organization_id}/customConstraints/{custom_constraint_id}`

 Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`

 The max length is 70 characters and the minimum length is 1. Note that the
 prefix `organizations/{organization_id}/customConstraints/` is not counted.
 

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

Specified by:

getName in interface CustomConstraintOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Immutable. Name of the constraint. This is unique within the organization.
 Format of the name should be

 * `organizations/{organization_id}/customConstraints/{custom_constraint_id}`

 Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms`

 The max length is 70 characters and the minimum length is 1. Note that the
 prefix `organizations/{organization_id}/customConstraints/` is not counted.
 

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

Specified by:

getNameBytes in interface CustomConstraintOrBuilder

Returns:

The bytes for name.

getResourceTypesList

public com.google.protobuf.ProtocolStringList getResourceTypesList()

 Immutable. The resource instance type on which this policy applies. Format
 will be of the form : `<canonical service name>/<type>` Example:

  * `compute.googleapis.com/Instance`.
 

repeated string resource_types = 2 [(.google.api.field_behavior) = IMMUTABLE];

Specified by:

getResourceTypesList in interface CustomConstraintOrBuilder

Returns:

A list containing the resourceTypes.

getResourceTypesCount

public int getResourceTypesCount()

 Immutable. The resource instance type on which this policy applies. Format
 will be of the form : `<canonical service name>/<type>` Example:

  * `compute.googleapis.com/Instance`.
 

repeated string resource_types = 2 [(.google.api.field_behavior) = IMMUTABLE];

Specified by:

getResourceTypesCount in interface CustomConstraintOrBuilder

Returns:

The count of resourceTypes.

getResourceTypes

public String getResourceTypes(int index)

 Immutable. The resource instance type on which this policy applies. Format
 will be of the form : `<canonical service name>/<type>` Example:

  * `compute.googleapis.com/Instance`.
 

repeated string resource_types = 2 [(.google.api.field_behavior) = IMMUTABLE];

Specified by:

getResourceTypes in interface CustomConstraintOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The resourceTypes at the given index.

getResourceTypesBytes

public com.google.protobuf.ByteString getResourceTypesBytes(int index)

 Immutable. The resource instance type on which this policy applies. Format
 will be of the form : `<canonical service name>/<type>` Example:

  * `compute.googleapis.com/Instance`.
 

repeated string resource_types = 2 [(.google.api.field_behavior) = IMMUTABLE];

Specified by:

getResourceTypesBytes in interface CustomConstraintOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the resourceTypes at the given index.

getMethodTypesList

public List<CustomConstraint.MethodType> getMethodTypesList()

 All the operations being applied for this constraint.
 

repeated .google.cloud.orgpolicy.v2.CustomConstraint.MethodType method_types = 3;

Specified by:

getMethodTypesList in interface CustomConstraintOrBuilder

Returns:

A list containing the methodTypes.

getMethodTypesCount

public int getMethodTypesCount()

 All the operations being applied for this constraint.
 

repeated .google.cloud.orgpolicy.v2.CustomConstraint.MethodType method_types = 3;

Specified by:

getMethodTypesCount in interface CustomConstraintOrBuilder

Returns:

The count of methodTypes.

getMethodTypes

public CustomConstraint.MethodType getMethodTypes(int index)

 All the operations being applied for this constraint.
 

repeated .google.cloud.orgpolicy.v2.CustomConstraint.MethodType method_types = 3;

Specified by:

getMethodTypes in interface CustomConstraintOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The methodTypes at the given index.

getMethodTypesValueList

public List<Integer> getMethodTypesValueList()

 All the operations being applied for this constraint.
 

repeated .google.cloud.orgpolicy.v2.CustomConstraint.MethodType method_types = 3;

Specified by:

getMethodTypesValueList in interface CustomConstraintOrBuilder

Returns:

A list containing the enum numeric values on the wire for methodTypes.

getMethodTypesValue

public int getMethodTypesValue(int index)

 All the operations being applied for this constraint.
 

repeated .google.cloud.orgpolicy.v2.CustomConstraint.MethodType method_types = 3;

Specified by:

getMethodTypesValue in interface CustomConstraintOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The enum numeric value on the wire of methodTypes at the given index.

getCondition

public String getCondition()

 Org policy condition/expression. For example:
 `resource.instanceName.matches("[production|test]_.*_(\d)+")` or,
 `resource.management.auto_upgrade == true`

 The max length of the condition is 1000 characters.
 

string condition = 4;

Specified by:

getCondition in interface CustomConstraintOrBuilder

Returns:

The condition.

getConditionBytes

public com.google.protobuf.ByteString getConditionBytes()

 Org policy condition/expression. For example:
 `resource.instanceName.matches("[production|test]_.*_(\d)+")` or,
 `resource.management.auto_upgrade == true`

 The max length of the condition is 1000 characters.
 

string condition = 4;

Specified by:

getConditionBytes in interface CustomConstraintOrBuilder

Returns:

The bytes for condition.

getActionTypeValue

public int getActionTypeValue()

 Allow or deny type.
 

.google.cloud.orgpolicy.v2.CustomConstraint.ActionType action_type = 5;

Specified by:

getActionTypeValue in interface CustomConstraintOrBuilder

Returns:

The enum numeric value on the wire for actionType.

getActionType

public CustomConstraint.ActionType getActionType()

 Allow or deny type.
 

.google.cloud.orgpolicy.v2.CustomConstraint.ActionType action_type = 5;

Specified by:

getActionType in interface CustomConstraintOrBuilder

Returns:

The actionType.

getDisplayName

public String getDisplayName()

 One line display name for the UI.
 The max length of the display_name is 200 characters.
 

string display_name = 6;

Specified by:

getDisplayName in interface CustomConstraintOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 One line display name for the UI.
 The max length of the display_name is 200 characters.
 

string display_name = 6;

Specified by:

getDisplayNameBytes in interface CustomConstraintOrBuilder

Returns:

The bytes for displayName.

getDescription

public String getDescription()

 Detailed information about this custom policy constraint.
 The max length of the description is 2000 characters.
 

string description = 7;

Specified by:

getDescription in interface CustomConstraintOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 Detailed information about this custom policy constraint.
 The max length of the description is 2000 characters.
 

string description = 7;

Specified by:

getDescriptionBytes in interface CustomConstraintOrBuilder

Returns:

The bytes for description.

hasUpdateTime

public boolean hasUpdateTime()

 Output only. The last time this custom constraint was updated. This
 represents the last time that the `CreateCustomConstraint` or
 `UpdateCustomConstraint` RPC was called
 

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasUpdateTime in interface CustomConstraintOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public com.google.protobuf.Timestamp getUpdateTime()

 Output only. The last time this custom constraint was updated. This
 represents the last time that the `CreateCustomConstraint` or
 `UpdateCustomConstraint` RPC was called
 

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getUpdateTime in interface CustomConstraintOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. The last time this custom constraint was updated. This
 represents the last time that the `CreateCustomConstraint` or
 `UpdateCustomConstraint` RPC was called
 

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getUpdateTimeOrBuilder in interface CustomConstraintOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static CustomConstraint parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomConstraint parseFrom(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomConstraint parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomConstraint parseFrom(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomConstraint parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomConstraint parseFrom(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomConstraint parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static CustomConstraint parseFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static CustomConstraint parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static CustomConstraint parseDelimitedFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static CustomConstraint parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static CustomConstraint parseFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public CustomConstraint.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CustomConstraint.Builder newBuilder()

newBuilder

public static CustomConstraint.Builder newBuilder(CustomConstraint prototype)

toBuilder

public CustomConstraint.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected CustomConstraint.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CustomConstraint getDefaultInstance()

parser

public static com.google.protobuf.Parser<CustomConstraint> parser()

getParserForType

public com.google.protobuf.Parser<CustomConstraint> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public CustomConstraint getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder