Package build.buf.validate

Class MapRules

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MapRules.Builder
      MapRules describe the constraints applied to `map` 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 KEYS_FIELD_NUMBER  
      static int MAX_PAIRS_FIELD_NUMBER  
      static int MIN_PAIRS_FIELD_NUMBER  
      static int VALUES_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 MapRules getDefaultInstance()  
      MapRules getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      FieldConstraints getKeys()
      Specifies the constraints to be applied to each key in the field.
      FieldConstraintsOrBuilder getKeysOrBuilder()
      Specifies the constraints to be applied to each key in the field.
      long getMaxPairs()
      Specifies the maximum number of key-value pairs allowed.
      long getMinPairs()
      Specifies the minimum number of key-value pairs allowed.
      com.google.protobuf.Parser<MapRules> getParserForType()  
      int getSerializedSize()  
      FieldConstraints getValues()
      Specifies the constraints to be applied to the value of each key in the field.
      FieldConstraintsOrBuilder getValuesOrBuilder()
      Specifies the constraints to be applied to the value of each key in the field.
      int hashCode()  
      boolean hasKeys()
      Specifies the constraints to be applied to each key in the field.
      boolean hasMaxPairs()
      Specifies the maximum number of key-value pairs allowed.
      boolean hasMinPairs()
      Specifies the minimum number of key-value pairs allowed.
      boolean hasValues()
      Specifies the constraints to be applied to the value of each key in the field.
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static MapRules.Builder newBuilder()  
      static MapRules.Builder newBuilder​(MapRules prototype)  
      MapRules.Builder newBuilderForType()  
      protected MapRules.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static MapRules parseDelimitedFrom​(java.io.InputStream input)  
      static MapRules parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MapRules parseFrom​(byte[] data)  
      static MapRules parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MapRules parseFrom​(com.google.protobuf.ByteString data)  
      static MapRules parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MapRules parseFrom​(com.google.protobuf.CodedInputStream input)  
      static MapRules parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MapRules parseFrom​(java.io.InputStream input)  
      static MapRules parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MapRules parseFrom​(java.nio.ByteBuffer data)  
      static MapRules parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<MapRules> parser()  
      MapRules.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

      • hasMinPairs

        public boolean hasMinPairs()
         Specifies the minimum number of key-value pairs allowed. If the field has
 fewer key-value pairs than specified, an error message is generated.

 ```proto
 message MyMap {
 // The field `value` must have at least 2 key-value pairs.
 map<string, string> value = 1 [(buf.validate.field).map.min_pairs = 2];
 }
 ```
        optional uint64 min_pairs = 1 [(.buf.validate.priv.field) = { ... }
        Specified by:
        hasMinPairs in interface MapRulesOrBuilder
        Returns:
        Whether the minPairs field is set.

      • getMinPairs

        public long getMinPairs()
         Specifies the minimum number of key-value pairs allowed. If the field has
 fewer key-value pairs than specified, an error message is generated.

 ```proto
 message MyMap {
 // The field `value` must have at least 2 key-value pairs.
 map<string, string> value = 1 [(buf.validate.field).map.min_pairs = 2];
 }
 ```
        optional uint64 min_pairs = 1 [(.buf.validate.priv.field) = { ... }
        Specified by:
        getMinPairs in interface MapRulesOrBuilder
        Returns:
        The minPairs.

      • hasMaxPairs

        public boolean hasMaxPairs()
         Specifies the maximum number of key-value pairs allowed. If the field has
 more key-value pairs than specified, an error message is generated.

 ```proto
 message MyMap {
 // The field `value` must have at most 3 key-value pairs.
 map<string, string> value = 1 [(buf.validate.field).map.max_pairs = 3];
 }
 ```
        optional uint64 max_pairs = 2 [(.buf.validate.priv.field) = { ... }
        Specified by:
        hasMaxPairs in interface MapRulesOrBuilder
        Returns:
        Whether the maxPairs field is set.

      • getMaxPairs

        public long getMaxPairs()
         Specifies the maximum number of key-value pairs allowed. If the field has
 more key-value pairs than specified, an error message is generated.

 ```proto
 message MyMap {
 // The field `value` must have at most 3 key-value pairs.
 map<string, string> value = 1 [(buf.validate.field).map.max_pairs = 3];
 }
 ```
        optional uint64 max_pairs = 2 [(.buf.validate.priv.field) = { ... }
        Specified by:
        getMaxPairs in interface MapRulesOrBuilder
        Returns:
        The maxPairs.

      • hasKeys

        public boolean hasKeys()
         Specifies the constraints to be applied to each key in the field.

 ```proto
 message MyMap {
 // The keys in the field `value` must follow the specified constraints.
 map<string, string> value = 1 [(buf.validate.field).map.keys = {
 string: {
 min_len: 3
 max_len: 10
 }
 }];
 }
 ```
        optional .buf.validate.FieldConstraints keys = 4;
        Specified by:
        hasKeys in interface MapRulesOrBuilder
        Returns:
        Whether the keys field is set.

      • getKeys

        public FieldConstraints getKeys()
         Specifies the constraints to be applied to each key in the field.

 ```proto
 message MyMap {
 // The keys in the field `value` must follow the specified constraints.
 map<string, string> value = 1 [(buf.validate.field).map.keys = {
 string: {
 min_len: 3
 max_len: 10
 }
 }];
 }
 ```
        optional .buf.validate.FieldConstraints keys = 4;
        Specified by:
        getKeys in interface MapRulesOrBuilder
        Returns:
        The keys.

      • getKeysOrBuilder

        public FieldConstraintsOrBuilder getKeysOrBuilder()
         Specifies the constraints to be applied to each key in the field.

 ```proto
 message MyMap {
 // The keys in the field `value` must follow the specified constraints.
 map<string, string> value = 1 [(buf.validate.field).map.keys = {
 string: {
 min_len: 3
 max_len: 10
 }
 }];
 }
 ```
        optional .buf.validate.FieldConstraints keys = 4;
        Specified by:
        getKeysOrBuilder in interface MapRulesOrBuilder

      • hasValues

        public boolean hasValues()
         Specifies the constraints to be applied to the value of each key in the
 field. Message values will still have their validations evaluated unless
 skip is specified here.

 ```proto
 message MyMap {
 // The values in the field `value` must follow the specified constraints.
 map<string, string> value = 1 [(buf.validate.field).map.values = {
 string: {
 min_len: 5
 max_len: 20
 }
 }];
 }
 ```
        optional .buf.validate.FieldConstraints values = 5;
        Specified by:
        hasValues in interface MapRulesOrBuilder
        Returns:
        Whether the values field is set.

      • getValues

        public FieldConstraints getValues()
         Specifies the constraints to be applied to the value of each key in the
 field. Message values will still have their validations evaluated unless
 skip is specified here.

 ```proto
 message MyMap {
 // The values in the field `value` must follow the specified constraints.
 map<string, string> value = 1 [(buf.validate.field).map.values = {
 string: {
 min_len: 5
 max_len: 20
 }
 }];
 }
 ```
        optional .buf.validate.FieldConstraints values = 5;
        Specified by:
        getValues in interface MapRulesOrBuilder
        Returns:
        The values.

      • getValuesOrBuilder

        public FieldConstraintsOrBuilder getValuesOrBuilder()
         Specifies the constraints to be applied to the value of each key in the
 field. Message values will still have their validations evaluated unless
 skip is specified here.

 ```proto
 message MyMap {
 // The values in the field `value` must follow the specified constraints.
 map<string, string> value = 1 [(buf.validate.field).map.values = {
 string: {
 min_len: 5
 max_len: 20
 }
 }];
 }
 ```
        optional .buf.validate.FieldConstraints values = 5;
        Specified by:
        getValuesOrBuilder in interface MapRulesOrBuilder

      • 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 MapRules parseFrom​(java.nio.ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static MapRules getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<MapRules> 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 MapRules getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder