package com.amazonaws.sfc.ipc

Get desktop application:
View/edit binary Protocol Buffers messages

Service to stream output values from SFC core to target services

• rpc InitializeMetricsWriter (InitializeMetricsWriterRequest, InitializeMetricsWriterResponse)

  MetricsWriterService.proto:21

  message InitializeMetricsWriterRequest

  MetricsWriterService.proto:25

  • string metricsConfiguration = 1

  message InitializeMetricsWriterResponse

  MetricsWriterService.proto:29

  • bool initialized = 1

  • string error = 2

• rpc WriteMetrics (stream MetricsDataMessage, google.protobuf.Empty)

  MetricsWriterService.proto:20

  Client side streaming of values to target service

gRPC service to stream source data from server to SFC code

• rpc InitializeAdapter (InitializeAdapterRequest, InitializeAdapterResponse)

  ProtocolAdapterService.proto:24

  message InitializeAdapterRequest

  Types.proto:20

  • string adapterConfiguration = 1

  • map<string, AuxiliarySettings> auxiliary_settings = 2

  message InitializeAdapterResponse

  ProtocolAdapterService.proto:28

  • bool initialized = 1

  • string error = 2

• rpc ReadMetrics (ReadMetricsRequest, stream MetricsDataMessage)

  ProtocolAdapterService.proto:23

• rpc ReadValues (ReadValuesRequest, stream ReadValuesReply)

  ProtocolAdapterService.proto:22

  Reads values, server side streaming

  message ReadValuesRequest

  ProtocolAdapterService.proto:35

  Request for ReadValues

  • repeated SourceReadValueRequest sources = 1

    Sources and channels to read

  • int64 interval = 2

    Read interval

  • optional string scheduleName = 3

    Schedule name

  message ReadValuesReply

  ProtocolAdapterService.proto:53

  Reply containing read source/channel values

  • repeated SourceReadValuesReply sources = 1

  • bytes compressed = 2

Service to stream output values from SFC core to target services

• rpc InitializeTarget (InitializeTargetRequest, InitializeTargetResponse)

  TargetAdapterService.proto:24

  message InitializeTargetRequest

  TargetAdapterService.proto:34

  • string targetID = 1

  • string targetConfiguration = 2

  • optional ReturnedDataMessage returnedData = 3

  • map<string, AuxiliarySettings> auxiliary_settings = 4

  message InitializeTargetResponse

  TargetAdapterService.proto:41

  • bool initialized = 1

  • string error = 2

• rpc ReadMetrics (ReadMetricsRequest, stream MetricsDataMessage)

  TargetAdapterService.proto:23

• rpc WriteValues (stream WriteValuesRequest, stream TargetResultResponse)

  TargetAdapterService.proto:22

  Client side streaming of values to target service

  message TargetResultResponse

  TargetAdapterService.proto:46

  • string target = 1

  • repeated string ackSerials = 10

  • repeated WriteValuesRequest ackRequests = 11

  • repeated string nackSerials = 20

  • repeated WriteValuesRequest nackRequests = 21

  • repeated string errorSerials = 30

  • repeated WriteValuesRequest errorRequests = 31

Used in: InitializeAdapterRequest, InitializeTargetRequest

• map<string, string> settings = 1

Used in: BoolArrayArray, ChannelValue, TargetChannelValue

• repeated bool items = 1

Used in: TargetChannelValue

• repeated BoolArray items = 1

Contains the value for a channel with an optional timestamp Each data type is stored in a designated field in order to maintain datatype fidelity

Used in: ChannelValueArray, SourceReadValuesReply, TypedMap

• oneof value

  • int32 signed_byte = 1

    byte and byte

  • bytes signed_byte_array = 101

  • uint32 unsigned_byte = 2

    unsigned byte

  • bytes unsigned_byte_array = 102

  • sint32 signed_int16 = 11

    integers

  • sint32 signed_int32 = 12

  • sint64 signed_int64 = 13

  • uint32 unsigned_int16 = 14

  • uint32 unsigned_int32 = 15

  • uint64 unsigned_int64 = 16

  • SignedInt16Array signed_int16_array = 111

    integer arrays

  • SignedInt32Array signed_int32_array = 112

  • SignedInt64Array signed_int64_array = 113

  • UnsignedInt16Array unsigned_int16_array = 114

  • UnsignedInt32Array unsigned_int32_array = 115

  • UnsignedInt64Array unsigned_int64_array = 116

  • bool bool = 21

    boolean

  • BoolArray bool_array = 121

  • float float = 31

    float and double

  • double double = 32

  • FloatArray float_array = 131

  • DoubleArray double_array = 132

  • string string = 41

    string

  • StringArray string_array = 141

  • google.protobuf.Timestamp datetime = 51

    timestamps

  • TimestampArray datetime_array = 151

  • string custom = 61

    custom and structured datatype encoded as JSON strings

  • string custom_array = 161

  • TypedMap typed_hash_map = 71

  • TypedMapArray typed_has_map_array = 171

  • ChannelValue channel_value = 81

  • ChannelValueArray channel_value_array = 181

