Package build.buf.validate

Class RepeatedRules

  • All Implemented Interfaces:
    RepeatedRulesOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class RepeatedRules
extends com.google.protobuf.GeneratedMessage
implements RepeatedRulesOrBuilder
     RepeatedRules describe the constraints applied to `repeated` values.
    Protobuf type buf.validate.RepeatedRules
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RepeatedRules.Builder
      RepeatedRules describe the constraints applied to `repeated` values.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ITEMS_FIELD_NUMBER  
      static int MAX_ITEMS_FIELD_NUMBER  
      static int MIN_ITEMS_FIELD_NUMBER  
      static int UNIQUE_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessage

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static RepeatedRules getDefaultInstance()  
      RepeatedRules getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      FieldConstraints getItems()
      `items` details the constraints to be applied to each item in the field.
      FieldConstraintsOrBuilder getItemsOrBuilder()
      `items` details the constraints to be applied to each item in the field.
      long getMaxItems()
      `max_items` denotes that this field must not exceed a certain number of items as the upper limit.
      long getMinItems()
      `min_items` requires that this field must contain at least the specified minimum number of items.
      com.google.protobuf.Parser<RepeatedRules> getParserForType()  
      int getSerializedSize()  
      boolean getUnique()
      `unique` indicates that all elements in this field must be unique.
      int hashCode()  
      boolean hasItems()
      `items` details the constraints to be applied to each item in the field.
      boolean hasMaxItems()
      `max_items` denotes that this field must not exceed a certain number of items as the upper limit.
      boolean hasMinItems()
      `min_items` requires that this field must contain at least the specified minimum number of items.
      boolean hasUnique()
      `unique` indicates that all elements in this field must be unique.
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static RepeatedRules.Builder newBuilder()  
      static RepeatedRules.Builder newBuilder​(RepeatedRules prototype)  
      RepeatedRules.Builder newBuilderForType()  
      protected RepeatedRules.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static RepeatedRules parseDelimitedFrom​(java.io.InputStream input)  
      static RepeatedRules parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RepeatedRules parseFrom​(byte[] data)  
      static RepeatedRules parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RepeatedRules parseFrom​(com.google.protobuf.ByteString data)  
      static RepeatedRules parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RepeatedRules parseFrom​(com.google.protobuf.CodedInputStream input)  
      static RepeatedRules parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RepeatedRules parseFrom​(java.io.InputStream input)  
      static RepeatedRules parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RepeatedRules parseFrom​(java.nio.ByteBuffer data)  
      static RepeatedRules parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<RepeatedRules> parser()  
      RepeatedRules.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashFields, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

      • hasMinItems

        public 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 [(.buf.validate.priv.field) = { ... }
        Specified by:
        hasMinItems in interface RepeatedRulesOrBuilder
        Returns:
        Whether the minItems field is set.

      • getMinItems

        public long getMinItems()
         `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 [(.buf.validate.priv.field) = { ... }
        Specified by:
        getMinItems in interface RepeatedRulesOrBuilder
        Returns:
        The minItems.

      • hasMaxItems

        public 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 [(.buf.validate.priv.field) = { ... }
        Specified by:
        hasMaxItems in interface RepeatedRulesOrBuilder
        Returns:
        Whether the maxItems field is set.

      • getMaxItems

        public long getMaxItems()
         `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 [(.buf.validate.priv.field) = { ... }
        Specified by:
        getMaxItems in interface RepeatedRulesOrBuilder
        Returns:
        The maxItems.

      • hasUnique

        public 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 [(.buf.validate.priv.field) = { ... }
        Specified by:
        hasUnique in interface RepeatedRulesOrBuilder
        Returns:
        Whether the unique field is set.

      • getUnique

        public boolean getUnique()
         `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 [(.buf.validate.priv.field) = { ... }
        Specified by:
        getUnique in interface RepeatedRulesOrBuilder
        Returns:
        The unique.

      • hasItems

        public 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;
        Specified by:
        hasItems in interface RepeatedRulesOrBuilder
        Returns:
        Whether the items field is set.

      • getItems

        public 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;
        Specified by:
        getItems in interface RepeatedRulesOrBuilder
        Returns:
        The items.

      • getItemsOrBuilder

        public FieldConstraintsOrBuilder getItemsOrBuilder()
         `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;
        Specified by:
        getItemsOrBuilder in interface RepeatedRulesOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static RepeatedRules parseFrom​(java.nio.ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RepeatedRules parseFrom​(java.nio.ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RepeatedRules parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RepeatedRules parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RepeatedRules parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RepeatedRules parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RepeatedRules parseFrom​(java.io.InputStream input)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static RepeatedRules parseFrom​(java.io.InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static RepeatedRules parseDelimitedFrom​(java.io.InputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static RepeatedRules parseDelimitedFrom​(java.io.InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static RepeatedRules parseFrom​(com.google.protobuf.CodedInputStream input)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static RepeatedRules parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public RepeatedRules.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public RepeatedRules.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected RepeatedRules.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • getDefaultInstance

        public static RepeatedRules getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<RepeatedRules> parser()

      • getParserForType

        public com.google.protobuf.Parser<RepeatedRules> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessage

      • getDefaultInstanceForType

        public RepeatedRules getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder