Interface CustomConstraintOrBuilder (2.55.0) 

public interface CustomConstraintOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActionType()

public abstract CustomConstraint.ActionType getActionType()

Allow or deny type.

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

Returns
Type Description
CustomConstraint.ActionType

The actionType.

getActionTypeValue()

public abstract 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 abstract 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 abstract 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.

getDescription()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.
Returns
Type Description
CustomConstraint.MethodType

The methodTypes at the given index.

getMethodTypesCount()

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

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract 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.

getResourceTypes(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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];

Returns
Type Description
List<String>

A list containing the resourceTypes.

getUpdateTime()

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

Returns
Type Description
TimestampOrBuilder

hasUpdateTime()

public abstract 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.