Package com.google.cloud.orgpolicy.v2

Interface CustomConstraintOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CustomConstraint, CustomConstraint.Builder
@Generated public interface CustomConstraintOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getResourceTypesList

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

 * `compute.googleapis.com/Instance`.
      repeated string resource_types = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      A list containing the resourceTypes.

    • getResourceTypesCount

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

 * `compute.googleapis.com/Instance`.
      repeated string resource_types = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The count of resourceTypes.

    • getResourceTypes

      String getResourceTypes(int index)
       Immutable. The resource instance type on which this policy applies. Format
 will be of the form : `<service name>/<type>` Example:

 * `compute.googleapis.com/Instance`.
      repeated string resource_types = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      index - The index of the element to return.
      Returns:
      The resourceTypes at the given index.

    • getResourceTypesBytes

      com.google.protobuf.ByteString getResourceTypesBytes(int index)
       Immutable. The resource instance type on which this policy applies. Format
 will be of the form : `<service name>/<type>` Example:

 * `compute.googleapis.com/Instance`.
      repeated string resource_types = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the resourceTypes at the given index.

    • getMethodTypesList

      List<CustomConstraint.MethodType> getMethodTypesList()
       All the operations being applied for this constraint.
      repeated .google.cloud.orgpolicy.v2.CustomConstraint.MethodType method_types = 3;
      Returns:
      A list containing the methodTypes.

    • getMethodTypesCount

      int getMethodTypesCount()
       All the operations being applied for this constraint.
      repeated .google.cloud.orgpolicy.v2.CustomConstraint.MethodType method_types = 3;
      Returns:
      The count of methodTypes.

    • getMethodTypes

      CustomConstraint.MethodType getMethodTypes(int index)
       All the operations being applied for this constraint.
      repeated .google.cloud.orgpolicy.v2.CustomConstraint.MethodType method_types = 3;
      Parameters:
      index - The index of the element to return.
      Returns:
      The methodTypes at the given index.

    • getMethodTypesValueList

      List<Integer> getMethodTypesValueList()
       All the operations being applied for this constraint.
      repeated .google.cloud.orgpolicy.v2.CustomConstraint.MethodType method_types = 3;
      Returns:
      A list containing the enum numeric values on the wire for methodTypes.

    • getMethodTypesValue

      int getMethodTypesValue(int index)
       All the operations being applied for this constraint.
      repeated .google.cloud.orgpolicy.v2.CustomConstraint.MethodType method_types = 3;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of methodTypes at the given index.

    • getCondition

      String getCondition()
       A Common Expression Language (CEL) condition which is used in the
 evaluation of the constraint. 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:
      The condition.

    • getConditionBytes

      com.google.protobuf.ByteString getConditionBytes()
       A Common Expression Language (CEL) condition which is used in the
 evaluation of the constraint. 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:
      The bytes for condition.

    • getActionTypeValue

      int getActionTypeValue()
       Allow or deny type.
      .google.cloud.orgpolicy.v2.CustomConstraint.ActionType action_type = 5;
      Returns:
      The enum numeric value on the wire for actionType.

    • getActionType

      CustomConstraint.ActionType getActionType()
       Allow or deny type.
      .google.cloud.orgpolicy.v2.CustomConstraint.ActionType action_type = 5;
      Returns:
      The actionType.

    • getDisplayName

      String getDisplayName()
       One line display name for the UI.
 The max length of the display_name is 200 characters.
      string display_name = 6;
      Returns:
      The displayName.

    • getDisplayNameBytes

      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;
      Returns:
      The bytes for displayName.

    • getDescription

      String getDescription()
       Detailed information about this custom policy constraint.
 The max length of the description is 2000 characters.
      string description = 7;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Detailed information about this custom policy constraint.
 The max length of the description is 2000 characters.
      string description = 7;
      Returns:
      The bytes for description.

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The last time this custom constraint was updated. This
 represents the last time that the `CreateCustomConstraint` or
 `UpdateCustomConstraint` methods were called.
      .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      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` methods were called.
      .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      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` methods were called.
      .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];