Package org.yamcs.protobuf.config
Interface OptionInfoOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
OptionInfo
,OptionInfo.Builder
public interface OptionInfoOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptiongetAliases
(int index) Additional names that can be used for this optioncom.google.protobuf.ByteString
getAliasesBytes
(int index) Additional names that can be used for this optionint
Additional names that can be used for this optionAdditional names that can be used for this optionboolean
When the type is ``MAP``, this property determines whether default values are generated even when a value for that option was not provided.com.google.protobuf.Value
getChoices
(int index) Allowed values for this optionint
Allowed values for this optionList<com.google.protobuf.Value>
Allowed values for this optioncom.google.protobuf.ValueOrBuilder
getChoicesOrBuilder
(int index) Allowed values for this optionList<? extends com.google.protobuf.ValueOrBuilder>
Allowed values for this optioncom.google.protobuf.Value
Default value when the option is not specifiedcom.google.protobuf.ValueOrBuilder
Default value when the option is not specifiedDeprecation message for this optioncom.google.protobuf.ByteString
Deprecation message for this optiongetDescription
(int index) Description, each list entry represents a paragraphcom.google.protobuf.ByteString
getDescriptionBytes
(int index) Description, each list entry represents a paragraphint
Description, each list entry represents a paragraphDescription, each list entry represents a paragraphWhen the type is ``LIST`` or ``LIST_OR_ELEMENT``, this indicates the type of each element of that listboolean
Hint that this option should be excluded from any document generationgetName()
Name of this option, unique within a speccom.google.protobuf.ByteString
Name of this option, unique within a specboolean
Whether this options must be specifiedboolean
Hint that value for this option should not be loggedgetSpec()
When the type or elementType is ``MAP``, this specifies the options with that mapWhen the type or elementType is ``MAP``, this specifies the options with that mapgetTitle()
UI-friendly label for this optioncom.google.protobuf.ByteString
UI-friendly label for this optiongetType()
Type of this optionWhich version of this software this option was added.com.google.protobuf.ByteString
Which version of this software this option was added.boolean
When the type is ``MAP``, this property determines whether default values are generated even when a value for that option was not provided.boolean
Default value when the option is not specifiedboolean
Deprecation message for this optionboolean
When the type is ``LIST`` or ``LIST_OR_ELEMENT``, this indicates the type of each element of that listboolean
Hint that this option should be excluded from any document generationboolean
hasName()
Name of this option, unique within a specboolean
Whether this options must be specifiedboolean
Hint that value for this option should not be loggedboolean
hasSpec()
When the type or elementType is ``MAP``, this specifies the options with that mapboolean
hasTitle()
UI-friendly label for this optionboolean
hasType()
Type of this optionboolean
Which version of this software this option was added.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasName
boolean hasName()Name of this option, unique within a spec
optional string name = 1;
- Returns:
- Whether the name field is set.
-
getName
String getName()Name of this option, unique within a spec
optional string name = 1;
- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()Name of this option, unique within a spec
optional string name = 1;
- Returns:
- The bytes for name.
-
hasType
boolean hasType()Type of this option
optional .yamcs.protobuf.config.OptionType type = 2;
- Returns:
- Whether the type field is set.
-
getType
OptionType getType()Type of this option
optional .yamcs.protobuf.config.OptionType type = 2;
- Returns:
- The type.
-
hasTitle
boolean hasTitle()UI-friendly label for this option
optional string title = 3;
- Returns:
- Whether the title field is set.
-
getTitle
String getTitle()UI-friendly label for this option
optional string title = 3;
- Returns:
- The title.
-
getTitleBytes
com.google.protobuf.ByteString getTitleBytes()UI-friendly label for this option
optional string title = 3;
- Returns:
- The bytes for title.
-
hasDefault
boolean hasDefault()Default value when the option is not specified
optional .google.protobuf.Value default = 4;
- Returns:
- Whether the default field is set.
-
getDefault
com.google.protobuf.Value getDefault()Default value when the option is not specified
optional .google.protobuf.Value default = 4;
- Returns:
- The default.
-
getDefaultOrBuilder
com.google.protobuf.ValueOrBuilder getDefaultOrBuilder()Default value when the option is not specified
optional .google.protobuf.Value default = 4;
-
hasRequired
boolean hasRequired()Whether this options must be specified
optional bool required = 5;
- Returns:
- Whether the required field is set.
-
getRequired
boolean getRequired()Whether this options must be specified
optional bool required = 5;
- Returns:
- The required.
-
hasHidden
boolean hasHidden()Hint that this option should be excluded from any document generation
optional bool hidden = 6;
- Returns:
- Whether the hidden field is set.
-
getHidden
boolean getHidden()Hint that this option should be excluded from any document generation
optional bool hidden = 6;
- Returns:
- The hidden.
-
hasSecret
boolean hasSecret()Hint that value for this option should not be logged
optional bool secret = 7;
- Returns:
- Whether the secret field is set.
-
getSecret
boolean getSecret()Hint that value for this option should not be logged
optional bool secret = 7;
- Returns:
- The secret.
-
hasVersionAdded
boolean hasVersionAdded()Which version of this software this option was added. Can be the Yamcs version, or the version of a plugin.
optional string versionAdded = 8;
- Returns:
- Whether the versionAdded field is set.
-
getVersionAdded
String getVersionAdded()Which version of this software this option was added. Can be the Yamcs version, or the version of a plugin.
optional string versionAdded = 8;
- Returns:
- The versionAdded.
-
getVersionAddedBytes
com.google.protobuf.ByteString getVersionAddedBytes()Which version of this software this option was added. Can be the Yamcs version, or the version of a plugin.
optional string versionAdded = 8;
- Returns:
- The bytes for versionAdded.
-
hasDeprecationMessage
boolean hasDeprecationMessage()Deprecation message for this option
optional string deprecationMessage = 9;
- Returns:
- Whether the deprecationMessage field is set.
-
getDeprecationMessage
String getDeprecationMessage()Deprecation message for this option
optional string deprecationMessage = 9;
- Returns:
- The deprecationMessage.
-
getDeprecationMessageBytes
com.google.protobuf.ByteString getDeprecationMessageBytes()Deprecation message for this option
optional string deprecationMessage = 9;
- Returns:
- The bytes for deprecationMessage.
-
getDescriptionList
Description, each list entry represents a paragraph
repeated string description = 10;
- Returns:
- A list containing the description.
-
getDescriptionCount
int getDescriptionCount()Description, each list entry represents a paragraph
repeated string description = 10;
- Returns:
- The count of description.
-
getDescription
Description, each list entry represents a paragraph
repeated string description = 10;
- Parameters:
index
- The index of the element to return.- Returns:
- The description at the given index.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes(int index) Description, each list entry represents a paragraph
repeated string description = 10;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the description at the given index.
-
hasElementType
boolean hasElementType()When the type is ``LIST`` or ``LIST_OR_ELEMENT``, this indicates the type of each element of that list
optional .yamcs.protobuf.config.OptionType elementType = 11;
- Returns:
- Whether the elementType field is set.
-
getElementType
OptionType getElementType()When the type is ``LIST`` or ``LIST_OR_ELEMENT``, this indicates the type of each element of that list
optional .yamcs.protobuf.config.OptionType elementType = 11;
- Returns:
- The elementType.
-
hasSpec
boolean hasSpec()When the type or elementType is ``MAP``, this specifies the options with that map
optional .yamcs.protobuf.config.SpecInfo spec = 12;
- Returns:
- Whether the spec field is set.
-
getSpec
SpecInfo getSpec()When the type or elementType is ``MAP``, this specifies the options with that map
optional .yamcs.protobuf.config.SpecInfo spec = 12;
- Returns:
- The spec.
-
getSpecOrBuilder
SpecInfoOrBuilder getSpecOrBuilder()When the type or elementType is ``MAP``, this specifies the options with that map
optional .yamcs.protobuf.config.SpecInfo spec = 12;
-
getChoicesList
List<com.google.protobuf.Value> getChoicesList()Allowed values for this option
repeated .google.protobuf.Value choices = 13;
-
getChoices
com.google.protobuf.Value getChoices(int index) Allowed values for this option
repeated .google.protobuf.Value choices = 13;
-
getChoicesCount
int getChoicesCount()Allowed values for this option
repeated .google.protobuf.Value choices = 13;
-
getChoicesOrBuilderList
List<? extends com.google.protobuf.ValueOrBuilder> getChoicesOrBuilderList()Allowed values for this option
repeated .google.protobuf.Value choices = 13;
-
getChoicesOrBuilder
com.google.protobuf.ValueOrBuilder getChoicesOrBuilder(int index) Allowed values for this option
repeated .google.protobuf.Value choices = 13;
-
hasApplySpecDefaults
boolean hasApplySpecDefaults()When the type is ``MAP``, this property determines whether default values are generated even when a value for that option was not provided.
optional bool applySpecDefaults = 14;
- Returns:
- Whether the applySpecDefaults field is set.
-
getApplySpecDefaults
boolean getApplySpecDefaults()When the type is ``MAP``, this property determines whether default values are generated even when a value for that option was not provided.
optional bool applySpecDefaults = 14;
- Returns:
- The applySpecDefaults.
-
getAliasesList
Additional names that can be used for this option
repeated string aliases = 15;
- Returns:
- A list containing the aliases.
-
getAliasesCount
int getAliasesCount()Additional names that can be used for this option
repeated string aliases = 15;
- Returns:
- The count of aliases.
-
getAliases
Additional names that can be used for this option
repeated string aliases = 15;
- Parameters:
index
- The index of the element to return.- Returns:
- The aliases at the given index.
-
getAliasesBytes
com.google.protobuf.ByteString getAliasesBytes(int index) Additional names that can be used for this option
repeated string aliases = 15;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the aliases at the given index.
-