Package org.yamcs.protobuf

Interface UpdateItemRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
UpdateItemRequest, UpdateItemRequest.Builder
public interface UpdateItemRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsProperties(String key)
    Additional properties used by yamcs-web to render this item
    boolean
    getClearProperties()
    Set this to true to remove completely all properties
    boolean
    getClearTags()
    Set this to true to remove completely all the tags (required because in the protobuf we cannot distinguish between an empty tags list and a non existent list)
    com.google.protobuf.Duration
    getDuration()
    new duration
    com.google.protobuf.DurationOrBuilder
    getDurationOrBuilder()
    new duration
    String
    getFailureReason()
    failure reason (valid for activities)
    com.google.protobuf.ByteString
    getFailureReasonBytes()
    failure reason (valid for activities)
    String
    getGroupId()
    new group identifier. to keep the old value, leave out to clear the group, set to an empty string
    com.google.protobuf.ByteString
    getGroupIdBytes()
    new group identifier. to keep the old value, leave out to clear the group, set to an empty string
    String
    getId()
    Item identifier
    com.google.protobuf.ByteString
    getIdBytes()
    Item identifier
    String
    getInstance()
    Yamcs instance name
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name
    String
    getName()
    Item name
    com.google.protobuf.ByteString
    getNameBytes()
    Item name
    Map<String,String>
    getProperties()
    Deprecated.
    int
    getPropertiesCount()
    Additional properties used by yamcs-web to render this item
    Map<String,String>
    getPropertiesMap()
    Additional properties used by yamcs-web to render this item
    String
    getPropertiesOrDefault(String key, String defaultValue)
    Additional properties used by yamcs-web to render this item
    String
    getPropertiesOrThrow(String key)
    Additional properties used by yamcs-web to render this item
    RelativeTime
    getRelativeTime()
    new relative time to keep the old value, leave out the property to clear, set the start
    RelativeTimeOrBuilder
    getRelativeTimeOrBuilder()
    new relative time to keep the old value, leave out the property to clear, set the start
    String
    getSource()
    Item source
    com.google.protobuf.ByteString
    getSourceBytes()
    Item source
    com.google.protobuf.Timestamp
    getStart()
    new start time
    com.google.protobuf.TimestampOrBuilder
    getStartOrBuilder()
    new start time
    ExecutionStatus
    getStatus()
    new status (valid for activities)
    String
    getTags(int index)
    new tags
    com.google.protobuf.ByteString
    getTagsBytes(int index)
    new tags
    int
    getTagsCount()
    new tags
    List<String>
    getTagsList()
    new tags
    boolean
    hasClearProperties()
    Set this to true to remove completely all properties
    boolean
    hasClearTags()
    Set this to true to remove completely all the tags (required because in the protobuf we cannot distinguish between an empty tags list and a non existent list)
    boolean
    hasDuration()
    new duration
    boolean
    hasFailureReason()
    failure reason (valid for activities)
    boolean
    hasGroupId()
    new group identifier. to keep the old value, leave out to clear the group, set to an empty string
    boolean
    hasId()
    Item identifier
    boolean
    hasInstance()
    Yamcs instance name
    boolean
    hasName()
    Item name
    boolean
    hasRelativeTime()
    new relative time to keep the old value, leave out the property to clear, set the start
    boolean
    hasSource()
    Item source
    boolean
    hasStart()
    new start time
    boolean
    hasStatus()
    new status (valid for activities)

    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

    • 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.

    • hasId

      boolean hasId()
       Item identifier
      optional string id = 3;
      Returns:
      Whether the id field is set.

    • getId

      String getId()
       Item identifier
      optional string id = 3;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       Item identifier
      optional string id = 3;
      Returns:
      The bytes for id.

    • hasName

      boolean hasName()
       Item name
      optional string name = 4;
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       Item name
      optional string name = 4;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Item name
      optional string name = 4;
      Returns:
      The bytes for name.

    • hasStart

      boolean hasStart()
      new start time
      optional .google.protobuf.Timestamp start = 5;
      Returns:
      Whether the start field is set.

    • getStart

      com.google.protobuf.Timestamp getStart()
      new start time
      optional .google.protobuf.Timestamp start = 5;
      Returns:
      The start.

    • getStartOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
      new start time
      optional .google.protobuf.Timestamp start = 5;

    • hasDuration

      boolean hasDuration()
      new duration
      optional .google.protobuf.Duration duration = 6;
      Returns:
      Whether the duration field is set.

    • getDuration

      com.google.protobuf.Duration getDuration()
      new duration
      optional .google.protobuf.Duration duration = 6;
      Returns:
      The duration.

    • getDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
      new duration
      optional .google.protobuf.Duration duration = 6;

    • getTagsList

      List<String> getTagsList()
      new tags
      repeated string tags = 7;
      Returns:
      A list containing the tags.

    • getTagsCount

      int getTagsCount()
      new tags
      repeated string tags = 7;
      Returns:
      The count of tags.

    • getTags

      String getTags(int index)
      new 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)
      new tags
      repeated string tags = 7;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tags at the given index.

    • hasClearTags

      boolean hasClearTags()
       Set this to true to remove completely all the tags
 (required because in the protobuf we cannot distinguish between an empty tags list and a non existent list)
      optional bool clearTags = 8;
      Returns:
      Whether the clearTags field is set.

    • getClearTags

      boolean getClearTags()
       Set this to true to remove completely all the tags
 (required because in the protobuf we cannot distinguish between an empty tags list and a non existent list)
      optional bool clearTags = 8;
      Returns:
      The clearTags.

    • hasGroupId

      boolean hasGroupId()
      new group identifier.