• optional google.protobuf.Timestamp timestamp = 1000

  timestamp for the value

Used in: ChannelValue

• repeated ChannelValue items = 1

• repeated string items = 1

Used in: ChannelValue, DoubleArrayArray, TargetChannelValue

• repeated double items = 1

Used in: TargetChannelValue

• repeated DoubleArray items = 1

Used in: ChannelValue, FloatArrayArray, TargetChannelValue

• repeated float items = 1

Used in: TargetChannelValue

• repeated FloatArray items = 1

• repeated string items = 1

Used in: ReturnedDataMessage

• NONE = 0

• SERIALS = 1

• MESSAGES = 2

Used in: SourceValues, TargetChannelValue, TargetChannelValueAggregationMap, WriteValuesRequest

• map<string, string> metadata = 1

Used in: MetricsDataPoint

• UNITS_NONE = 0

• SECONDS = 1

• MICROSECONDS = 2

• MILLISECONDS = 3

• BYTES = 10

• KILOBYTES = 11

• MEGABYTES = 12

• GIGABYTES = 13

• TERABYTES = 14

• BITS = 20

• KILOBITS = 21

• MEGABITS = 22

• GIGABITS = 23

• TERABITS = 24

• PERCENT = 30

• COUNT = 31

• BYTES_SECOND = 40

• KILOBYTES_SECOND = 41

• MEGABYTES_SECOND = 42

• GIGABYTES_SECOND = 43

• TERABYTES_SECOND = 44

• BITS_SECOND = 50

• KILOBITS_SECOND = 51

• MEGABITS_SECOND = 52

• GIGABITS_SECOND = 53

• TERABITS_SECOND = 54

• COUNT_SECOND = 60

Used as request type in: MetricsWriterService.WriteMetrics

Used as response type in: ProtocolAdapterService.ReadMetrics, TargetAdapterService.ReadMetrics

• string source = 1

• MetricsSourceType sourceType = 2

• map<string, string> commonDimensions = 3

• repeated MetricsDataPoint dataPoints = 4

Used in: MetricsDataMessage

• string name = 1

• map<string, string> dimensions = 2

• MetricUnits units = 3

• optional google.protobuf.Timestamp timestamp = 4

• oneof value

  • double singleValue = 10

  • ValueList values = 11

  • MetricsStatistics statistics = 12

Used in: MetricsDataMessage

• UNDEFINED = 0

• SFC_CORE = 1

• PROTOCOL_ADAPTER = 2

• TARGET_WRITER = 3

Used in: MetricsDataPoint

• double maximum = 1

• double minimum = 2

• double sampleCount = 3

• double sum = 4

Used as request type in: ProtocolAdapterService.ReadMetrics, TargetAdapterService.ReadMetrics

• int64 interval = 1

Used in: InitializeTargetRequest

• MessageData ack = 1

• MessageData nack = 2

• MessageData error = 3

Used in: TargetChannelValue

• repeated bytes items = 1

Used in: ChannelValue, SignedInt16ArrayArray, TargetChannelValue

• repeated sint32 items = 1

Used in: TargetChannelValue

• repeated SignedInt16Array items = 1

Used in: ChannelValue, SignedInt32ArrayArray, TargetChannelValue

• repeated sint32 items = 1

Used in: TargetChannelValue

• repeated SignedInt32Array items = 1

Used in: ChannelValue, SignedInt64ArrayArray, TargetChannelValue

• repeated sint64 items = 1

Used in: TargetChannelValue

• repeated SignedInt64Array items = 1

Source and its channels to read

Used in: ReadValuesRequest

• string sourceID = 1

  ID of the source

• repeated string channels = 2

  IDs of the channels

Values fro a single source

Used in: ReadValuesReply

• string sourceID = 1

  ID of the source

• map<string, ChannelValue> values = 2

  Channel values

• optional google.protobuf.Timestamp timestamp = 3

  Source/server level timestamp

• string error = 4

  Read error

Values to write

Used in: WriteValuesRequest

• oneof value

  • TargetChannelValuesMap values = 1

    map of values source/channels

  • TargetChannelValueAggregationMap aggregated_values = 2

    map of source/channel/aggregations

• optional Metadata metadata = 3

• optional google.protobuf.Timestamp source_timestamp = 4

