Package build.buf.validate

Class MapRules

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
build.buf.validate.MapRules
All Implemented Interfaces:
MapRulesOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class MapRules extends com.google.protobuf.GeneratedMessageV3 implements MapRulesOrBuilder
 MapRules describe the constraints applied to `map` values.
Protobuf type buf.validate.MapRules
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MapRules.Builder
    MapRules describe the constraints applied to `map` values.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    KEYS_FIELD_NUMBER
     
    static final int
    MAX_PAIRS_FIELD_NUMBER
     
    static final int
    MIN_PAIRS_FIELD_NUMBER
     
    static final int
    VALUES_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static MapRules
    getDefaultInstance()
     
    MapRules
    getDefaultInstanceForType()
     
    static final 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.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static MapRules.Builder
    newBuilder()
     
    static MapRules.Builder
    newBuilder(MapRules prototype)
     
    MapRules.Builder
    newBuilderForType()
     
    protected MapRules.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static MapRules
    parseDelimitedFrom(InputStream input)
     
    static MapRules
    parseDelimitedFrom(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(InputStream input)
     
    static MapRules
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MapRules
    parseFrom(ByteBuffer data)
     
    static MapRules
    parseFrom(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.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, 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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • 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 [json_name = "minPairs", (.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 [json_name = "minPairs", (.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 [json_name = "maxPairs", (.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 [json_name = "maxPairs", (.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 [json_name = "keys"];
      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 [json_name = "keys"];
      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 [json_name = "keys"];
      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 [json_name = "values"];
      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 [json_name = "values"];
      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 [json_name = "values"];
      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.GeneratedMessageV3

    • writeTo

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

    • getSerializedSize

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

    • equals

      public boolean equals(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MapRules parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static MapRules parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static MapRules.Builder newBuilder()

    • newBuilder

      public static MapRules.Builder newBuilder(MapRules prototype)

    • 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.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • 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.GeneratedMessageV3

    • getDefaultInstanceForType

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