Package-level declarations

Types

Link copied to clipboard
data class AssetEndpointProfilePropertiesResponse(val additionalConfiguration: String? = null, val provisioningState: String, val targetAddress: String, val transportAuthentication: AssetEndpointProfilePropertiesResponseTransportAuthentication? = null, val userAuthentication: AssetEndpointProfilePropertiesResponseUserAuthentication? = null, val uuid: String)

Defines the Asset Endpoint Profile properties.

data class AssetEndpointProfilePropertiesResponseOwnCertificates(val certPasswordReference: String? = null, val certSecretReference: String? = null, val certThumbprint: String? = null)

Defines the authentication mechanism for the southbound connector connecting to the shop floor/OT device.

Defines the client authentication mechanism to the server.

data class AssetEndpointProfilePropertiesResponseUsernamePasswordCredentials(val passwordReference: String, val usernameReference: String)

Defines the username and password references when UsernamePassword user authentication mode is selected.

Defines the certificate reference when Certificate user authentication mode is selected.

data class AssetEndpointProfileResponseExtendedLocation(val name: String? = null, val type: String? = null)

The extended location.

Link copied to clipboard
data class AssetPropertiesResponseDataPoints(val capabilityId: String? = null, val dataPointConfiguration: String? = null, val dataSource: String, val name: String? = null, val observabilityMode: String? = null)
Link copied to clipboard
data class AssetPropertiesResponseErrors(val code: Int? = null, val message: String? = null)
Link copied to clipboard
data class AssetPropertiesResponseEvents(val capabilityId: String? = null, val eventConfiguration: String? = null, val eventNotifier: String, val name: String? = null, val observabilityMode: String? = null)
Link copied to clipboard
data class AssetPropertiesResponseStatus(val errors: List<AssetPropertiesResponseErrors>? = null, val version: Int? = null)

Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.

Link copied to clipboard
data class AssetResponseExtendedLocation(val name: String? = null, val type: String? = null)

The extended location.

Link copied to clipboard
data class AssetResponseProperties(val assetEndpointProfileUri: String, val assetType: String? = null, val attributes: Any? = null, val dataPoints: List<AssetPropertiesResponseDataPoints>? = 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<AssetPropertiesResponseEvents>? = null, val externalAssetId: String? = null, val hardwareRevision: String? = null, val manufacturer: String? = null, val manufacturerUri: String? = null, val model: String? = null, val productCode: String? = null, val provisioningState: String, val serialNumber: String? = null, val softwareRevision: String? = null, val status: AssetPropertiesResponseStatus, val uuid: String, val version: Int)

Asset resource properties.

Link copied to clipboard
data class GetAssetEndpointProfileResult(val extendedLocation: AssetEndpointProfileResponseExtendedLocation, val id: String, val location: String, val name: String, val properties: AssetEndpointProfilePropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Asset Endpoint Profile definition.

Link copied to clipboard
data class GetAssetResult(val extendedLocation: AssetResponseExtendedLocation, val id: String, val location: String, val name: String, val properties: AssetResponseProperties, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Asset definition.

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.