Output profile models

Attributes:

• AZURE –
• RAW –

AZURE = 'azure'

RAW = 'raw'

Attributes:

• active (bool | None) –

  Defaults to true if not set

• destination_id (str | None) –

  The unique destination identifier assigned by the MQ APIs after creation

• environment (OutputProfileEnvironment | None) –

  The deployment environment of the destination. Indicates the criticality of the delivered messages

active: bool | None = None

destination_id: str | None = None

environment: OutputProfileEnvironment | None = None

Attributes:

• endpoint (str) –

  The IoT Core endpoint. Must be a valid URL in the form '{account-specific-prefix}.iot.{aws-region}.amazonaws.com'

• private_key (str) –

  The x509 private key. Note: You'll need to replace newlines with `

• x509_certificate (str) –

  The x509 certificate pem file. Note: You'll need to replace newlines with `

endpoint: str

private_key: str

x509_certificate: str = Field(
    serialization_alias="x509Certificate",
    validation_alias="x509Certificate",
)

Attributes:

• api_version (str) –

  The API Version which the latest is currently 2021-10-01. Previously 2021-04-12 and 2016-11-14.

• host (str) –

  The IoT Hub hostname. Must be a valid URL in the form '{hubname}.azure-devices.net' and must not contain a scheme.

• output_format (AzureOutputFormat) –

  Azure is the IoT Hub common Device to Cloud (D2C) format.

• shared_access_key (str) –
• shared_access_policy_name (str) –

  The shared access policy name with Device access enabled.

api_version: str

host: str

output_format: AzureOutputFormat = RAW

shared_access_key: str

shared_access_policy_name: str

Attributes:

• aws_params (list[OutputProfileAWSParams] | None) –
• azure_params (list[OutputProfileAzureMQTTParams] | None) –
• mqtt_params (list[OutputProfileMQTTParams] | None) –
• name (str) –
• rest_params (list[OutputProfileRestParams] | None) –

aws_params: list[OutputProfileAWSParams] | None = Field(
    default=None, alias="AWSParams"
)

azure_params: list[OutputProfileAzureMQTTParams] | None = (
    None
)

mqtt_params: list[OutputProfileMQTTParams] | None = None

name: str

rest_params: list[OutputProfileRestParams] | None = None

Attributes:

• id (str) –

id: str

Attributes:

• deveui (str) –
• error (str) –
• response (bool) –

deveui: str

error: str

response: bool

Attributes:

• devices (list[str] | None) –

devices: list[str] | None

Attributes:

• responses (list[OutputProfileDevicesResponse]) –

responses: list[OutputProfileDevicesResponse]

Attributes:

• DEVELOPMENT –
• PRODUCTION –
• STAGING –

DEVELOPMENT = 'development'

PRODUCTION = 'production'

STAGING = 'staging'

Attributes:

• response (bool) –

response: bool

Attributes:

• aws_params (list[OutputProfileAWSParams]) –
• azure_params (list[OutputProfileAzureMQTTParams]) –
• id (str) –
• mqtt_params (list[OutputProfileMQTTParams]) –
• name (str) –
• rest_params (list[OutputProfileRestParams]) –

aws_params: list[OutputProfileAWSParams] = Field(
    alias="AWSParams"
)

azure_params: list[OutputProfileAzureMQTTParams]

id: str

mqtt_params: list[OutputProfileMQTTParams]

name: str

rest_params: list[OutputProfileRestParams]

Attributes:

• SSL (bool | None) –
• client_id (str | None) –

  The custom client id to be used (${DEVEUI} and ${FPORT} used as replacement variables).

• host (str) –

  The MQTT hostname including the port (E.g., machineq-dev.mqtt.net:8883). Must be a valid hostname

• password (str) –
• topic (str) –

  MQTT Topic (${DEVEUI} and ${FPORT} used as replacement variables)

• username (str) –

SSL: bool | None = None

client_id: str | None = None

host: str

password: str

topic: str

username: str

Attributes:

• aws_params (list[OutputProfileAWSParams] | None) –
• azure_params (list[OutputProfileAzureMQTTParams] | None) –
• mqtt_params (list[OutputProfileMQTTParams] | None) –
• name (str | None) –
• rest_params (list[OutputProfileRestParams] | None) –

aws_params: list[OutputProfileAWSParams] | None = Field(
    default=None, alias="AWSParams"
)

azure_params: list[OutputProfileAzureMQTTParams] | None = (
    None
)

mqtt_params: list[OutputProfileMQTTParams] | None = None

name: str | None = None

rest_params: list[OutputProfileRestParams] | None = None

Attributes:

• output_profiles (list[OutputProfileInstance]) –

output_profiles: list[OutputProfileInstance]

Attributes:

• output_format (str) –
• token_type (str | None) –
• token_value (str | None) –
• url (str) –

  The full URL to a REST service. Must be a valid HTTP URL that contains a scheme and an optional port (E.g., https://machineq.dev.net:6565)

output_format: str = 'extended'

token_type: str | None = None

token_value: str | None = None

url: str = Field(
    serialization_alias="URL", validation_alias="URL"
)

Attributes:

• aws_params (list[OutputProfileAWSParams] | None) –
• azure_params (list[OutputProfileAzureMQTTParams] | None) –
• mqtt_params (list[OutputProfileMQTTParams] | None) –
• name (str) –
• rest_params (list[OutputProfileRestParams] | None) –

aws_params: list[OutputProfileAWSParams] | None = Field(
    default=None, alias="AWSParams"
)

azure_params: list[OutputProfileAzureMQTTParams] | None

mqtt_params: list[OutputProfileMQTTParams] | None

name: str

rest_params: list[OutputProfileRestParams] | None