org.yamcs.protobuf.CreateItemRequestOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: yamcs/protobuf/timeline/timeline.proto
package org.yamcs.protobuf;
public interface CreateItemRequestOrBuilder extends
// @@protoc_insertion_point(interface_extends:yamcs.protobuf.timeline.CreateItemRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
* Yamcs instance name
*
*
* optional string instance = 1;
* @return Whether the instance field is set.
*/
boolean hasInstance();
/**
*
* Yamcs instance name
*
*
* optional string instance = 1;
* @return The instance.
*/
java.lang.String getInstance();
/**
*
* Yamcs instance name
*
*
* optional string instance = 1;
* @return The bytes for instance.
*/
com.google.protobuf.ByteString
getInstanceBytes();
/**
*
* Item source
*
*
* optional string source = 2;
* @return Whether the source field is set.
*/
boolean hasSource();
/**
*
* Item source
*
*
* optional string source = 2;
* @return The source.
*/
java.lang.String getSource();
/**
*
* Item source
*
*
* optional string source = 2;
* @return The bytes for source.
*/
com.google.protobuf.ByteString
getSourceBytes();
/**
*
* Item name
*
*
* optional string name = 3;
* @return Whether the name field is set.
*/
boolean hasName();
/**
*
* Item name
*
*
* optional string name = 3;
* @return The name.
*/
java.lang.String getName();
/**
*
* Item name
*
*
* optional string name = 3;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* Item type
*
*
* optional .yamcs.protobuf.timeline.TimelineItemType type = 4;
* @return Whether the type field is set.
*/
boolean hasType();
/**
*
* Item type
*
*
* optional .yamcs.protobuf.timeline.TimelineItemType type = 4;
* @return The type.
*/
org.yamcs.protobuf.TimelineItemType getType();
/**
*
* Item start. The fields ``start`` and ``relativeTime``
* are mutually exclusive
*
*
* optional .google.protobuf.Timestamp start = 5;
* @return Whether the start field is set.
*/
boolean hasStart();
/**
*
* Item start. The fields ``start`` and ``relativeTime``
* are mutually exclusive
*
*
* optional .google.protobuf.Timestamp start = 5;
* @return The start.
*/
com.google.protobuf.Timestamp getStart();
/**
*
* Item start. The fields ``start`` and ``relativeTime``
* are mutually exclusive
*
*
* optional .google.protobuf.Timestamp start = 5;
*/
com.google.protobuf.TimestampOrBuilder getStartOrBuilder();
/**
*
* Item duration. Applies also if ``relativeTime`` is specified
*
*
* optional .google.protobuf.Duration duration = 6;
* @return Whether the duration field is set.
*/
boolean hasDuration();
/**
*
* Item duration. Applies also if ``relativeTime`` is specified
*
*
* optional .google.protobuf.Duration duration = 6;
* @return The duration.
*/
com.google.protobuf.Duration getDuration();
/**
*
* Item duration. Applies also if ``relativeTime`` is specified
*
*
* optional .google.protobuf.Duration duration = 6;
*/
com.google.protobuf.DurationOrBuilder getDurationOrBuilder();
/**
*
* Tags
*
*
* repeated string tags = 7;
* @return A list containing the tags.
*/
java.util.List
getTagsList();
/**
*
* Tags
*
*
* repeated string tags = 7;
* @return The count of tags.
*/
int getTagsCount();
/**
*
* Tags
*
*
* repeated string tags = 7;
* @param index The index of the element to return.
* @return The tags at the given index.
*/
java.lang.String getTags(int index);
/**
*
* Tags
*
*
* repeated string tags = 7;
* @param index The index of the value to return.
* @return The bytes of the tags at the given index.
*/
com.google.protobuf.ByteString
getTagsBytes(int index);
/**
*
* If this item is part of a group, this is the group identifier
*
*
* optional string groupId = 8;
* @return Whether the groupId field is set.
*/
boolean hasGroupId();
/**
*
* If this item is part of a group, this is the group identifier
*
*
* optional string groupId = 8;
* @return The groupId.
*/
java.lang.String getGroupId();
/**
*
* If this item is part of a group, this is the group identifier
*
*
* optional string groupId = 8;
* @return The bytes for groupId.
*/
com.google.protobuf.ByteString
getGroupIdBytes();
/**
*
* 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`` field).
*
*
* optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 9;
* @return Whether the relativeTime field is set.
*/
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`` field).
*
*
* optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 9;
* @return The relativeTime.
*/
org.yamcs.protobuf.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`` field).
*
*
* optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 9;
*/
org.yamcs.protobuf.RelativeTimeOrBuilder getRelativeTimeOrBuilder();
/**
*
* Item description
*
*
* optional string description = 10;
* @return Whether the description field is set.
*/
boolean hasDescription();
/**
*
* Item description
*
*
* optional string description = 10;
* @return The description.
*/
java.lang.String getDescription();
/**
*
* Item description
*
*
* optional string description = 10;
* @return The bytes for description.
*/
com.google.protobuf.ByteString
getDescriptionBytes();
/**
*
* Additional properties used by yamcs-web to render this item
*
*
* map<string, string> properties = 11;
*/
int getPropertiesCount();
/**
*
* Additional properties used by yamcs-web to render this item
*
*
* map<string, string> properties = 11;
*/
boolean containsProperties(
java.lang.String key);
/**
* Use {@link #getPropertiesMap()} instead.
*/
@java.lang.Deprecated
java.util.Map
getProperties();
/**
*
* Additional properties used by yamcs-web to render this item
*
*
* map<string, string> properties = 11;
*/
java.util.Map
getPropertiesMap();
/**
*
* Additional properties used by yamcs-web to render this item
*
*
* map<string, string> properties = 11;
*/
java.lang.String getPropertiesOrDefault(
java.lang.String key,
java.lang.String defaultValue);
/**
*
* Additional properties used by yamcs-web to render this item
*
*
* map<string, string> properties = 11;
*/
java.lang.String getPropertiesOrThrow(
java.lang.String key);
/**
*
* Activity definition associated to this item.
* Required if ``type`` is ACTIVITY.
*
*
* optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 12;
* @return Whether the activityDefinition field is set.
*/
boolean hasActivityDefinition();
/**
*
* Activity definition associated to this item.
* Required if ``type`` is ACTIVITY.
*
*
* optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 12;
* @return The activityDefinition.
*/
org.yamcs.protobuf.activities.ActivityDefinitionInfo getActivityDefinition();
/**
*
* Activity definition associated to this item.
* Required if ``type`` is ACTIVITY.
*
*
* optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 12;
*/
org.yamcs.protobuf.activities.ActivityDefinitionInfoOrBuilder getActivityDefinitionOrBuilder();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy