Interface DescriptorProtos.FieldOptionsOrBuilder

All Superinterfaces:
com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions>, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DescriptorProtos.FieldOptions, DescriptorProtos.FieldOptions.Builder
Enclosing class:
DescriptorProtos
public static interface DescriptorProtos.FieldOptionsOrBuilder extends com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions>

  • Method Details

    • hasCtype

      boolean hasCtype()
       NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead.
 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.
 TODO: make ctype actually deprecated.
      optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
      Returns:
      Whether the ctype field is set.

    • getCtype

      DescriptorProtos.FieldOptions.CType getCtype()
       NOTE: ctype is deprecated. Use `features.(pb.cpp).string_type` instead.
 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.
 TODO: make ctype actually deprecated.
      optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
      Returns:
      The ctype.

    • hasPacked

      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.  This option is prohibited in
 Editions, but the `repeated_field_encoding` feature can be used to control
 the behavior.
      optional bool packed = 2;
      Returns:
      Whether the packed field is set.

    • getPacked

      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.  This option is prohibited in
 Editions, but the `repeated_field_encoding` feature can be used to control
 the behavior.
      optional bool packed = 2;
      Returns:
      The packed.

    • hasJstype

      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];
      Returns:
      Whether the jstype field is set.

    • getJstype

      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];
      Returns:
      The jstype.

    • hasLazy

      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 lazy message fields are still eagerly verified to check
 ill-formed wireformat or missing required fields. Calling IsInitialized()
 on the outer message would fail if the inner message has missing required
 fields. Failed verification would result in parsing failure (except when
 uninitialized messages are acceptable).
      optional bool lazy = 5 [default = false];
      Returns:
      Whether the lazy field is set.

    • getLazy

      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 lazy message fields are still eagerly verified to check
 ill-formed wireformat or missing required fields. Calling IsInitialized()
 on the outer message would fail if the inner message has missing required
 fields. Failed verification would result in parsing failure (except when
 uninitialized messages are acceptable).
      optional bool lazy = 5 [default = false];
      Returns:
      The lazy.

    • hasUnverifiedLazy

      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];
      Returns:
      Whether the unverifiedLazy field is set.

    • getUnverifiedLazy

      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];
      Returns:
      The unverifiedLazy.

    • hasDeprecated

      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];
      Returns:
      Whether the deprecated field is set.

    • getDeprecated

      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];
      Returns:
      The deprecated.

    • hasWeak

      boolean hasWeak()
       For Google-internal migration only. Do not use.
      optional bool weak = 10 [default = false];
      Returns:
      Whether the weak field is set.

    • getWeak

      boolean getWeak()
       For Google-internal migration only. Do not use.
      optional bool weak = 10 [default = false];
      Returns:
      The weak.

    • hasDebugRedact

      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];
      Returns:
      Whether the debugRedact field is set.

    • getDebugRedact

      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];
      Returns:
      The debugRedact.

    • hasRetention

      boolean hasRetention()
      optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
      Returns:
      Whether the retention field is set.

    • getRetention

      DescriptorProtos.FieldOptions.OptionRetention getRetention()
      optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
      Returns:
      The retention.

    • getTargetsList

      List<DescriptorProtos.FieldOptions.OptionTargetType> getTargetsList()
      repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
      Returns:
      A list containing the targets.

    • getTargetsCount

      int getTargetsCount()
      repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
      Returns:
      The count of targets.

    • getTargets

      DescriptorProtos.FieldOptions.OptionTargetType getTargets(int index)
      repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
      Parameters:
      index - The index of the element to return.
      Returns:
      The targets at the given index.

    • getEditionDefaultsList

      List<DescriptorProtos.FieldOptions.EditionDefault> getEditionDefaultsList()
      repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;

    • getEditionDefaults

      DescriptorProtos.FieldOptions.EditionDefault getEditionDefaults(int index)
      repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;

    • getEditionDefaultsCount

      int getEditionDefaultsCount()
      repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;

    • getEditionDefaultsOrBuilderList

      List<? extends DescriptorProtos.FieldOptions.EditionDefaultOrBuilder> getEditionDefaultsOrBuilderList()
      repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;

    • getEditionDefaultsOrBuilder

      DescriptorProtos.FieldOptions.EditionDefaultOrBuilder getEditionDefaultsOrBuilder(int index)
      repeated .google.protobuf.FieldOptions.EditionDefault edition_defaults = 20;

    • hasFeatures

      boolean hasFeatures()
       Any features defined in the specific edition.
      optional .google.protobuf.FeatureSet features = 21;
      Returns:
      Whether the features field is set.

    • getFeatures

      DescriptorProtos.FeatureSet getFeatures()
       Any features defined in the specific edition.
      optional .google.protobuf.FeatureSet features = 21;
      Returns:
      The features.

    • getFeaturesOrBuilder

      DescriptorProtos.FeatureSetOrBuilder getFeaturesOrBuilder()
       Any features defined in the specific edition.
      optional .google.protobuf.FeatureSet features = 21;

    • hasFeatureSupport

      boolean hasFeatureSupport()
      optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
      Returns:
      Whether the featureSupport field is set.

    • getFeatureSupport

      DescriptorProtos.FieldOptions.FeatureSupport getFeatureSupport()
      optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;
      Returns:
      The featureSupport.

    • getFeatureSupportOrBuilder

      DescriptorProtos.FieldOptions.FeatureSupportOrBuilder getFeatureSupportOrBuilder()
      optional .google.protobuf.FieldOptions.FeatureSupport feature_support = 22;

    • getUninterpretedOptionList

      List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()
       The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    • getUninterpretedOption

      DescriptorProtos.UninterpretedOption getUninterpretedOption(int index)
       The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    • getUninterpretedOptionCount

      int getUninterpretedOptionCount()
       The parser stores options it doesn't recognize here. See above.
      repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;

    • getUninterpretedOptionOrBuilderList

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

    • getUninterpretedOptionOrBuilder

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