public final class CustomConstraint extends 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
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
ACTION_TYPE_FIELD_NUMBER
public static final int ACTION_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONDITION_FIELD_NUMBER
public static final int CONDITION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
METHOD_TYPES_FIELD_NUMBER
public static final int METHOD_TYPES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESOURCE_TYPES_FIELD_NUMBER
public static final int RESOURCE_TYPES_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 CustomConstraint getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CustomConstraint.Builder newBuilder()
newBuilder(CustomConstraint prototype)
public static CustomConstraint.Builder newBuilder(CustomConstraint prototype)
public static CustomConstraint parseDelimitedFrom(InputStream input)
public static CustomConstraint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CustomConstraint parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CustomConstraint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CustomConstraint parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomConstraint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomConstraint parseFrom(CodedInputStream input)
public static CustomConstraint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CustomConstraint parseFrom(InputStream input)
public static CustomConstraint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CustomConstraint parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CustomConstraint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CustomConstraint> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getActionType()
public CustomConstraint.ActionType getActionType()
Allow or deny type.
.google.cloud.orgpolicy.v2.CustomConstraint.ActionType action_type = 5;
getActionTypeValue()
public int getActionTypeValue()
Allow or deny type.
.google.cloud.orgpolicy.v2.CustomConstraint.ActionType action_type = 5;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for actionType.
|
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;
| Returns |
| Type |
Description |
String |
The condition.
|
getConditionBytes()
public 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;
| Returns |
| Type |
Description |
ByteString |
The bytes for condition.
|
getDefaultInstanceForType()
public CustomConstraint getDefaultInstanceForType()
getDescription()
public String getDescription()
Detailed information about this custom policy constraint.
The max length of the description is 2000 characters.
string description = 7;
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Detailed information about this custom policy constraint.
The max length of the description is 2000 characters.
string description = 7;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
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;
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
One line display name for the UI.
The max length of the display_name is 200 characters.
string display_name = 6;
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getMethodTypes(int index)
public CustomConstraint.MethodType getMethodTypes(int index)
All the operations being applied for this constraint.
repeated .google.cloud.orgpolicy.v2.CustomConstraint.MethodType method_types = 3;
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
getMethodTypesCount()
public int getMethodTypesCount()
All the operations being applied for this constraint.
repeated .google.cloud.orgpolicy.v2.CustomConstraint.MethodType method_types = 3;
| Returns |
| Type |
Description |
int |
The count of methodTypes.
|
getMethodTypesList()
public List<CustomConstraint.MethodType> getMethodTypesList()
All the operations being applied for this constraint.
repeated .google.cloud.orgpolicy.v2.CustomConstraint.MethodType method_types = 3;
| Returns |
| Type |
Description |
List<MethodType> |
A list containing the methodTypes.
|
getMethodTypesValue(int index)
public int getMethodTypesValue(int index)
All the operations being applied for this constraint.
repeated .google.cloud.orgpolicy.v2.CustomConstraint.MethodType method_types = 3;
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire of 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;
| Returns |
| Type |
Description |
List<Integer> |
A list containing the enum numeric values on the wire for methodTypes.
|
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];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<CustomConstraint> getParserForType()
Overrides
getResourceTypes(int index)
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];
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The resourceTypes at the given index.
|
getResourceTypesBytes(int index)
public 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];
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the resourceTypes at the given index.
|
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];
| Returns |
| Type |
Description |
int |
The count of resourceTypes.
|
getResourceTypesList()
public 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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getUpdateTime()
public 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];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public 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];
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];
| 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 CustomConstraint.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CustomConstraint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CustomConstraint.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
