config

Documentation

Overview

******************************************************************************

• Copyright 2021 Dell Inc. *
• Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
• in compliance with the License. You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software distributed under the License
• is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
• or implied. See the License for the specific language governing permissions and limitations under
• the License. ******************************************************************************

******************************************************************************

• Copyright 2021 Dell Inc. *
• Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
• in compliance with the License. You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software distributed under the License
• is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
• or implied. See the License for the specific language governing permissions and limitations under
• the License. ******************************************************************************

******************************************************************************

• Copyright 2021 Dell Inc. *
• Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
• in compliance with the License. You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software distributed under the License
• is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
• or implied. See the License for the specific language governing permissions and limitations under
• the License. ******************************************************************************

******************************************************************************

• Copyright 2021 Dell Inc. *
• Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
• in compliance with the License. You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software distributed under the License
• is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
• or implied. See the License for the specific language governing permissions and limitations under
• the License. ******************************************************************************

******************************************************************************

• Copyright 2021 Dell Inc. *
• Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
• in compliance with the License. You may obtain a copy of the License at *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software distributed under the License
• is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
• or implied. See the License for the specific language governing permissions and limitations under
• the License. ******************************************************************************

Index

• type Configuration
• type HashInfo
  • func (h *HashInfo) UnmarshalJSON(data []byte) (err error)
• type IotaStreamConfig
• type KeyInfo
  • func (k *KeyInfo) UnmarshalJSON(data []byte) (err error)
• type MqttConfig
• type SdkInfo
  • func (s *SdkInfo) UnmarshalJSON(data []byte) (err error)
• type ServiceInfo
  • func (s ServiceInfo) Uri() string
• type SignatureInfo
• type StreamInfo
  • func (s *StreamInfo) UnmarshalJSON(data []byte) (err error)

Types

type Configuration

type Configuration interface {
	AsString() string
}

type HashInfo

type HashInfo struct {
	Type contracts.HashType `json:"type,omitempty"`
}

func (*HashInfo) UnmarshalJSON

func (h *HashInfo) UnmarshalJSON(data []byte) (err error)

type IotaStreamConfig

type IotaStreamConfig struct {
	Provider   ServiceInfo `json:"provider,omitempty"` // Provider is the endpoint from which the Streams subscription is obtained
	TangleNode ServiceInfo `json:"tangle,omitempty"`   // TangleNode is the endpoint of the local Hornet instance. Transactions are written here.
	Encoding   string      `json:"encoding,omitempty"` // Encoding specifies the encoding of transaction messages
}

IotaStreamConfig exposes properties relevant to connecting to an existing IOTA Stream and accompanying Tangle node

type KeyInfo

type KeyInfo struct {
	Type contracts.KeyAlgorithm `json:"type,omitempty"` // Type indicates the algorithm used to generate the key
	Path string                 `json:"path,omitempty"` // Path indicates the filesystem path to the key.

}

func (*KeyInfo) UnmarshalJSON

func (k *KeyInfo) UnmarshalJSON(data []byte) (err error)

type MqttConfig

type MqttConfig struct {
	ClientId  string      `json:"clientId,omitempty"`
	Qos       int         `json:"qos,omitempty"`
	User      string      `json:"user,omitempty"`
	Password  string      `json:"password,omitempty"`
	Provider  ServiceInfo `json:"provider,omitempty"`
	Cleanness bool        `json:"cleanness,omitempty"`
	Topics    []string    `json:"topics,omitempty"`
}

MqttConfig exposes properties relevant to connecting to an existing MQTT broker

type SdkInfo

type SdkInfo struct {
	Annotators []contracts.AnnotationType `json:"annotators,omitempty"`
	Hash       HashInfo                   `json:"hash,omitempty"`
	Signature  SignatureInfo              `json:"signature,omitempty"`
	Stream     StreamInfo                 `json:"stream,omitempty"`
}

func (*SdkInfo) UnmarshalJSON

func (s *SdkInfo) UnmarshalJSON(data []byte) (err error)

type ServiceInfo

type ServiceInfo struct {
	Host     string `json:"host,omitempty"`
	Port     int    `json:"port,omitempty"`
	Protocol string `json:"protocol,omitempty"`
}

ServiceInfo describes a service endpoint that the deployed service is a client of. Right now, this is implicitly an HTTP interaction

func (ServiceInfo) Uri

func (s ServiceInfo) Uri() string

Uri constructs a string from the populated elements of the ServiceInfo

type SignatureInfo

type SignatureInfo struct {
	PublicKey  KeyInfo `json:"public,omitempty"`
	PrivateKey KeyInfo `json:"private,omitempty"`
}

type StreamInfo

type StreamInfo struct {
	Type   contracts.StreamType `json:"type,omitempty"`
	Config interface{}          `json:"config,omitempty"`
}

StreamInfo facilitates configuration of a given streaming platform that will receive annotations

func (*StreamInfo) UnmarshalJSON

func (s *StreamInfo) UnmarshalJSON(data []byte) (err error)