Package com.google.protobuf
Interface DescriptorProtos.FieldOptionsOrBuilder
- All Superinterfaces:
GeneratedMessageV3.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions>
,MessageLiteOrBuilder
,MessageOrBuilder
- All Known Implementing Classes:
DescriptorProtos.FieldOptions
,DescriptorProtos.FieldOptions.Builder
- Enclosing class:
- DescriptorProtos
public static interface DescriptorProtos.FieldOptionsOrBuilder
extends GeneratedMessageV3.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions>
-
Method Summary
Modifier and TypeMethodDescriptiongetCtype()
The ctype option instructs the C++ code generator to use a different representation of the field than it normally would.boolean
Indicate that the field value should not be printed out when using debug formats, e.g.boolean
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.The jstype option determines the JavaScript type used for values of the field.boolean
getLazy()
Should this field be parsed lazily? Lazy applies only to message-type fields.boolean
The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire.optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
Deprecated.google.protobuf.FieldOptions.target is deprecated.getTargets
(int index) repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
int
repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
getUninterpretedOption
(int index) The parser stores options it doesn't recognize here.int
The parser stores options it doesn't recognize here.The parser stores options it doesn't recognize here.getUninterpretedOptionOrBuilder
(int index) The parser stores options it doesn't recognize here.The parser stores options it doesn't recognize here.boolean
unverified_lazy does no correctness checks on the byte stream.boolean
getWeak()
For Google-internal migration only.boolean
hasCtype()
The ctype option instructs the C++ code generator to use a different representation of the field than it normally would.boolean
Indicate that the field value should not be printed out when using debug formats, e.g.boolean
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.boolean
The jstype option determines the JavaScript type used for values of the field.boolean
hasLazy()
Should this field be parsed lazily? Lazy applies only to message-type fields.boolean
The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire.boolean
optional .google.protobuf.FieldOptions.OptionRetention retention = 17;
boolean
Deprecated.google.protobuf.FieldOptions.target is deprecated.boolean
unverified_lazy does no correctness checks on the byte stream.boolean
hasWeak()
For Google-internal migration only.Methods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder
getDefaultInstanceForType, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension
Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasCtype
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];
- Returns:
- Whether the ctype field is set.
-
getCtype
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];
- 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.
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.
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 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];
- 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 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];
- 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.
-
hasTarget
Deprecated.google.protobuf.FieldOptions.target is deprecated. See google/protobuf/descriptor.proto;l=713optional .google.protobuf.FieldOptions.OptionTargetType target = 18 [deprecated = true];
- Returns:
- Whether the target field is set.
-
getTarget
Deprecated.google.protobuf.FieldOptions.target is deprecated. See google/protobuf/descriptor.proto;l=713optional .google.protobuf.FieldOptions.OptionTargetType target = 18 [deprecated = true];
- Returns:
- The target.
-
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
repeated .google.protobuf.FieldOptions.OptionTargetType targets = 19;
- Parameters:
index
- The index of the element to return.- Returns:
- The targets at the given index.
-
getUninterpretedOptionList
List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-
getUninterpretedOption
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
The parser stores options it doesn't recognize here. See above.
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
-