Package build.buf.validate

Class FieldPathElement

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
build.buf.validate.FieldPathElement
All Implemented Interfaces:
FieldPathElementOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class FieldPathElement extends com.google.protobuf.GeneratedMessage implements FieldPathElementOrBuilder
 `FieldPathElement` provides enough information to nest through a single protobuf field.

 If the selected field is a map or repeated field, the `subscript` value selects a specific element from it.
 A path that refers to a value nested under a map key or repeated field index will have a `subscript` value.
 The `field_type` field allows unambiguous resolution of a field even if descriptors are not available.
Protobuf type buf.validate.FieldPathElement
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FieldPathElement.Builder
    `FieldPathElement` provides enough information to nest through a single protobuf field.
    static enum 
    FieldPathElement.SubscriptCase
     

    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>, 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 final int
    BOOL_KEY_FIELD_NUMBER
     
    static final int
    FIELD_NAME_FIELD_NUMBER
     
    static final int
    FIELD_NUMBER_FIELD_NUMBER
     
    static final int
    FIELD_TYPE_FIELD_NUMBER
     
    static final int
    INDEX_FIELD_NUMBER
     
    static final int
    INT_KEY_FIELD_NUMBER
     
    static final int
    KEY_TYPE_FIELD_NUMBER
     
    static final int
    STRING_KEY_FIELD_NUMBER
     
    static final int
    UINT_KEY_FIELD_NUMBER
     
    static final int
    VALUE_TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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)
     
    boolean
    getBoolKey()
    `bool_key` specifies a map key of type bool.
    static FieldPathElement
    getDefaultInstance()
     
    FieldPathElement
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getFieldName()
    `field_name` contains the field name this path element refers to.
    com.google.protobuf.ByteString
    getFieldNameBytes()
    `field_name` contains the field name this path element refers to.
    int
    getFieldNumber()
    `field_number` is the field number this path element refers to.
    com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Type
    getFieldType()
    `field_type` specifies the type of this field.
    long
    getIndex()
    `index` specifies a 0-based index into a repeated field.
    long
    getIntKey()
    `int_key` specifies a map key of type int32, int64, sint32, sint64, sfixed32 or sfixed64.
    com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Type
    getKeyType()
    `key_type` specifies the map key type of this field.
    com.google.protobuf.Parser<FieldPathElement>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getStringKey()
    `string_key` specifies a map key of type string.
    com.google.protobuf.ByteString
    getStringKeyBytes()
    `string_key` specifies a map key of type string.
    FieldPathElement.SubscriptCase
    getSubscriptCase()
     
    long
    getUintKey()
    `uint_key` specifies a map key of type uint32, uint64, fixed32 or fixed64.
    com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Type
    getValueType()
    `value_type` specifies map value type of this field.
    boolean
    hasBoolKey()
    `bool_key` specifies a map key of type bool.
    boolean
    hasFieldName()
    `field_name` contains the field name this path element refers to.
    boolean
    hasFieldNumber()
    `field_number` is the field number this path element refers to.
    boolean
    hasFieldType()
    `field_type` specifies the type of this field.
    int
    hashCode()
     
    boolean
    hasIndex()
    `index` specifies a 0-based index into a repeated field.
    boolean
    hasIntKey()
    `int_key` specifies a map key of type int32, int64, sint32, sint64, sfixed32 or sfixed64.
    boolean
    hasKeyType()
    `key_type` specifies the map key type of this field.
    boolean
    hasStringKey()
    `string_key` specifies a map key of type string.
    boolean
    hasUintKey()
    `uint_key` specifies a map key of type uint32, uint64, fixed32 or fixed64.
    boolean
    hasValueType()
    `value_type` specifies map value type of this field.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FieldPathElement.Builder
    newBuilder()
     
    static FieldPathElement.Builder
    newBuilder(FieldPathElement prototype)
     
    FieldPathElement.Builder
    newBuilderForType()
     
    protected FieldPathElement.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static FieldPathElement
    parseDelimitedFrom(InputStream input)
     
    static FieldPathElement
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPathElement
    parseFrom(byte[] data)
     
    static FieldPathElement
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPathElement
    parseFrom(com.google.protobuf.ByteString data)
     
    static FieldPathElement
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPathElement
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FieldPathElement
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPathElement
    parseFrom(InputStream input)
     
    static FieldPathElement
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FieldPathElement
    parseFrom(ByteBuffer data)
     
    static FieldPathElement
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FieldPathElement>
    parser()
     
    FieldPathElement.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, makeExtensionsImmutable, 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

  • Field Details

  • Method Details

    • 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

    • getSubscriptCase

      public FieldPathElement.SubscriptCase getSubscriptCase()
      Specified by:
      getSubscriptCase in interface FieldPathElementOrBuilder

    • hasFieldNumber

      public boolean hasFieldNumber()
       `field_number` is the field number this path element refers to.
      optional int32 field_number = 1 [json_name = "fieldNumber"];
      Specified by:
      hasFieldNumber in interface FieldPathElementOrBuilder
      Returns:
      Whether the fieldNumber field is set.

    • getFieldNumber

      public int getFieldNumber()
       `field_number` is the field number this path element refers to.
      optional int32 field_number = 1 [json_name = "fieldNumber"];
      Specified by:
      getFieldNumber in interface FieldPathElementOrBuilder
      Returns:
      The fieldNumber.

    • hasFieldName

      public boolean hasFieldName()
       `field_name` contains the field name this path element refers to.
 This can be used to display a human-readable path even if the field number is unknown.
      optional string field_name = 2 [json_name = "fieldName"];
      Specified by:
      hasFieldName in interface FieldPathElementOrBuilder
      Returns:
      Whether the fieldName field is set.

    • getFieldName

      public String getFieldName()
       `field_name` contains the field name this path element refers to.
 This can be used to display a human-readable path even if the field number is unknown.
      optional string field_name = 2 [json_name = "fieldName"];
      Specified by:
      getFieldName in interface FieldPathElementOrBuilder
      Returns:
      The fieldName.

    • getFieldNameBytes

      public com.google.protobuf.ByteString getFieldNameBytes()
       `field_name` contains the field name this path element refers to.
 This can be used to display a human-readable path even if the field number is unknown.
      optional string field_name = 2 [json_name = "fieldName"];
      Specified by:
      getFieldNameBytes in interface FieldPathElementOrBuilder
      Returns:
      The bytes for fieldName.

    • hasFieldType

      public boolean hasFieldType()
       `field_type` specifies the type of this field. When using reflection, this value is not needed.

 This value is provided to make it possible to traverse unknown fields through wire data.
 When traversing wire data, be mindful of both packed[1] and delimited[2] encoding schemes.

 [1]: https://protobuf.dev/programming-guides/encoding/#packed
 [2]: https://protobuf.dev/programming-guides/encoding/#groups

 N.B.: Although groups are deprecated, the corresponding delimited encoding scheme is not, and
 can be explicitly used in Protocol Buffers 2023 Edition.
      optional .google.protobuf.FieldDescriptorProto.Type field_type = 3 [json_name = "fieldType"];
      Specified by:
      hasFieldType in interface FieldPathElementOrBuilder
      Returns:
      Whether the fieldType field is set.

    • getFieldType

      public com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Type getFieldType()
       `field_type` specifies the type of this field. When using reflection, this value is not needed.

 This value is provided to make it possible to traverse unknown fields through wire data.
 When traversing wire data, be mindful of both packed[1] and delimited[2] encoding schemes.

 [1]: https://protobuf.dev/programming-guides/encoding/#packed
 [2]: https://protobuf.dev/programming-guides/encoding/#groups

 N.B.: Although groups are deprecated, the corresponding delimited encoding scheme is not, and
 can be explicitly used in Protocol Buffers 2023 Edition.
      optional .google.protobuf.FieldDescriptorProto.Type field_type = 3 [json_name = "fieldType"];
      Specified by:
      getFieldType in interface FieldPathElementOrBuilder
      Returns:
      The fieldType.

    • hasKeyType

      public boolean hasKeyType()
       `key_type` specifies the map key type of this field. This value is useful when traversing
 unknown fields through wire data: specifically, it allows handling the differences between
 different integer encodings.
      optional .google.protobuf.FieldDescriptorProto.Type key_type = 4 [json_name = "keyType"];
      Specified by:
      hasKeyType in interface FieldPathElementOrBuilder
      Returns:
      Whether the keyType field is set.

    • getKeyType

      public com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Type getKeyType()
       `key_type` specifies the map key type of this field. This value is useful when traversing
 unknown fields through wire data: specifically, it allows handling the differences between
 different integer encodings.
      optional .google.protobuf.FieldDescriptorProto.Type key_type = 4 [json_name = "keyType"];
      Specified by:
      getKeyType in interface FieldPathElementOrBuilder
      Returns:
      The keyType.

    • hasValueType

      public boolean hasValueType()
       `value_type` specifies map value type of this field. This is useful if you want to display a
 value inside unknown fields through wire data.
      optional .google.protobuf.FieldDescriptorProto.Type value_type = 5 [json_name = "valueType"];
      Specified by:
      hasValueType in interface FieldPathElementOrBuilder
      Returns:
      Whether the valueType field is set.

    • getValueType

      public com.google.protobuf.DescriptorProtos.FieldDescriptorProto.Type getValueType()
       `value_type` specifies map value type of this field. This is useful if you want to display a
 value inside unknown fields through wire data.
      optional .google.protobuf.FieldDescriptorProto.Type value_type = 5 [json_name = "valueType"];
      Specified by:
      getValueType in interface FieldPathElementOrBuilder
      Returns:
      The valueType.

    • hasIndex

      public boolean hasIndex()
       `index` specifies a 0-based index into a repeated field.
      uint64 index = 6 [json_name = "index"];
      Specified by:
      hasIndex in interface FieldPathElementOrBuilder
      Returns:
      Whether the index field is set.

    • getIndex

      public long getIndex()
       `index` specifies a 0-based index into a repeated field.
      uint64 index = 6 [json_name = "index"];
      Specified by:
      getIndex in interface FieldPathElementOrBuilder
      Returns:
      The index.

    • hasBoolKey

      public boolean hasBoolKey()
       `bool_key` specifies a map key of type bool.
      bool bool_key = 7 [json_name = "boolKey"];
      Specified by:
      hasBoolKey in interface FieldPathElementOrBuilder
      Returns:
      Whether the boolKey field is set.

    • getBoolKey

      public boolean getBoolKey()
       `bool_key` specifies a map key of type bool.
      bool bool_key = 7 [json_name = "boolKey"];
      Specified by:
      getBoolKey in interface FieldPathElementOrBuilder
      Returns:
      The boolKey.

    • hasIntKey

      public boolean hasIntKey()
       `int_key` specifies a map key of type int32, int64, sint32, sint64, sfixed32 or sfixed64.
      int64 int_key = 8 [json_name = "intKey"];
      Specified by:
      hasIntKey in interface FieldPathElementOrBuilder
      Returns:
      Whether the intKey field is set.

    • getIntKey

      public long getIntKey()
       `int_key` specifies a map key of type int32, int64, sint32, sint64, sfixed32 or sfixed64.
      int64 int_key = 8 [json_name = "intKey"];
      Specified by:
      getIntKey in interface FieldPathElementOrBuilder
      Returns:
      The intKey.

    • hasUintKey

      public boolean hasUintKey()
       `uint_key` specifies a map key of type uint32, uint64, fixed32 or fixed64.
      uint64 uint_key = 9 [json_name = "uintKey"];
      Specified by:
      hasUintKey in interface FieldPathElementOrBuilder
      Returns:
      Whether the uintKey field is set.

    • getUintKey

      public long getUintKey()
       `uint_key` specifies a map key of type uint32, uint64, fixed32 or fixed64.
      uint64 uint_key = 9 [json_name = "uintKey"];
      Specified by:
      getUintKey in interface FieldPathElementOrBuilder
      Returns:
      The uintKey.

    • hasStringKey

      public boolean hasStringKey()
       `string_key` specifies a map key of type string.
      string string_key = 10 [json_name = "stringKey"];
      Specified by:
      hasStringKey in interface FieldPathElementOrBuilder
      Returns:
      Whether the stringKey field is set.

    • getStringKey

      public String getStringKey()
       `string_key` specifies a map key of type string.
      string string_key = 10 [json_name = "stringKey"];
      Specified by:
      getStringKey in interface FieldPathElementOrBuilder
      Returns:
      The stringKey.

    • getStringKeyBytes

      public com.google.protobuf.ByteString getStringKeyBytes()
       `string_key` specifies a map key of type string.
      string string_key = 10 [json_name = "stringKey"];
      Specified by:
      getStringKeyBytes in interface FieldPathElementOrBuilder
      Returns:
      The bytes for stringKey.

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      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(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 FieldPathElement parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FieldPathElement parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static FieldPathElement parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FieldPathElement.Builder newBuilder()

    • newBuilder

      public static FieldPathElement.Builder newBuilder(FieldPathElement prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FieldPathElement getDefaultInstance()

    • parser

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

    • getParserForType

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