Used in: ChannelValue, StringArrayArray, TargetChannelValue

• repeated string items = 1

Used in: TargetChannelValue

• repeated StringArray items = 1

Contains the actual value. Each datatype has designated field in order to keep data type fidelity

Used in: TargetChannelValuesList, TargetChannelValuesMap, TypedTargetChannelValueMap

• optional google.protobuf.Timestamp value_timestamp = 1

• optional Metadata metadata = 2

• oneof value

  • int32 signed_byte = 101

    byte

  • bytes signed_byte_array = 201

  • SignedByteArrayArray signed_byte_array_array = 301

  • uint32 unsigned_byte = 102

    unsigned byte

  • bytes unsigned_byte_array = 202

  • UnsignedByteArrayArray unsigned_byte_array_array = 302

  • sint32 signed_int16 = 111

    integers

  • sint32 signed_int32 = 112

  • sint64 signed_int64 = 113

  • uint32 unsigned_int16 = 114

  • uint32 unsigned_int32 = 115

  • uint64 unsigned_int64 = 116

  • SignedInt16Array signed_int16_array = 211

    array of integers

  • SignedInt32Array signed_int32_array = 212

  • SignedInt64Array signed_int64_array = 213

  • UnsignedInt16Array unsigned_int16_array = 214

  • UnsignedInt32Array unsigned_int32_array = 215

  • UnsignedInt64Array unsigned_int64_array = 216

  • SignedInt16ArrayArray signed_int16array_array = 311

    array of arrays of integers

  • SignedInt32ArrayArray signed_int32array_array = 312

  • SignedInt64ArrayArray signed_int64array_array = 313

  • UnsignedInt16ArrayArray unsigned_int16_array_array = 314

  • UnsignedInt32ArrayArray unsigned_int32_array_array = 315

  • UnsignedInt64ArrayArray unsigned_int64_array_array = 316

  • bool bool = 121

    boolean

  • BoolArray bool_array = 221

  • BoolArrayArray bool_array_array = 321

  • float float = 131

    float and double

  • double double = 132

  • FloatArray float_array = 231

  • DoubleArray double_array = 232

  • FloatArrayArray float_array_array = 331

  • DoubleArrayArray double_array_array = 332

  • string string = 141

    strings

  • StringArray string_array = 241

  • StringArrayArray string_array_array = 341

  • google.protobuf.Timestamp timestamp = 151

    timestamp

  • TimestampArray timestamp_array = 251

  • string custom = 161

    custom encoded as JSON

  • string custom_array = 261

  • TypedTargetChannelValueMap typed_hash_map = 171

    maps

  • TypedTargetChannelValueMapArray typed_hash_map_array = 271

  • TargetChannelValuesList values_list = 400

Map of source/channel/aggregations

Used in: SourceValues

• map<string, TargetChannelValuesMap> values = 1

• map<string, Metadata> metadata = 2

List of channel values

Used in: TargetChannelValue

• repeated TargetChannelValue items = 1

Map of channel values

Used in: SourceValues, TargetChannelValueAggregationMap

• map<string, TargetChannelValue> value = 1

Used in: ChannelValue, TargetChannelValue

• repeated google.protobuf.Timestamp timestamp = 1

Used in: ChannelValue, TypedMapArray

• map<string, ChannelValue> entries = 1

Used in: ChannelValue

• repeated TypedMap items = 1

Used in: TargetChannelValue, TypedTargetChannelValueMapArray

• map<string, TargetChannelValue> entries = 1

Used in: TargetChannelValue

• repeated TypedTargetChannelValueMap items = 1

Used in: TargetChannelValue

• repeated bytes items = 1

Used in: ChannelValue, TargetChannelValue, UnsignedInt16ArrayArray

• repeated uint32 items = 1

Used in: TargetChannelValue

• repeated UnsignedInt16Array items = 1

Used in: ChannelValue, TargetChannelValue, UnsignedInt32ArrayArray

• repeated uint32 items = 1

Used in: TargetChannelValue

• repeated UnsignedInt32Array items = 1

Used in: ChannelValue, TargetChannelValue, UnsignedInt64ArrayArray

• repeated uint64 items = 1

Used in: TargetChannelValue

• repeated UnsignedInt64Array items = 1

Used in: MetricsDataPoint

• repeated double values = 1

• repeated double count = 2

Request for WriteValues service call

Used as request type in: TargetAdapterService.WriteValues

Used as field type in: TargetResultResponse

• string schedule = 1

  Name of the schedule

• map<string, SourceValues> values = 2

• optional Metadata metadata = 3

• string serial = 4

• optional google.protobuf.Timestamp created_timestamp = 5

• bool noBuffering = 6

• bytes compressed = 100