Package Arp.Services.DataLogger.Services.Grpc

Enum Class SessionPropertyNameOuterClass.SessionPropertyName

java.lang.Object
java.lang.Enum<SessionPropertyNameOuterClass.SessionPropertyName>
Arp.Services.DataLogger.Services.Grpc.SessionPropertyNameOuterClass.SessionPropertyName
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SessionPropertyNameOuterClass.SessionPropertyName>, Constable
Enclosing class:
SessionPropertyNameOuterClass
public static enum SessionPropertyNameOuterClass.SessionPropertyName extends Enum<SessionPropertyNameOuterClass.SessionPropertyName> implements com.google.protobuf.ProtocolMessageEnum
/ <summary>
 / All available names of properties that can be set on a session
 / </summary>
Protobuf enum Arp.Services.DataLogger.Services.Grpc.SessionPropertyName

  • Enum Constant Details

    • SPN_Undefined

      public static final SessionPropertyNameOuterClass.SessionPropertyName SPN_Undefined
      / <summary>
 / Determines a newly created not yet configured property
 / </summary>
 / <remarks>
 / <cref name="SessionProperty" /> with undefined name will be ignored.</remarks>
      SPN_Undefined = 0;

    • SPN_SamplingInterval

      public static final SessionPropertyNameOuterClass.SessionPropertyName SPN_SamplingInterval
      / <summary>
 / The desired sampling rate. Can either be provided as Int64 which will be interpreted as microseconds count or as string containing
 / the actual unit, e.g. "100ms".
 / </summary>
 / <remarks>See <cref name="ISubscriptionService::Subscribe" /> for more information about the sampling rate</remarks>
      SPN_SamplingInterval = 1;

    • SPN_PublishInterval

      public static final SessionPropertyNameOuterClass.SessionPropertyName SPN_PublishInterval
      / <summary>
 / The rate in which values will be written to the session´s sink. Can either be provided as Int64 which will be interpreted as
 / microseconds count or as string containing the actual unit, e.g. "100ms"
 / </summary>
      SPN_PublishInterval = 2;

    • SPN_BufferCapacity

      public static final SessionPropertyNameOuterClass.SessionPropertyName SPN_BufferCapacity
      / <summary>
 / Amount of capacity of the underlying ring buffer.
 / </summary>
 / <remarks>See <cref name="ISubscriptionService::CreateRecordingSubscription" /> for more information</remarks>
      SPN_BufferCapacity = 3;

    • SPN_SinkType

      public static final SessionPropertyNameOuterClass.SessionPropertyName SPN_SinkType
      / <summary>
 / The type of sink used by the session. Must be of type <cref name="SinkType" /></summary>
      SPN_SinkType = 4;

    • SPN_SinkProperties

      public static final SessionPropertyNameOuterClass.SessionPropertyName SPN_SinkProperties
      / <summary>
 / Special property to configure a session sinks. Properties must be provided as string.
 / </summary>
      SPN_SinkProperties = 5;

    • UNRECOGNIZED

      public static final SessionPropertyNameOuterClass.SessionPropertyName UNRECOGNIZED

  • Field Details

    • SPN_Undefined_VALUE

      public static final int SPN_Undefined_VALUE
      / <summary>
 / Determines a newly created not yet configured property
 / </summary>
 / <remarks>
 / <cref name="SessionProperty" /> with undefined name will be ignored.</remarks>
      SPN_Undefined = 0;
      See Also:

    • SPN_SamplingInterval_VALUE

      public static final int SPN_SamplingInterval_VALUE
      / <summary>
 / The desired sampling rate. Can either be provided as Int64 which will be interpreted as microseconds count or as string containing
 / the actual unit, e.g. "100ms".
 / </summary>
 / <remarks>See <cref name="ISubscriptionService::Subscribe" /> for more information about the sampling rate</remarks>
      SPN_SamplingInterval = 1;
      See Also:

    • SPN_PublishInterval_VALUE

      public static final int SPN_PublishInterval_VALUE
      / <summary>
 / The rate in which values will be written to the session´s sink. Can either be provided as Int64 which will be interpreted as
 / microseconds count or as string containing the actual unit, e.g. "100ms"
 / </summary>
      SPN_PublishInterval = 2;
      See Also:

    • SPN_BufferCapacity_VALUE

      public static final int SPN_BufferCapacity_VALUE
      / <summary>
 / Amount of capacity of the underlying ring buffer.
 / </summary>
 / <remarks>See <cref name="ISubscriptionService::CreateRecordingSubscription" /> for more information</remarks>
      SPN_BufferCapacity = 3;
      See Also:

    • SPN_SinkType_VALUE

      public static final int SPN_SinkType_VALUE
      / <summary>
 / The type of sink used by the session. Must be of type <cref name="SinkType" /></summary>
      SPN_SinkType = 4;
      See Also:

    • SPN_SinkProperties_VALUE

      public static final int SPN_SinkProperties_VALUE
      / <summary>
 / Special property to configure a session sinks. Properties must be provided as string.
 / </summary>
      SPN_SinkProperties = 5;
      See Also:

    • internalValueMap

      private static final com.google.protobuf.Internal.EnumLiteMap<SessionPropertyNameOuterClass.SessionPropertyName> internalValueMap

    • VALUES

      private static final SessionPropertyNameOuterClass.SessionPropertyName[] VALUES

    • value

      private final int value

  • Constructor Details

    • SessionPropertyName

      private SessionPropertyName(int value)

  • Method Details

    • values

      public static SessionPropertyNameOuterClass.SessionPropertyName[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SessionPropertyNameOuterClass.SessionPropertyName valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static SessionPropertyNameOuterClass.SessionPropertyName valueOf(int value)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static SessionPropertyNameOuterClass.SessionPropertyName forNumber(int value)

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<SessionPropertyNameOuterClass.SessionPropertyName> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

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

    • valueOf

      public static SessionPropertyNameOuterClass.SessionPropertyName valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null