Package build.buf.validate

Class EnumRules

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  EnumRules.Builder
      EnumRules describe the constraints applied to `enum` 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 CONST_FIELD_NUMBER  
      static int DEFINED_ONLY_FIELD_NUMBER  
      static int IN_FIELD_NUMBER  
      static int NOT_IN_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)  
      int getConst()
      `const` requires the field value to exactly match the specified enum value.
      static EnumRules getDefaultInstance()  
      EnumRules getDefaultInstanceForType()  
      boolean getDefinedOnly()
      `defined_only` requires the field value to be one of the defined values for this enum, failing on any undefined value.
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      int getIn​(int index)
      `in` requires the field value to be equal to one of the specified enum values.
      int getInCount()
      `in` requires the field value to be equal to one of the specified enum values.
      java.util.List<java.lang.Integer> getInList()
      `in` requires the field value to be equal to one of the specified enum values.
      int getNotIn​(int index)
      `not_in` requires the field value to be not equal to any of the specified enum values.
      int getNotInCount()
      `not_in` requires the field value to be not equal to any of the specified enum values.
      java.util.List<java.lang.Integer> getNotInList()
      `not_in` requires the field value to be not equal to any of the specified enum values.
      com.google.protobuf.Parser<EnumRules> getParserForType()  
      int getSerializedSize()  
      boolean hasConst()
      `const` requires the field value to exactly match the specified enum value.
      boolean hasDefinedOnly()
      `defined_only` requires the field value to be one of the defined values for this enum, failing on any undefined value.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static EnumRules.Builder newBuilder()  
      static EnumRules.Builder newBuilder​(EnumRules prototype)  
      EnumRules.Builder newBuilderForType()  
      protected EnumRules.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static EnumRules parseDelimitedFrom​(java.io.InputStream input)  
      static EnumRules parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static EnumRules parseFrom​(byte[] data)  
      static EnumRules parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static EnumRules parseFrom​(com.google.protobuf.ByteString data)  
      static EnumRules parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static EnumRules parseFrom​(com.google.protobuf.CodedInputStream input)  
      static EnumRules parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static EnumRules parseFrom​(java.io.InputStream input)  
      static EnumRules parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static EnumRules parseFrom​(java.nio.ByteBuffer data)  
      static EnumRules parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<EnumRules> parser()  
      EnumRules.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

      • hasConst

        public boolean hasConst()
         `const` requires the field value to exactly match the specified enum value.
 If the field value doesn't match, an error message is generated.

 ```proto
 enum MyEnum {
 MY_ENUM_UNSPECIFIED = 0;
 MY_ENUM_VALUE1 = 1;
 MY_ENUM_VALUE2 = 2;
 }

 message MyMessage {
 // The field `value` must be exactly MY_ENUM_VALUE1.
 MyEnum value = 1 [(buf.validate.field).enum.const = 1];
 }
 ```
        optional int32 const = 1 [(.buf.validate.priv.field) = { ... }
        Specified by:
        hasConst in interface EnumRulesOrBuilder
        Returns:
        Whether the const field is set.

      • getConst

        public int getConst()
         `const` requires the field value to exactly match the specified enum value.
 If the field value doesn't match, an error message is generated.

 ```proto
 enum MyEnum {
 MY_ENUM_UNSPECIFIED = 0;
 MY_ENUM_VALUE1 = 1;
 MY_ENUM_VALUE2 = 2;
 }

 message MyMessage {
 // The field `value` must be exactly MY_ENUM_VALUE1.
 MyEnum value = 1 [(buf.validate.field).enum.const = 1];
 }
 ```
        optional int32 const = 1 [(.buf.validate.priv.field) = { ... }
        Specified by:
        getConst in interface EnumRulesOrBuilder
        Returns:
        The const.

      • hasDefinedOnly

        public boolean hasDefinedOnly()
         `defined_only` requires the field value to be one of the defined values for
 this enum, failing on any undefined value.

 ```proto
 enum MyEnum {
 MY_ENUM_UNSPECIFIED = 0;
 MY_ENUM_VALUE1 = 1;
 MY_ENUM_VALUE2 = 2;
 }

 message MyMessage {
 // The field `value` must be a defined value of MyEnum.
 MyEnum value = 1 [(buf.validate.field).enum.defined_only = true];
 }
 ```
        optional bool defined_only = 2;
        Specified by:
        hasDefinedOnly in interface EnumRulesOrBuilder
        Returns:
        Whether the definedOnly field is set.

      • getDefinedOnly

        public boolean getDefinedOnly()
         `defined_only` requires the field value to be one of the defined values for
 this enum, failing on any undefined value.

 ```proto
 enum MyEnum {
 MY_ENUM_UNSPECIFIED = 0;
 MY_ENUM_VALUE1 = 1;
 MY_ENUM_VALUE2 = 2;
 }

 message MyMessage {
 // The field `value` must be a defined value of MyEnum.
 MyEnum value = 1 [(buf.validate.field).enum.defined_only = true];
 }
 ```
        optional bool defined_only = 2;
        Specified by:
        getDefinedOnly in interface EnumRulesOrBuilder
        Returns:
        The definedOnly.

      • getInList

        public java.util.List<java.lang.Integer> getInList()
         `in` requires the field value to be equal to one of the
 specified enum values. If the field value doesn't match any of the
 specified values, an error message is generated.

 ```proto
 enum MyEnum {
 MY_ENUM_UNSPECIFIED = 0;
 MY_ENUM_VALUE1 = 1;
 MY_ENUM_VALUE2 = 2;
 }

 message MyMessage {
 // The field `value` must be equal to one of the specified values.
 MyEnum value = 1 [(buf.validate.field).enum = { in: [1, 2]}];
 }
 ```
        repeated int32 in = 3 [(.buf.validate.priv.field) = { ... }
        Specified by:
        getInList in interface EnumRulesOrBuilder
        Returns:
        A list containing the in.

      • getInCount

        public int getInCount()
         `in` requires the field value to be equal to one of the
 specified enum values. If the field value doesn't match any of the
 specified values, an error message is generated.

 ```proto
 enum MyEnum {
 MY_ENUM_UNSPECIFIED = 0;
 MY_ENUM_VALUE1 = 1;
 MY_ENUM_VALUE2 = 2;
 }

 message MyMessage {
 // The field `value` must be equal to one of the specified values.
 MyEnum value = 1 [(buf.validate.field).enum = { in: [1, 2]}];
 }
 ```
        repeated int32 in = 3 [(.buf.validate.priv.field) = { ... }
        Specified by:
        getInCount in interface EnumRulesOrBuilder
        Returns:
        The count of in.

      • getIn

        public int getIn​(int index)
         `in` requires the field value to be equal to one of the
 specified enum values. If the field value doesn't match any of the
 specified values, an error message is generated.

 ```proto
 enum MyEnum {
 MY_ENUM_UNSPECIFIED = 0;
 MY_ENUM_VALUE1 = 1;
 MY_ENUM_VALUE2 = 2;
 }

 message MyMessage {
 // The field `value` must be equal to one of the specified values.
 MyEnum value = 1 [(buf.validate.field).enum = { in: [1, 2]}];
 }
 ```
        repeated int32 in = 3 [(.buf.validate.priv.field) = { ... }
        Specified by:
        getIn in interface EnumRulesOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The in at the given index.

      • getNotInList

        public java.util.List<java.lang.Integer> getNotInList()
         `not_in` requires the field value to be not equal to any of the
 specified enum values. If the field value matches one of the specified
 values, an error message is generated.

 ```proto
 enum MyEnum {
 MY_ENUM_UNSPECIFIED = 0;
 MY_ENUM_VALUE1 = 1;
 MY_ENUM_VALUE2 = 2;
 }

 message MyMessage {
 // The field `value` must not be equal to any of the specified values.
 MyEnum value = 1 [(buf.validate.field).enum = { not_in: [1, 2]}];
 }
 ```
        repeated int32 not_in = 4 [(.buf.validate.priv.field) = { ... }
        Specified by:
        getNotInList in interface EnumRulesOrBuilder
        Returns:
        A list containing the notIn.

      • getNotInCount

        public int getNotInCount()
         `not_in` requires the field value to be not equal to any of the
 specified enum values. If the field value matches one of the specified
 values, an error message is generated.

 ```proto
 enum MyEnum {
 MY_ENUM_UNSPECIFIED = 0;
 MY_ENUM_VALUE1 = 1;
 MY_ENUM_VALUE2 = 2;
 }

 message MyMessage {
 // The field `value` must not be equal to any of the specified values.
 MyEnum value = 1 [(buf.validate.field).enum = { not_in: [1, 2]}];
 }
 ```
        repeated int32 not_in = 4 [(.buf.validate.priv.field) = { ... }
        Specified by:
        getNotInCount in interface EnumRulesOrBuilder
        Returns:
        The count of notIn.

      • getNotIn

        public int getNotIn​(int index)
         `not_in` requires the field value to be not equal to any of the
 specified enum values. If the field value matches one of the specified
 values, an error message is generated.

 ```proto
 enum MyEnum {
 MY_ENUM_UNSPECIFIED = 0;
 MY_ENUM_VALUE1 = 1;
 MY_ENUM_VALUE2 = 2;
 }

 message MyMessage {
 // The field `value` must not be equal to any of the specified values.
 MyEnum value = 1 [(buf.validate.field).enum = { not_in: [1, 2]}];
 }
 ```
        repeated int32 not_in = 4 [(.buf.validate.priv.field) = { ... }
        Specified by:
        getNotIn in interface EnumRulesOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The notIn at the given index.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static EnumRules getDefaultInstance()

      • parser

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

      • getParserForType

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