to keep the old value, leave out
 to clear the group, set to an empty string
      optional string groupId = 9;
      Returns:
      Whether the groupId field is set.

    • getGroupId

      String getGroupId()
      new group identifier.
to keep the old value, leave out
 to clear the group, set to an empty string
      optional string groupId = 9;
      Returns:
      The groupId.

    • getGroupIdBytes

      com.google.protobuf.ByteString getGroupIdBytes()
      new group identifier.
to keep the old value, leave out
 to clear the group, set to an empty string
      optional string groupId = 9;
      Returns:
      The bytes for groupId.

    • hasRelativeTime

      boolean hasRelativeTime()
      new relative time
 to keep the old value, leave out the property
 to clear, set the start
      optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 10;
      Returns:
      Whether the relativeTime field is set.

    • getRelativeTime

      RelativeTime getRelativeTime()
      new relative time
 to keep the old value, leave out the property
 to clear, set the start
      optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 10;
      Returns:
      The relativeTime.

    • getRelativeTimeOrBuilder

      RelativeTimeOrBuilder getRelativeTimeOrBuilder()
      new relative time
 to keep the old value, leave out the property
 to clear, set the start
      optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 10;

    • hasStatus

      boolean hasStatus()
      new status (valid for activities)
      optional .yamcs.protobuf.timeline.ExecutionStatus status = 11;
      Returns:
      Whether the status field is set.

    • getStatus

      ExecutionStatus getStatus()
      new status (valid for activities)
      optional .yamcs.protobuf.timeline.ExecutionStatus status = 11;
      Returns:
      The status.

    • hasFailureReason

      boolean hasFailureReason()
      failure reason (valid for activities)
      optional string failureReason = 12;
      Returns:
      Whether the failureReason field is set.

    • getFailureReason

      String getFailureReason()
      failure reason (valid for activities)
      optional string failureReason = 12;
      Returns:
      The failureReason.

    • getFailureReasonBytes

      com.google.protobuf.ByteString getFailureReasonBytes()
      failure reason (valid for activities)
      optional string failureReason = 12;
      Returns:
      The bytes for failureReason.

    • getPropertiesCount

      int getPropertiesCount()
       Additional properties used by yamcs-web to render this item
      map<string, string> properties = 13;

    • containsProperties

      boolean containsProperties(String key)
       Additional properties used by yamcs-web to render this item
      map<string, string> properties = 13;

    • getProperties

      @Deprecated Map<String,String> getProperties()
      Deprecated.
      Use getPropertiesMap() instead.

    • getPropertiesMap

      Map<String,String> getPropertiesMap()
       Additional properties used by yamcs-web to render this item
      map<string, string> properties = 13;

    • getPropertiesOrDefault

      String getPropertiesOrDefault(String key, String defaultValue)
       Additional properties used by yamcs-web to render this item
      map<string, string> properties = 13;

    • getPropertiesOrThrow

      String getPropertiesOrThrow(String key)
       Additional properties used by yamcs-web to render this item
      map<string, string> properties = 13;

    • hasClearProperties

      boolean hasClearProperties()
       Set this to true to remove completely all properties
      optional bool clearProperties = 14;
      Returns:
      Whether the clearProperties field is set.

    • getClearProperties

      boolean getClearProperties()
       Set this to true to remove completely all properties
      optional bool clearProperties = 14;
      Returns:
      The clearProperties.