build.buf.validate.RepeatedRulesOrBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of protovalidate Show documentation
Protocol Buffer Validation
There is a newer version: 0.3.2
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// NO CHECKED-IN PROTOBUF GENCODE
// source: buf/validate/validate.proto
// Protobuf Java Version: 4.28.1

package build.buf.validate;

public interface RepeatedRulesOrBuilder extends
    // @@protoc_insertion_point(interface_extends:buf.validate.RepeatedRules)
    com.google.protobuf.GeneratedMessage.
        ExtendableMessageOrBuilder {

  /**
   *    * `min_items` requires that this field must contain at least the specified
   * minimum number of items.
   *
   * Note that `min_items = 1` is equivalent to setting a field as `required`.
   *
   * ```proto
   * message MyRepeated {
   * // value must contain at least  2 items
   * repeated string value = 1 [(buf.validate.field).repeated.min_items = 2];
   * }
   * ```
   * 
   *
   * optional uint64 min_items = 1 [json_name = "minItems", (.buf.validate.predefined) = { ... }
   * @return Whether the minItems field is set.
   */
  boolean hasMinItems();
  /**
   *    * `min_items` requires that this field must contain at least the specified
   * minimum number of items.
   *
   * Note that `min_items = 1` is equivalent to setting a field as `required`.
   *
   * ```proto
   * message MyRepeated {
   * // value must contain at least  2 items
   * repeated string value = 1 [(buf.validate.field).repeated.min_items = 2];
   * }
   * ```
   * 
   *
   * optional uint64 min_items = 1 [json_name = "minItems", (.buf.validate.predefined) = { ... }
   * @return The minItems.
   */
  long getMinItems();

  /**
   *    * `max_items` denotes that this field must not exceed a
   * certain number of items as the upper limit. If the field contains more
   * items than specified, an error message will be generated, requiring the
   * field to maintain no more than the specified number of items.
   *
   * ```proto
   * message MyRepeated {
   * // value must contain no more than 3 item(s)
   * repeated string value = 1 [(buf.validate.field).repeated.max_items = 3];
   * }
   * ```
   * 
   *
   * optional uint64 max_items = 2 [json_name = "maxItems", (.buf.validate.predefined) = { ... }
   * @return Whether the maxItems field is set.
   */
  boolean hasMaxItems();
  /**
   *    * `max_items` denotes that this field must not exceed a
   * certain number of items as the upper limit. If the field contains more
   * items than specified, an error message will be generated, requiring the
   * field to maintain no more than the specified number of items.
   *
   * ```proto
   * message MyRepeated {
   * // value must contain no more than 3 item(s)
   * repeated string value = 1 [(buf.validate.field).repeated.max_items = 3];
   * }
   * ```
   * 
   *
   * optional uint64 max_items = 2 [json_name = "maxItems", (.buf.validate.predefined) = { ... }
   * @return The maxItems.
   */
  long getMaxItems();

  /**
   *    * `unique` indicates that all elements in this field must
   * be unique. This constraint is strictly applicable to scalar and enum
   * types, with message types not being supported.
   *
   * ```proto
   * message MyRepeated {
   * // repeated value must contain unique items
   * repeated string value = 1 [(buf.validate.field).repeated.unique = true];
   * }
   * ```
   * 
   *
   * optional bool unique = 3 [json_name = "unique", (.buf.validate.predefined) = { ... }
   * @return Whether the unique field is set.
   */
  boolean hasUnique();
  /**
   *    * `unique` indicates that all elements in this field must
   * be unique. This constraint is strictly applicable to scalar and enum
   * types, with message types not being supported.
   *
   * ```proto
   * message MyRepeated {
   * // repeated value must contain unique items
   * repeated string value = 1 [(buf.validate.field).repeated.unique = true];
   * }
   * ```
   * 
   *
   * optional bool unique = 3 [json_name = "unique", (.buf.validate.predefined) = { ... }
   * @return The unique.
   */
  boolean getUnique();

  /**
   *    * `items` details the constraints to be applied to each item
   * in the field. Even for repeated message fields, validation is executed
   * against each item unless skip is explicitly specified.
   *
   * ```proto
   * message MyRepeated {
   * // The items in the field `value` must follow the specified constraints.
   * repeated string value = 1 [(buf.validate.field).repeated.items = {
   * string: {
   * min_len: 3
   * max_len: 10
   * }
   * }];
   * }
   * ```
   * 
   *
   * optional .buf.validate.FieldConstraints items = 4 [json_name = "items"];
   * @return Whether the items field is set.
   */
  boolean hasItems();
  /**
   *    * `items` details the constraints to be applied to each item
   * in the field. Even for repeated message fields, validation is executed
   * against each item unless skip is explicitly specified.
   *
   * ```proto
   * message MyRepeated {
   * // The items in the field `value` must follow the specified constraints.
   * repeated string value = 1 [(buf.validate.field).repeated.items = {
   * string: {
   * min_len: 3
   * max_len: 10
   * }
   * }];
   * }
   * ```
   * 
   *
   * optional .buf.validate.FieldConstraints items = 4 [json_name = "items"];
   * @return The items.
   */
  build.buf.validate.FieldConstraints getItems();
  /**
   *    * `items` details the constraints to be applied to each item
   * in the field. Even for repeated message fields, validation is executed
   * against each item unless skip is explicitly specified.
   *
   * ```proto
   * message MyRepeated {
   * // The items in the field `value` must follow the specified constraints.
   * repeated string value = 1 [(buf.validate.field).repeated.items = {
   * string: {
   * min_len: 3
   * max_len: 10
   * }
   * }];
   * }
   * ```
   * 
   *
   * optional .buf.validate.FieldConstraints items = 4 [json_name = "items"];
   */
  build.buf.validate.FieldConstraintsOrBuilder getItemsOrBuilder();
}