build.buf.validate.OneofConstraintsOrBuilder 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 OneofConstraintsOrBuilder extends
    // @@protoc_insertion_point(interface_extends:buf.validate.OneofConstraints)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * If `required` is true, exactly one field of the oneof must be present. A
   * validation error is returned if no fields in the oneof are present. The
   * field itself may still be a default value; further constraints
   * should be placed on the fields themselves to ensure they are valid values,
   * such as `min_len` or `gt`.
   *
   * ```proto
   * message MyMessage {
   * oneof value {
   * // Either `a` or `b` must be set. If `a` is set, it must also be
   * // non-empty; whereas if `b` is set, it can still be an empty string.
   * option (buf.validate.oneof).required = true;
   * string a = 1 [(buf.validate.field).string.min_len = 1];
   * string b = 2;
   * }
   * }
   * ```
   * 
   *
   * optional bool required = 1 [json_name = "required"];
   * @return Whether the required field is set.
   */
  boolean hasRequired();
  /**
   *    * If `required` is true, exactly one field of the oneof must be present. A
   * validation error is returned if no fields in the oneof are present. The
   * field itself may still be a default value; further constraints
   * should be placed on the fields themselves to ensure they are valid values,
   * such as `min_len` or `gt`.
   *
   * ```proto
   * message MyMessage {
   * oneof value {
   * // Either `a` or `b` must be set. If `a` is set, it must also be
   * // non-empty; whereas if `b` is set, it can still be an empty string.
   * option (buf.validate.oneof).required = true;
   * string a = 1 [(buf.validate.field).string.min_len = 1];
   * string b = 2;
   * }
   * }
   * ```
   * 
   *
   * optional bool required = 1 [json_name = "required"];
   * @return The required.
   */
  boolean getRequired();
}