Package org.yamcs.protobuf

Class SaveItemRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.yamcs.protobuf.SaveItemRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, SaveItemRequestOrBuilder
public final class SaveItemRequest extends com.google.protobuf.GeneratedMessageV3 implements SaveItemRequestOrBuilder
Protobuf type yamcs.protobuf.timeline.SaveItemRequest
See Also:

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapField

      protected com.google.protobuf.MapField internalGetMapField(int number)
      Overrides:
      internalGetMapField in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasInstance

      public boolean hasInstance()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      hasInstance in interface SaveItemRequestOrBuilder
      Returns:
      Whether the instance field is set.

    • getInstance

      public String getInstance()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      getInstance in interface SaveItemRequestOrBuilder
      Returns:
      The instance.

    • getInstanceBytes

      public com.google.protobuf.ByteString getInstanceBytes()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      getInstanceBytes in interface SaveItemRequestOrBuilder
      Returns:
      The bytes for instance.

    • hasSource

      public boolean hasSource()
       Item source
      optional string source = 2;
      Specified by:
      hasSource in interface SaveItemRequestOrBuilder
      Returns:
      Whether the source field is set.

    • getSource

      public String getSource()
       Item source
      optional string source = 2;
      Specified by:
      getSource in interface SaveItemRequestOrBuilder
      Returns:
      The source.

    • getSourceBytes

      public com.google.protobuf.ByteString getSourceBytes()
       Item source
      optional string source = 2;
      Specified by:
      getSourceBytes in interface SaveItemRequestOrBuilder
      Returns:
      The bytes for source.

    • hasId

      public boolean hasId()
       Optional item identifier.
 If not set, an ID will be assigned by the server.
 If set, it should be a valid UUID.
      optional string id = 13;
      Specified by:
      hasId in interface SaveItemRequestOrBuilder
      Returns:
      Whether the id field is set.

    • getId

      public String getId()
       Optional item identifier.
 If not set, an ID will be assigned by the server.
 If set, it should be a valid UUID.
      optional string id = 13;
      Specified by:
      getId in interface SaveItemRequestOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
       Optional item identifier.
 If not set, an ID will be assigned by the server.
 If set, it should be a valid UUID.
      optional string id = 13;
      Specified by:
      getIdBytes in interface SaveItemRequestOrBuilder
      Returns:
      The bytes for id.

    • hasName

      public boolean hasName()
       Item name
      optional string name = 3;
      Specified by:
      hasName in interface SaveItemRequestOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public String getName()
       Item name
      optional string name = 3;
      Specified by:
      getName in interface SaveItemRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Item name
      optional string name = 3;
      Specified by:
      getNameBytes in interface SaveItemRequestOrBuilder
      Returns:
      The bytes for name.

    • hasType

      public boolean hasType()
       Item type
      optional .yamcs.protobuf.timeline.TimelineItemType type = 4;
      Specified by:
      hasType in interface SaveItemRequestOrBuilder
      Returns:
      Whether the type field is set.

    • getType

      public TimelineItemType getType()
       Item type
      optional .yamcs.protobuf.timeline.TimelineItemType type = 4;
      Specified by:
      getType in interface SaveItemRequestOrBuilder
      Returns:
      The type.

    • hasStart

      public boolean hasStart()
       Item start. The fields `start`, `relativeTime` and `dependsOn`
 are mutually exclusive
      optional .google.protobuf.Timestamp start = 5;
      Specified by:
      hasStart in interface SaveItemRequestOrBuilder
      Returns:
      Whether the start field is set.

    • getStart

      public com.google.protobuf.Timestamp getStart()
       Item start. The fields `start`, `relativeTime` and `dependsOn`
 are mutually exclusive
      optional .google.protobuf.Timestamp start = 5;
      Specified by:
      getStart in interface SaveItemRequestOrBuilder
      Returns:
      The start.

    • getStartOrBuilder

      public com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
       Item start. The fields `start`, `relativeTime` and `dependsOn`
 are mutually exclusive
      optional .google.protobuf.Timestamp start = 5;
      Specified by:
      getStartOrBuilder in interface SaveItemRequestOrBuilder

    • hasDuration

      public boolean hasDuration()
       Item duration. Applies also if `relativeTime` is specified
      optional .google.protobuf.Duration duration = 6;
      Specified by:
      hasDuration in interface SaveItemRequestOrBuilder
      Returns:
      Whether the duration field is set.

    • getDuration

      public com.google.protobuf.Duration getDuration()
       Item duration. Applies also if `relativeTime` is specified
      optional .google.protobuf.Duration duration = 6;
      Specified by:
      getDuration in interface SaveItemRequestOrBuilder
      Returns:
      The duration.

    • getDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
       Item duration. Applies also if `relativeTime` is specified
      optional .google.protobuf.Duration duration = 6;
      Specified by:
      getDurationOrBuilder in interface SaveItemRequestOrBuilder

    • getTagsList

      public com.google.protobuf.ProtocolStringList getTagsList()
       Tags
      repeated string tags = 7;
      Specified by:
      getTagsList in interface SaveItemRequestOrBuilder
      Returns:
      A list containing the tags.

    • getTagsCount

      public int getTagsCount()
       Tags
      repeated string tags = 7;
      Specified by:
      getTagsCount in interface SaveItemRequestOrBuilder
      Returns:
      The count of tags.

    • getTags

      public String getTags(int index)
       Tags
      repeated string tags = 7;
      Specified by:
      getTags in interface SaveItemRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The tags at the given index.

    • getTagsBytes

      public com.google.protobuf.ByteString getTagsBytes(int index)
       Tags
      repeated string tags = 7;
      Specified by:
      getTagsBytes in interface SaveItemRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tags at the given index.

    • hasGroupId

      public boolean hasGroupId()
       If this item is part of a group, this is the group identifier
      optional string groupId = 8;
      Specified by:
      hasGroupId in interface SaveItemRequestOrBuilder
      Returns:
      Whether the groupId field is set.

    • getGroupId

      public String getGroupId()
       If this item is part of a group, this is the group identifier
      optional string groupId = 8;
      Specified by:
      getGroupId in interface SaveItemRequestOrBuilder
      Returns:
      The groupId.

    • getGroupIdBytes

      public com.google.protobuf.ByteString getGroupIdBytes()
       If this item is part of a group, this is the group identifier
      optional string groupId = 8;
      Specified by:
      getGroupIdBytes in interface SaveItemRequestOrBuilder
      Returns:
      The bytes for groupId.

    • hasRelativeTime

      public 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;
      Specified by:
      hasRelativeTime in interface SaveItemRequestOrBuilder
      Returns:
      Whether the relativeTime field is set.

    • getRelativeTime

      public 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;
      Specified by:
      getRelativeTime in interface SaveItemRequestOrBuilder
      Returns:
      The relativeTime.

    • getRelativeTimeOrBuilder

      public 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` field).
      optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 9;
      Specified by:
      getRelativeTimeOrBuilder in interface SaveItemRequestOrBuilder

    • hasDescription

      public boolean hasDescription()
       Item description
      optional string description = 10;
      Specified by:
      hasDescription in interface SaveItemRequestOrBuilder
      Returns:
      Whether the description field is set.

    • getDescription

      public String getDescription()
       Item description
      optional string description = 10;
      Specified by:
      getDescription in interface SaveItemRequestOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Item description
      optional string description = 10;
      Specified by:
      getDescriptionBytes in interface SaveItemRequestOrBuilder
      Returns:
      The bytes for description.

    • getPropertiesCount

      public int getPropertiesCount()
      Description copied from interface: SaveItemRequestOrBuilder
       Additional properties used by the Yamcs Web UI for rendering purposes.
      map<string, string> properties = 11;
      Specified by:
      getPropertiesCount in interface SaveItemRequestOrBuilder

    • containsProperties

      public boolean containsProperties(String key)
       Additional properties used by the Yamcs Web UI for rendering purposes.
      map<string, string> properties = 11;
      Specified by:
      containsProperties in interface SaveItemRequestOrBuilder

    • getProperties

      @Deprecated public Map<String,String> getProperties()
      Deprecated.
      Use getPropertiesMap() instead.
      Specified by:
      getProperties in interface SaveItemRequestOrBuilder

    • getPropertiesMap

      public Map<String,String> getPropertiesMap()
       Additional properties used by the Yamcs Web UI for rendering purposes.
      map<string, string> properties = 11;
      Specified by:
      getPropertiesMap in interface SaveItemRequestOrBuilder

    • getPropertiesOrDefault

      public String getPropertiesOrDefault(String key, String defaultValue)
       Additional properties used by the Yamcs Web UI for rendering purposes.
      map<string, string> properties = 11;
      Specified by:
      getPropertiesOrDefault in interface SaveItemRequestOrBuilder

    • getPropertiesOrThrow

      public String getPropertiesOrThrow(String key)
       Additional properties used by the Yamcs Web UI for rendering purposes.
      map<string, string> properties = 11;
      Specified by:
      getPropertiesOrThrow in interface SaveItemRequestOrBuilder

    • getExtraCount

      public int getExtraCount()
      Description copied from interface: SaveItemRequestOrBuilder
       Mission-specific custom data. Unlike `properties`, this field is ignored
 by the Yamcs Web UI.
      map<string, string> extra = 18;
      Specified by:
      getExtraCount in interface SaveItemRequestOrBuilder

    • containsExtra

      public boolean containsExtra(String key)
       Mission-specific custom data. Unlike `properties`, this field is ignored
 by the Yamcs Web UI.
      map<string, string> extra = 18;
      Specified by:
      containsExtra in interface SaveItemRequestOrBuilder

    • getExtra

      @Deprecated public Map<String,String> getExtra()
      Deprecated.
      Use getExtraMap() instead.
      Specified by:
      getExtra in interface SaveItemRequestOrBuilder

    • getExtraMap

      public Map<String,String> getExtraMap()
       Mission-specific custom data. Unlike `properties`, this field is ignored
 by the Yamcs Web UI.
      map<string, string> extra = 18;
      Specified by:
      getExtraMap in interface SaveItemRequestOrBuilder

    • getExtraOrDefault

      public String getExtraOrDefault(String key, String defaultValue)
       Mission-specific custom data. Unlike `properties`, this field is ignored
 by the Yamcs Web UI.
      map<string, string> extra = 18;
      Specified by:
      getExtraOrDefault in interface SaveItemRequestOrBuilder

    • getExtraOrThrow

      public String getExtraOrThrow(String key)
       Mission-specific custom data. Unlike `properties`, this field is ignored
 by the Yamcs Web UI.
      map<string, string> extra = 18;
      Specified by:
      getExtraOrThrow in interface SaveItemRequestOrBuilder

    • hasActivityDefinition

      public boolean hasActivityDefinition()
       Activity definition associated to this item.
 Required if `type` is ACTIVITY.
      optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 12;
      Specified by:
      hasActivityDefinition in interface SaveItemRequestOrBuilder
      Returns:
      Whether the activityDefinition field is set.

    • getActivityDefinition

      public ActivityDefinitionInfo getActivityDefinition()
       Activity definition associated to this item.
 Required if `type` is ACTIVITY.
      optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 12;
      Specified by:
      getActivityDefinition in interface SaveItemRequestOrBuilder
      Returns:
      The activityDefinition.

    • getActivityDefinitionOrBuilder

      public ActivityDefinitionInfoOrBuilder getActivityDefinitionOrBuilder()
       Activity definition associated to this item.
 Required if `type` is ACTIVITY.
      optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 12;
      Specified by:
      getActivityDefinitionOrBuilder in interface SaveItemRequestOrBuilder

    • getPredecessorsList

      public List<PredecessorInfo> getPredecessorsList()
       Can be used only if `type` is ACTIVITY.
 Specifies which other activities/items this activity depends on.
 Start time of this activity is derived by looking at each predecessor's
 start condition and among them establishing the latest start time.
      repeated .yamcs.protobuf.timeline.PredecessorInfo predecessors = 14;
      Specified by:
      getPredecessorsList in interface SaveItemRequestOrBuilder

    • getPredecessorsOrBuilderList

      public List<? extends PredecessorInfoOrBuilder> getPredecessorsOrBuilderList()
       Can be used only if `type` is ACTIVITY.
 Specifies which other activities/items this activity depends on.
 Start time of this activity is derived by looking at each predecessor's
 start condition and among them establishing the latest start time.
      repeated .yamcs.protobuf.timeline.PredecessorInfo predecessors = 14;
      Specified by:
      getPredecessorsOrBuilderList in interface SaveItemRequestOrBuilder

    • getPredecessorsCount

      public int getPredecessorsCount()
       Can be used only if `type` is ACTIVITY.
 Specifies which other activities/items this activity depends on.
 Start time of this activity is derived by looking at each predecessor's
 start condition and among them establishing the latest start time.
      repeated .yamcs.protobuf.timeline.PredecessorInfo predecessors = 14;
      Specified by:
      getPredecessorsCount in interface SaveItemRequestOrBuilder

    • getPredecessors

      public PredecessorInfo getPredecessors(int index)
       Can be used only if `type` is ACTIVITY.
 Specifies which other activities/items this activity depends on.
 Start time of this activity is derived by looking at each predecessor's
 start condition and among them establishing the latest start time.
      repeated .yamcs.protobuf.timeline.PredecessorInfo predecessors = 14;
      Specified by:
      getPredecessors in interface SaveItemRequestOrBuilder

    • getPredecessorsOrBuilder

      public PredecessorInfoOrBuilder getPredecessorsOrBuilder(int index)
       Can be used only if `type` is ACTIVITY.
 Specifies which other activities/items this activity depends on.
 Start time of this activity is derived by looking at each predecessor's
 start condition and among them establishing the latest start time.
      repeated .yamcs.protobuf.timeline.PredecessorInfo predecessors = 14;
      Specified by:
      getPredecessorsOrBuilder in interface SaveItemRequestOrBuilder

    • hasAutoStart

      public boolean hasAutoStart()
       Can be used only if `type` is ACTIVITY
 Indicates if the activity should start automatically.
 When `false`, the activity will be moved to `READY` state waiting to be
 started manually.
 Defaults to `false` for manual activities, and `true` otherwise.
      optional bool autoStart = 17;
      Specified by:
      hasAutoStart in interface SaveItemRequestOrBuilder
      Returns:
      Whether the autoStart field is set.

    • getAutoStart

      public boolean getAutoStart()
       Can be used only if `type` is ACTIVITY
 Indicates if the activity should start automatically.
 When `false`, the activity will be moved to `READY` state waiting to be
 started manually.
 Defaults to `false` for manual activities, and `true` otherwise.
      optional bool autoStart = 17;
      Specified by:
      getAutoStart in interface SaveItemRequestOrBuilder
      Returns:
      The autoStart.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SaveItemRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SaveItemRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SaveItemRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SaveItemRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SaveItemRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SaveItemRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SaveItemRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SaveItemRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SaveItemRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SaveItemRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SaveItemRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SaveItemRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SaveItemRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SaveItemRequest.Builder newBuilder()

    • newBuilder

      public static SaveItemRequest.Builder newBuilder(SaveItemRequest prototype)

    • toBuilder

      public SaveItemRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SaveItemRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static SaveItemRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SaveItemRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<SaveItemRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public SaveItemRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder