Package-level declarations

Types

Link copied to clipboard
data class AssetStatusErrorResponse(val code: Int, val message: String)

Defines the asset status error properties.

Link copied to clipboard
data class AssetStatusResponse(val errors: List<AssetStatusErrorResponse>, val version: Int)

Defines the asset status properties.

Link copied to clipboard
data class DataPointResponse(val capabilityId: String? = null, val dataPointConfiguration: String? = null, val dataSource: String, val name: String? = null, val observabilityMode: String? = null)

Defines the data point properties.

Link copied to clipboard
data class DiscoveredDataPointResponse(val dataPointConfiguration: String? = null, val dataSource: String, val lastUpdatedOn: String? = null, val name: String)

Defines the data point properties.

Link copied to clipboard
data class DiscoveredDatasetResponse(val dataPoints: List<DiscoveredDataPointResponse>? = null, val datasetConfiguration: String? = null, val name: String, val topic: TopicResponse? = null)

Defines the dataset properties.

Link copied to clipboard
data class DiscoveredEventResponse(val eventConfiguration: String? = null, val eventNotifier: String, val lastUpdatedOn: String? = null, val name: String, val topic: TopicResponse? = null)

Defines the event properties.

Link copied to clipboard
data class EventResponse(val capabilityId: String? = null, val eventConfiguration: String? = null, val eventNotifier: String, val name: String? = null, val observabilityMode: String? = null)

Defines the event properties.

Link copied to clipboard
data class ExtendedLocationResponse(val name: String, val type: String)

The extended location.

Link copied to clipboard
data class GetAssetEndpointProfileResult(val additionalConfiguration: String? = null, val extendedLocation: ExtendedLocationResponse, val id: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val targetAddress: String, val transportAuthentication: TransportAuthenticationResponse? = null, val type: String, val userAuthentication: UserAuthenticationResponse? = null, val uuid: String)

Asset Endpoint Profile definition.

Link copied to clipboard
data class GetAssetResult(val assetEndpointProfileUri: String, val assetType: String? = null, val attributes: Any? = null, val dataPoints: List<DataPointResponse>? = null, val defaultDataPointsConfiguration: String? = null, val defaultEventsConfiguration: String? = null, val description: String? = null, val displayName: String? = null, val documentationUri: String? = null, val enabled: Boolean? = null, val events: List<EventResponse>? = null, val extendedLocation: ExtendedLocationResponse, val externalAssetId: String? = null, val hardwareRevision: String? = null, val id: String, val location: String, val manufacturer: String? = null, val manufacturerUri: String? = null, val model: String? = null, val name: String, val productCode: String? = null, val provisioningState: String, val serialNumber: String? = null, val softwareRevision: String? = null, val status: AssetStatusResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uuid: String, val version: Int)

Asset definition.

Link copied to clipboard
data class GetDiscoveredAssetEndpointProfileResult(val additionalConfiguration: String? = null, val discoveryId: String, val endpointProfileType: String, val extendedLocation: ExtendedLocationResponse, val id: String, val location: String, val name: String, val provisioningState: String, val supportedAuthenticationMethods: List<String>? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val targetAddress: String, val type: String, val version: Double)

Discovered Asset Endpoint Profile definition.

Link copied to clipboard
data class GetDiscoveredAssetResult(val assetEndpointProfileRef: String, val datasets: List<DiscoveredDatasetResponse>? = null, val defaultDatasetsConfiguration: String? = null, val defaultEventsConfiguration: String? = null, val defaultTopic: TopicResponse? = null, val discoveryId: String, val documentationUri: String? = null, val events: List<DiscoveredEventResponse>? = null, val extendedLocation: ExtendedLocationResponse, val hardwareRevision: String? = null, val id: String, val location: String, val manufacturer: String? = null, val manufacturerUri: String? = null, val model: String? = null, val name: String, val productCode: String? = null, val provisioningState: String, val serialNumber: String? = null, val softwareRevision: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val version: Double)

Discovered Asset definition.

Link copied to clipboard
data class GetSchemaRegistryResult(val description: String? = null, val displayName: String? = null, val id: String, val identity: SystemAssignedServiceIdentityResponse? = null, val location: String, val name: String, val namespace: String, val provisioningState: String, val storageAccountContainerUrl: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uuid: String)

Schema registry definition.

Link copied to clipboard
data class GetSchemaResult(val description: String? = null, val displayName: String? = null, val format: String, val id: String, val name: String, val provisioningState: String, val schemaType: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uuid: String)

Schema definition.

Link copied to clipboard
data class GetSchemaVersionResult(val description: String? = null, val hash: String, val id: String, val name: String, val provisioningState: String, val schemaContent: String, val systemData: SystemDataResponse, val type: String, val uuid: String)

Schema version's definition.

Link copied to clipboard
data class OwnCertificateResponse(val certPasswordReference: String? = null, val certSecretReference: String? = null, val certThumbprint: String? = null)

Certificate or private key that can be used by the southbound connector connecting to the shop floor/OT device. The accepted extensions are .der for certificates and .pfx/.pem for private keys.

Link copied to clipboard
data class SystemAssignedServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String)

Managed service identity (either system assigned, or none)

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TopicResponse(val path: String, val retain: String? = null)

Object that describes the topic information.

Link copied to clipboard

Definition of the authentication mechanism for the southbound connector.

Link copied to clipboard
data class UserAuthenticationResponse(val mode: String, val usernamePasswordCredentials: UsernamePasswordCredentialsResponse? = null, val x509Credentials: X509CredentialsResponse? = null)

Definition of the client authentication mechanism to the server.

Link copied to clipboard
data class UsernamePasswordCredentialsResponse(val passwordReference: String, val usernameReference: String)

The credentials for authentication mode UsernamePassword.

Link copied to clipboard
data class X509CredentialsResponse(val certificateReference: String)

The x509 certificate for authentication mode Certificate.