Package com.google.protobuf

Class DescriptorProtos.FieldOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.ExtendableMessage<DescriptorProtos.FieldOptions,DescriptorProtos.FieldOptions.Builder>
com.google.protobuf.DescriptorProtos.FieldOptions
All Implemented Interfaces:
DescriptorProtos.FieldOptionsOrBuilder, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions,DescriptorProtos.FieldOptions.Builder>, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder
Enclosing class:
DescriptorProtos
public static final class DescriptorProtos.FieldOptions extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<DescriptorProtos.FieldOptions,DescriptorProtos.FieldOptions.Builder> implements DescriptorProtos.FieldOptionsOrBuilder
Protobuf type google.protobuf.FieldOptions

  • Field Details

  • Method Details

    • hasCtype

      public boolean hasCtype()
       The ctype option instructs the C++ code generator to use a different
 representation of the field than it normally would.  See the specific
 options below.  This option is only implemented to support use of
 [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of
 type "bytes" in the open source release -- sorry, we'll try to include
 other types in a future version!
      optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING, json_name = "ctype"];
      Specified by:
      hasCtype in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      Whether the ctype field is set.

    • getCtype

      public DescriptorProtos.FieldOptions.CType getCtype()
       The ctype option instructs the C++ code generator to use a different
 representation of the field than it normally would.  See the specific
 options below.  This option is only implemented to support use of
 [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of
 type "bytes" in the open source release -- sorry, we'll try to include
 other types in a future version!
      optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING, json_name = "ctype"];
      Specified by:
      getCtype in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      The ctype.

    • hasPacked

      public boolean hasPacked()
       The packed option can be enabled for repeated primitive fields to enable
 a more efficient representation on the wire. Rather than repeatedly
 writing the tag and type for each element, the entire array is encoded as
 a single length-delimited blob. In proto3, only explicit setting it to
 false will avoid using packed encoding.
      optional bool packed = 2 [json_name = "packed"];
      Specified by:
      hasPacked in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      Whether the packed field is set.

    • getPacked

      public boolean getPacked()
       The packed option can be enabled for repeated primitive fields to enable
 a more efficient representation on the wire. Rather than repeatedly
 writing the tag and type for each element, the entire array is encoded as
 a single length-delimited blob. In proto3, only explicit setting it to
 false will avoid using packed encoding.
      optional bool packed = 2 [json_name = "packed"];
      Specified by:
      getPacked in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      The packed.

    • hasJstype

      public boolean hasJstype()
       The jstype option determines the JavaScript type used for values of the
 field.  The option is permitted only for 64 bit integral and fixed types
 (int64, uint64, sint64, fixed64, sfixed64).  A field with jstype JS_STRING
 is represented as JavaScript string, which avoids loss of precision that
 can happen when a large value is converted to a floating point JavaScript.
 Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
 use the JavaScript "number" type.  The behavior of the default option
 JS_NORMAL is implementation dependent.

 This option is an enum to permit additional types to be added, e.g.
 goog.math.Integer.
      optional .google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL, json_name = "jstype"];
      Specified by:
      hasJstype in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      Whether the jstype field is set.

    • getJstype

      public DescriptorProtos.FieldOptions.JSType getJstype()
       The jstype option determines the JavaScript type used for values of the
 field.  The option is permitted only for 64 bit integral and fixed types
 (int64, uint64, sint64, fixed64, sfixed64).  A field with jstype JS_STRING
 is represented as JavaScript string, which avoids loss of precision that
 can happen when a large value is converted to a floating point JavaScript.
 Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
 use the JavaScript "number" type.  The behavior of the default option
 JS_NORMAL is implementation dependent.

 This option is an enum to permit additional types to be added, e.g.
 goog.math.Integer.
      optional .google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL, json_name = "jstype"];
      Specified by:
      getJstype in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      The jstype.

    • hasLazy

      public boolean hasLazy()
       Should this field be parsed lazily?  Lazy applies only to message-type
 fields.  It means that when the outer message is initially parsed, the
 inner message's contents will not be parsed but instead stored in encoded
 form.  The inner message will actually be parsed when it is first accessed.

 This is only a hint.  Implementations are free to choose whether to use
 eager or lazy parsing regardless of the value of this option.  However,
 setting this option true suggests that the protocol author believes that
 using lazy parsing on this field is worth the additional bookkeeping
 overhead typically needed to implement it.

 This option does not affect the public interface of any generated code;
 all method signatures remain the same.  Furthermore, thread-safety of the
 interface is not affected by this option; const methods remain safe to
 call from multiple threads concurrently, while non-const methods continue
 to require exclusive access.

 Note that implementations may choose not to check required fields within
 a lazy sub-message.  That is, calling IsInitialized() on the outer message
 may return true even if the inner message has missing required fields.
 This is necessary because otherwise the inner message would have to be
 parsed in order to perform the check, defeating the purpose of lazy
 parsing.  An implementation which chooses not to check required fields
 must be consistent about it.  That is, for any particular sub-message, the
 implementation must either *always* check its required fields, or *never*
 check its required fields, regardless of whether or not the message has
 been parsed.

 As of May 2022, lazy verifies the contents of the byte stream during
 parsing.  An invalid byte stream will cause the overall parsing to fail.
      optional bool lazy = 5 [default = false, json_name = "lazy"];
      Specified by:
      hasLazy in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      Whether the lazy field is set.

    • getLazy

      public boolean getLazy()
       Should this field be parsed lazily?  Lazy applies only to message-type
 fields.  It means that when the outer message is initially parsed, the
 inner message's contents will not be parsed but instead stored in encoded
 form.  The inner message will actually be parsed when it is first accessed.

 This is only a hint.  Implementations are free to choose whether to use
 eager or lazy parsing regardless of the value of this option.  However,
 setting this option true suggests that the protocol author believes that
 using lazy parsing on this field is worth the additional bookkeeping
 overhead typically needed to implement it.

 This option does not affect the public interface of any generated code;
 all method signatures remain the same.  Furthermore, thread-safety of the
 interface is not affected by this option; const methods remain safe to
 call from multiple threads concurrently, while non-const methods continue
 to require exclusive access.

 Note that implementations may choose not to check required fields within
 a lazy sub-message.  That is, calling IsInitialized() on the outer message
 may return true even if the inner message has missing required fields.
 This is necessary because otherwise the inner message would have to be
 parsed in order to perform the check, defeating the purpose of lazy
 parsing.  An implementation which chooses not to check required fields
 must be consistent about it.  That is, for any particular sub-message, the
 implementation must either *always* check its required fields, or *never*
 check its required fields, regardless of whether or not the message has
 been parsed.

 As of May 2022, lazy verifies the contents of the byte stream during
 parsing.  An invalid byte stream will cause the overall parsing to fail.
      optional bool lazy = 5 [default = false, json_name = "lazy"];
      Specified by:
      getLazy in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      The lazy.

    • hasUnverifiedLazy

      public boolean hasUnverifiedLazy()
       unverified_lazy does no correctness checks on the byte stream. This should
 only be used where lazy with verification is prohibitive for performance
 reasons.
      optional bool unverified_lazy = 15 [default = false, json_name = "unverifiedLazy"];
      Specified by:
      hasUnverifiedLazy in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      Whether the unverifiedLazy field is set.

    • getUnverifiedLazy

      public boolean getUnverifiedLazy()
       unverified_lazy does no correctness checks on the byte stream. This should
 only be used where lazy with verification is prohibitive for performance
 reasons.
      optional bool unverified_lazy = 15 [default = false, json_name = "unverifiedLazy"];
      Specified by:
      getUnverifiedLazy in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      The unverifiedLazy.

    • hasDeprecated

      public boolean hasDeprecated()
       Is this field deprecated?
 Depending on the target platform, this can emit Deprecated annotations
 for accessors, or it will be completely ignored; in the very least, this
 is a formalization for deprecating fields.
      optional bool deprecated = 3 [default = false, json_name = "deprecated"];
      Specified by:
      hasDeprecated in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      Whether the deprecated field is set.

    • getDeprecated

      public boolean getDeprecated()
       Is this field deprecated?
 Depending on the target platform, this can emit Deprecated annotations
 for accessors, or it will be completely ignored; in the very least, this
 is a formalization for deprecating fields.
      optional bool deprecated = 3 [default = false, json_name = "deprecated"];
      Specified by:
      getDeprecated in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      The deprecated.

    • hasWeak

      public boolean hasWeak()
       For Google-internal migration only. Do not use.
      optional bool weak = 10 [default = false, json_name = "weak"];
      Specified by:
      hasWeak in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      Whether the weak field is set.

    • getWeak

      public boolean getWeak()
       For Google-internal migration only. Do not use.
      optional bool weak = 10 [default = false, json_name = "weak"];
      Specified by:
      getWeak in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      The weak.

    • hasDebugRedact

      public boolean hasDebugRedact()
       Indicate that the field value should not be printed out when using debug
 formats, e.g. when the field contains sensitive credentials.
      optional bool debug_redact = 16 [default = false, json_name = "debugRedact"];
      Specified by:
      hasDebugRedact in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      Whether the debugRedact field is set.

    • getDebugRedact

      public boolean getDebugRedact()
       Indicate that the field value should not be printed out when using debug
 formats, e.g. when the field contains sensitive credentials.
      optional bool debug_redact = 16 [default = false, json_name = "debugRedact"];
      Specified by:
      getDebugRedact in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      The debugRedact.

    • hasRetention

      public boolean hasRetention()
      optional .google.protobuf.FieldOptions.OptionRetention retention = 17 [json_name = "retention"];
      Specified by:
      hasRetention in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      Whether the retention field is set.

    • getRetention

      public DescriptorProtos.FieldOptions.OptionRetention getRetention()
      optional .google.protobuf.FieldOptions.OptionRetention retention = 17 [json_name = "retention"];
      Specified by:
      getRetention in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      The retention.

    • hasTarget

      @Deprecated public boolean hasTarget()
      Deprecated.
      google.protobuf.FieldOptions.target is deprecated. See google/protobuf/descriptor.proto;l=713
      optional .google.protobuf.FieldOptions.OptionTargetType target = 18 [json_name = "target", deprecated = true];
      Specified by:
      hasTarget in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      Whether the target field is set.

    • getTarget

      @Deprecated public DescriptorProtos.FieldOptions.OptionTargetType getTarget()
      Deprecated.
      google.protobuf.FieldOptions.target is deprecated. See google/protobuf/descriptor.proto;l=713
      optional .google.protobuf.FieldOptions.OptionTargetType target = 18 [json_name = "target", deprecated = true];
      Specified by:
      getTarget in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      The target.

    • getTargetsList

      public List<DescriptorProtos.FieldOptions.OptionTargetType> getTargetsList()
      repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19 [json_name = "targets"];
      Specified by:
      getTargetsList in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      A list containing the targets.

    • getTargetsCount

      public int getTargetsCount()
      repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19 [json_name = "targets"];
      Specified by:
      getTargetsCount in interface DescriptorProtos.FieldOptionsOrBuilder
      Returns:
      The count of targets.

    • getTargets

      public DescriptorProtos.FieldOptions.OptionTargetType getTargets(int index)
      repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19 [json_name = "targets"];
      Specified by:
      getTargets in interface DescriptorProtos.FieldOptionsOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The targets at the given index.

    • getUninterpretedOptionList

      public List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()
       The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999 [json_name = "uninterpretedOption"];
      Specified by:
      getUninterpretedOptionList in interface DescriptorProtos.FieldOptionsOrBuilder

    • getUninterpretedOptionOrBuilderList

      public List<? extends DescriptorProtos.UninterpretedOptionOrBuilder> getUninterpretedOptionOrBuilderList()
       The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999 [json_name = "uninterpretedOption"];

    • getUninterpretedOptionCount

      public int getUninterpretedOptionCount()
       The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999 [json_name = "uninterpretedOption"];
      Specified by:
      getUninterpretedOptionCount in interface DescriptorProtos.FieldOptionsOrBuilder

    • getUninterpretedOption

      public DescriptorProtos.UninterpretedOption getUninterpretedOption(int index)
       The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999 [json_name = "uninterpretedOption"];
      Specified by:
      getUninterpretedOption in interface DescriptorProtos.FieldOptionsOrBuilder

    • getUninterpretedOptionOrBuilder

      public DescriptorProtos.UninterpretedOptionOrBuilder getUninterpretedOptionOrBuilder(int index)
       The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999 [json_name = "uninterpretedOption"];

    • parseFrom

      public static DescriptorProtos.FieldOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static DescriptorProtos.FieldOptions parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static DescriptorProtos.FieldOptions parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static DescriptorProtos.FieldOptions.Builder newBuilder()

    • newBuilder

      public static DescriptorProtos.FieldOptions.Builder newBuilder(DescriptorProtos.FieldOptions prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<DescriptorProtos.FieldOptions,DescriptorProtos.FieldOptions.Builder>

    • getDefaultInstance

      public static DescriptorProtos.FieldOptions getDefaultInstance()

    • parser

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