Package org.yamcs.protobuf
Interface CreateItemRequestOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
CreateItemRequest
,CreateItemRequest.Builder
public interface CreateItemRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionboolean
containsProperties
(String key) Additional properties used by yamcs-web to render this itemActivity definition associated to this item.Activity definition associated to this item.Item descriptioncom.google.protobuf.ByteString
Item descriptioncom.google.protobuf.Duration
Item duration.com.google.protobuf.DurationOrBuilder
Item duration.If this item is part of a group, this is the group identifiercom.google.protobuf.ByteString
If this item is part of a group, this is the group identifierYamcs instance namecom.google.protobuf.ByteString
Yamcs instance namegetName()
Item namecom.google.protobuf.ByteString
Item nameDeprecated.int
Additional properties used by yamcs-web to render this itemAdditional properties used by yamcs-web to render this itemgetPropertiesOrDefault
(String key, String defaultValue) Additional properties used by yamcs-web to render this itemAdditional properties used by yamcs-web to render this itemIf the item time specification is relative to another item, ``relativeTime`` contains a reference to that item, as well as the relative start (the duration is the same as given by the duration above).If the item time specification is relative to another item, ``relativeTime`` contains a reference to that item, as well as the relative start (the duration is the same as given by the duration above).Item sourcecom.google.protobuf.ByteString
Item sourcecom.google.protobuf.Timestamp
getStart()
Item start.com.google.protobuf.TimestampOrBuilder
Item start.getTags
(int index) Tagscom.google.protobuf.ByteString
getTagsBytes
(int index) Tagsint
TagsTagsgetType()
Item typeboolean
Activity definition associated to this item.boolean
Item descriptionboolean
Item duration.boolean
If this item is part of a group, this is the group identifierboolean
Yamcs instance nameboolean
hasName()
Item nameboolean
If the item time specification is relative to another item, ``relativeTime`` contains a reference to that item, as well as the relative start (the duration is the same as given by the duration above).boolean
Item sourceboolean
hasStart()
Item start.boolean
hasType()
Item typeMethods 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
-
hasInstance
boolean hasInstance()Yamcs instance name
optional string instance = 1;
- Returns:
- Whether the instance field is set.
-
getInstance
String getInstance()Yamcs instance name
optional string instance = 1;
- Returns:
- The instance.
-
getInstanceBytes
com.google.protobuf.ByteString getInstanceBytes()Yamcs instance name
optional string instance = 1;
- Returns:
- The bytes for instance.
-
hasSource
boolean hasSource()Item source
optional string source = 2;
- Returns:
- Whether the source field is set.
-
getSource
String getSource()Item source
optional string source = 2;
- Returns:
- The source.
-
getSourceBytes
com.google.protobuf.ByteString getSourceBytes()Item source
optional string source = 2;
- Returns:
- The bytes for source.
-
hasName
boolean hasName()Item name
optional string name = 3;
- Returns:
- Whether the name field is set.
-
getName
String getName()Item name
optional string name = 3;
- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()Item name
optional string name = 3;
- Returns:
- The bytes for name.
-
hasType
boolean hasType()Item type
optional .yamcs.protobuf.timeline.TimelineItemType type = 4;
- Returns:
- Whether the type field is set.
-
getType
TimelineItemType getType()Item type
optional .yamcs.protobuf.timeline.TimelineItemType type = 4;
- Returns:
- The type.
-
hasStart
boolean hasStart()Item start. The fields ``start`` and ``relativeTime`` are mutually exclusive
optional .google.protobuf.Timestamp start = 5;
- Returns:
- Whether the start field is set.
-
getStart
com.google.protobuf.Timestamp getStart()Item start. The fields ``start`` and ``relativeTime`` are mutually exclusive
optional .google.protobuf.Timestamp start = 5;
- Returns:
- The start.
-
getStartOrBuilder
com.google.protobuf.TimestampOrBuilder getStartOrBuilder()Item start. The fields ``start`` and ``relativeTime`` are mutually exclusive
optional .google.protobuf.Timestamp start = 5;
-
hasDuration
boolean hasDuration()Item duration. Applies also if ``relativeTime`` is specified
optional .google.protobuf.Duration duration = 6;
- Returns:
- Whether the duration field is set.
-
getDuration
com.google.protobuf.Duration getDuration()Item duration. Applies also if ``relativeTime`` is specified
optional .google.protobuf.Duration duration = 6;
- Returns:
- The duration.
-
getDurationOrBuilder
com.google.protobuf.DurationOrBuilder getDurationOrBuilder()Item duration. Applies also if ``relativeTime`` is specified
optional .google.protobuf.Duration duration = 6;
-
getTagsList
Tags
repeated string tags = 7;
- Returns:
- A list containing the tags.
-
getTagsCount
int getTagsCount()Tags
repeated string tags = 7;
- Returns:
- The count of tags.
-
getTags
Tags
repeated string tags = 7;
- Parameters:
index
- The index of the element to return.- Returns:
- The tags at the given index.
-
getTagsBytes
com.google.protobuf.ByteString getTagsBytes(int index) Tags
repeated string tags = 7;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the tags at the given index.
-
hasGroupId
boolean hasGroupId()If this item is part of a group, this is the group identifier
optional string groupId = 8;
- Returns:
- Whether the groupId field is set.
-
getGroupId
String getGroupId()If this item is part of a group, this is the group identifier
optional string groupId = 8;
- Returns:
- The groupId.
-
getGroupIdBytes
com.google.protobuf.ByteString getGroupIdBytes()If this item is part of a group, this is the group identifier
optional string groupId = 8;
- Returns:
- The bytes for groupId.
-
hasRelativeTime
boolean hasRelativeTime()If the item time specification is relative to another item, ``relativeTime`` contains a reference to that item, as well as the relative start (the duration is the same as given by the duration above).
optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 9;
- Returns:
- Whether the relativeTime field is set.
-
getRelativeTime
RelativeTime getRelativeTime()If the item time specification is relative to another item, ``relativeTime`` contains a reference to that item, as well as the relative start (the duration is the same as given by the duration above).
optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 9;
- Returns:
- The relativeTime.
-
getRelativeTimeOrBuilder
RelativeTimeOrBuilder getRelativeTimeOrBuilder()If the item time specification is relative to another item, ``relativeTime`` contains a reference to that item, as well as the relative start (the duration is the same as given by the duration above).
optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 9;
-
hasDescription
boolean hasDescription()Item description
optional string description = 10;
- Returns:
- Whether the description field is set.
-
getDescription
String getDescription()Item description
optional string description = 10;
- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()Item description
optional string description = 10;
- Returns:
- The bytes for description.
-
getPropertiesCount
int getPropertiesCount()Additional properties used by yamcs-web to render this item
map<string, string> properties = 11;
-
containsProperties
Additional properties used by yamcs-web to render this item
map<string, string> properties = 11;
-
getProperties
Deprecated.UsegetPropertiesMap()
instead. -
getPropertiesMap
Additional properties used by yamcs-web to render this item
map<string, string> properties = 11;
-
getPropertiesOrDefault
Additional properties used by yamcs-web to render this item
map<string, string> properties = 11;
-
getPropertiesOrThrow
Additional properties used by yamcs-web to render this item
map<string, string> properties = 11;
-
hasActivityDefinition
boolean hasActivityDefinition()Activity definition associated to this item. Required if ``type`` is ACTIVITY.
optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 12;
- Returns:
- Whether the activityDefinition field is set.
-
getActivityDefinition
ActivityDefinitionInfo getActivityDefinition()Activity definition associated to this item. Required if ``type`` is ACTIVITY.
optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 12;
- Returns:
- The activityDefinition.
-
getActivityDefinitionOrBuilder
ActivityDefinitionInfoOrBuilder getActivityDefinitionOrBuilder()Activity definition associated to this item. Required if ``type`` is ACTIVITY.
optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 12;
-