org.yamcs.protobuf.CreateEventRequestOrBuilder 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
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.9
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yamcs/protobuf/events/events_service.proto

package org.yamcs.protobuf;

public interface CreateEventRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.events.CreateEventRequest)
    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();

  /**
   *    * Description of the type of the event. Useful for quick classification or filtering.
   * 
   *
   * optional string type = 2;
   * @return Whether the type field is set.
   */
  boolean hasType();
  /**
   *    * Description of the type of the event. Useful for quick classification or filtering.
   * 
   *
   * optional string type = 2;
   * @return The type.
   */
  java.lang.String getType();
  /**
   *    * Description of the type of the event. Useful for quick classification or filtering.
   * 
   *
   * optional string type = 2;
   * @return The bytes for type.
   */
  com.google.protobuf.ByteString
      getTypeBytes();

  /**
   *    * **Required.** Event message.
   * 
   *
   * optional string message = 3;
   * @return Whether the message field is set.
   */
  boolean hasMessage();
  /**
   *    * **Required.** Event message.
   * 
   *
   * optional string message = 3;
   * @return The message.
   */
  java.lang.String getMessage();
  /**
   *    * **Required.** Event message.
   * 
   *
   * optional string message = 3;
   * @return The bytes for message.
   */
  com.google.protobuf.ByteString
      getMessageBytes();

  /**
   *    * The severity level of the event. One of ``info``, ``watch``, ``warning``,
   * ``distress``, ``critical`` or ``severe``. Default is ``info``
   * 
   *
   * optional string severity = 4;
   * @return Whether the severity field is set.
   */
  boolean hasSeverity();
  /**
   *    * The severity level of the event. One of ``info``, ``watch``, ``warning``,
   * ``distress``, ``critical`` or ``severe``. Default is ``info``
   * 
   *
   * optional string severity = 4;
   * @return The severity.
   */
  java.lang.String getSeverity();
  /**
   *    * The severity level of the event. One of ``info``, ``watch``, ``warning``,
   * ``distress``, ``critical`` or ``severe``. Default is ``info``
   * 
   *
   * optional string severity = 4;
   * @return The bytes for severity.
   */
  com.google.protobuf.ByteString
      getSeverityBytes();

  /**
   *    * Time associated with the event.
   * If unspecified, this will default to the current mission time.
   * 
   *
   * optional .google.protobuf.Timestamp time = 5;
   * @return Whether the time field is set.
   */
  boolean hasTime();
  /**
   *    * Time associated with the event.
   * If unspecified, this will default to the current mission time.
   * 
   *
   * optional .google.protobuf.Timestamp time = 5;
   * @return The time.
   */
  com.google.protobuf.Timestamp getTime();
  /**
   *    * Time associated with the event.
   * If unspecified, this will default to the current mission time.
   * 
   *
   * optional .google.protobuf.Timestamp time = 5;
   */
  com.google.protobuf.TimestampOrBuilder getTimeOrBuilder();

  /**
   *    * Source of the event. Useful for grouping events in the archive. Default is
   * ``User``.
   * 
   *
   * optional string source = 6;
   * @return Whether the source field is set.
   */
  boolean hasSource();
  /**
   *    * Source of the event. Useful for grouping events in the archive. Default is
   * ``User``.
   * 
   *
   * optional string source = 6;
   * @return The source.
   */
  java.lang.String getSource();
  /**
   *    * Source of the event. Useful for grouping events in the archive. Default is
   * ``User``.
   * 
   *
   * optional string source = 6;
   * @return The bytes for source.
   */
  com.google.protobuf.ByteString
      getSourceBytes();

  /**
   *    * Sequence number of this event. This is primarily used to determine unicity of
   * events coming from the same source. If not set Yamcs will automatically
   * assign a sequential number as if every submitted event is unique.
   * 
   *
   * optional int32 sequenceNumber = 7;
   * @return Whether the sequenceNumber field is set.
   */
  boolean hasSequenceNumber();
  /**
   *    * Sequence number of this event. This is primarily used to determine unicity of
   * events coming from the same source. If not set Yamcs will automatically
   * assign a sequential number as if every submitted event is unique.
   * 
   *
   * optional int32 sequenceNumber = 7;
   * @return The sequenceNumber.
   */
  int getSequenceNumber();

  /**
   *    * Additional properties
   * 
   *
   * map<string, string> extra = 8;
   */
  int getExtraCount();
  /**
   *    * Additional properties
   * 
   *
   * map<string, string> extra = 8;
   */
  boolean containsExtra(
      java.lang.String key);
  /**
   * Use {@link #getExtraMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getExtra();
  /**
   *    * Additional properties
   * 
   *
   * map<string, string> extra = 8;
   */
  java.util.Map
  getExtraMap();
  /**
   *    * Additional properties
   * 
   *
   * map<string, string> extra = 8;
   */

  java.lang.String getExtraOrDefault(
      java.lang.String key,
      java.lang.String defaultValue);
  /**
   *    * Additional properties
   * 
   *
   * map<string, string> extra = 8;
   */

  java.lang.String getExtraOrThrow(
      java.lang.String key);
}