Hosted Extractors

Sources

`AsyncCogniteClient.hosted_extractors.sources.__call__`([...])	Iterate over sources
`AsyncCogniteClient.hosted_extractors.sources.create`(items)	Create one or more sources.
`AsyncCogniteClient.hosted_extractors.sources.delete`(...)	Delete one or more sources.
`AsyncCogniteClient.hosted_extractors.sources.list`([limit])	List sources.
`AsyncCogniteClient.hosted_extractors.sources.retrieve`(...)	Retrieve one or more sources.
`AsyncCogniteClient.hosted_extractors.sources.update`(items)	Update one or more sources.

Jobs

`AsyncCogniteClient.hosted_extractors.jobs.__call__`([...])	Iterate over jobs
`AsyncCogniteClient.hosted_extractors.jobs.create`(items)	Create one or more jobs.
`AsyncCogniteClient.hosted_extractors.jobs.delete`(...)	Delete one or more jobs.
`AsyncCogniteClient.hosted_extractors.jobs.list`([limit])	List jobs.
`AsyncCogniteClient.hosted_extractors.jobs.list_logs`([...])	List job logs.
`AsyncCogniteClient.hosted_extractors.jobs.list_metrics`([...])	List job metrics.
`AsyncCogniteClient.hosted_extractors.jobs.retrieve`(...)	Retrieve one or more jobs.
`AsyncCogniteClient.hosted_extractors.jobs.update`(items)	Update one or more jobs.

Destinations

`AsyncCogniteClient.hosted_extractors.destinations.__call__`([...])	Iterate over destinations
`AsyncCogniteClient.hosted_extractors.destinations.create`(items)	Create one or more destinations.
`AsyncCogniteClient.hosted_extractors.destinations.delete`(...)	Delete one or more destinations.
`AsyncCogniteClient.hosted_extractors.destinations.list`([limit])	List destinations.
`AsyncCogniteClient.hosted_extractors.destinations.retrieve`(...)	Retrieve one or more destinations.
`AsyncCogniteClient.hosted_extractors.destinations.update`(items)	Update one or more destinations.

Mappings

`AsyncCogniteClient.hosted_extractors.mappings.__call__`([...])	Iterate over mappings
`AsyncCogniteClient.hosted_extractors.mappings.create`(items)	Create one or more mappings.
`AsyncCogniteClient.hosted_extractors.mappings.delete`(...)	Delete one or more mappings.
`AsyncCogniteClient.hosted_extractors.mappings.list`([limit])	List mappings.
`AsyncCogniteClient.hosted_extractors.mappings.retrieve`(...)	Retrieve one or more mappings.
`AsyncCogniteClient.hosted_extractors.mappings.update`(items)	Update one or more mappings.

Data classes

class cognite.client.data_classes.hosted_extractors.BodyLoad(value: 'str'): Bases: IncrementalLoad

class cognite.client.data_classes.hosted_extractors.CSVInput(delimiter: 'str' = ',', custom_keys: 'list[str] | None' = None): Bases: InputMapping

class cognite.client.data_classes.hosted_extractors.CogniteFormat( encoding: "Literal['utf16', 'utf16le'] | None" = None, compression: 'str | None' = None, prefix: 'Prefix | None' = None, )

Bases: JobFormat

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.CustomFormat( mapping_id: 'str', encoding: "Literal['utf16', 'utf16le'] | None" = None, compression: 'str | None' = None, ): Bases: JobFormat

class cognite.client.data_classes.hosted_extractors.CustomMapping(expression: 'str'): Bases: CogniteResource

class cognite.client.data_classes.hosted_extractors.Destination( external_id: str, created_time: int, last_updated_time: int, session_id: int | None = None, target_data_set_id: int | None = None, )

Bases: _DestinationCore

A hosted extractor writes to a destination.

The destination contains credentials for CDF, and additional information about where the data should land, such as data set ID. Multiple jobs can share a single destination, in which case requests will be combined, reducing the number of requests made to CDF APIs. Metrics are still reported for each individual job.

This is the write/request format of the destination.

Parameters:

external_id (str) – The external ID provided by the client. Must be unique for the resource type.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
session_id (int | None) – ID of the session tied to this destination.
target_data_set_id (int | None) – Data set ID the created items are inserted into, if applicable.

class cognite.client.data_classes.hosted_extractors.DestinationList( resources: Sequence[T_CogniteResource], ): Bases: WriteableCogniteResourceList[DestinationWrite, Destination], ExternalIDTransformerMixin

class cognite.client.data_classes.hosted_extractors.DestinationWrite( external_id: str, credentials: SessionWrite, target_data_set_id: int | None = None, )

Bases: _DestinationCore

A hosted extractor writes to a destination.

The destination contains credentials for CDF, and additional information about where the data should land, such as data set ID. Multiple jobs can share a single destination, in which case requests will be combined, reducing the number of requests made to CDF APIs. Metrics are still reported for each individual job.

This is the write/request format of the destination.

Parameters:

external_id (str) – The external ID provided by the client. Must be unique for the resource type.
credentials (SessionWrite) – Credentials for authenticating towards CDF using a CDF session.
target_data_set_id (int | None) – Data set ID the created items are inserted into, if applicable.

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.DestinationWriteList( resources: Sequence[T_CogniteResource], ): Bases: CogniteResourceList[DestinationWrite], ExternalIDTransformerMixin

class cognite.client.data_classes.hosted_extractors.EventHubSource( external_id: str, host: str, event_hub_name: str, key_name: str, created_time: int, last_updated_time: int, consumer_group: str | None = None, )

Bases: Source

A hosted extractor source represents an external source system on the internet. The source resource in CDF contains all the information the extractor needs to connect to the external source system.

This is the read/response format of the source resource.

Parameters:

external_id (str) – The external ID provided by the client. Must be unique for the resource type.
host (str) – URL of the event hub consumer endpoint.
event_hub_name (str) – Name of the event hub
key_name (str) – The name of the Event Hub key to use.
created_time (int) – No description.
last_updated_time (int) – No description.
consumer_group (str | None) – The event hub consumer group to use. Microsoft recommends having a distinct consumer group for each application consuming data from event hub. If left out, this uses the default consumer group.

class cognite.client.data_classes.hosted_extractors.EventHubSourceUpdate(external_id: str): Bases: SourceUpdate

class cognite.client.data_classes.hosted_extractors.EventHubSourceWrite( external_id: str, host: str, event_hub_name: str, key_name: str, key_value: str, consumer_group: str | None = None, )

Bases: SourceWrite

A hosted extractor source represents an external source system on the internet. The source resource in CDF contains all the information the extractor needs to connect to the external source system.

This is the write/request format of the source resource.

Parameters:

external_id (str) – The external ID provided by the client. Must be unique for the resource type.
host (str) – URL of the event hub consumer endpoint.
event_hub_name (str) – Name of the event hub
key_name (str) – The name of the Event Hub key to use.
key_value (str) – Value of the Event Hub key to use for authentication.
consumer_group (str | None) – The event hub consumer group to use. Microsoft recommends having a distinct consumer group for each application consuming data from event hub. If left out, this uses the default consumer group.

class cognite.client.data_classes.hosted_extractors.HeaderValueLoad(key: 'str', value: 'str'): Bases: IncrementalLoad

class cognite.client.data_classes.hosted_extractors.IncrementalLoad

Bases: CogniteResource, ABC

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.InputMapping

Bases: CogniteResource, ABC

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.JSONInput: Bases: InputMapping

class cognite.client.data_classes.hosted_extractors.Job( external_id: str, destination_id: str, source_id: str, format: JobFormat, target_status: Literal['running', 'paused'], status: Literal['startup_error', 'paused', 'shutting_down', 'connected', 'running', 'waiting', 'connection_error', 'cdf_write_error', 'transform_error'], created_time: int, last_updated_time: int, config: JobConfig | None = None, )

Bases: _JobCore

A hosted extractor job represents the running extractor.

Jobs produce logs and metrics that give the state of the job.

This is the read/response format of the job.

Parameters:

external_id (str) – The external ID provided by the client. Must be unique for the resource type.
destination_id (str) – ID of the destination this job should write to.
source_id (str) – ID of the source this job should read from.
format (JobFormat) – The format of the messages from the source. This is used to convert messages coming from the source system to a format that can be inserted into CDF.
target_status (TargetStatus) – The target status of a job. Set this to start or stop the job.
status (JobStatus) – Status of this job.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
config (JobConfig | None) – Configuration for the job. This is specific to the source system.

class cognite.client.data_classes.hosted_extractors.JobConfig: Bases: CogniteResource, ABC

class cognite.client.data_classes.hosted_extractors.JobFormat

Bases: CogniteResource, ABC

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.JobList( resources: Sequence[T_CogniteResource], ): Bases: WriteableCogniteResourceList[JobWrite, Job], ExternalIDTransformerMixin

class cognite.client.data_classes.hosted_extractors.JobLogs( job_external_id: str, type: Literal['paused', 'startup_error', 'connection_error', 'connected', 'transform_error', 'cdf_write_error', 'ok'], created_time: int, message: str | None = None, )

Bases: CogniteResource

Logs for a hosted extractor job.

Parameters:

job_external_id (str) – The external ID of the job.
type (Literal['paused', 'startup_error', 'connection_error', 'connected', 'transform_error', 'cdf_write_error', 'ok']) – Type of log entry.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
message (str | None) – Log message. Not all log entries have messages.

Statuses

paused: indicates that the job has been stopped manually.
startup_error: indicates that the job failed to start at all and requires changes to configuration.
connection_error: indicates that the job lost connection to the source system.
connected: indicates that the job has connected to the source but did not yet receive any data,
transform_error: indicates that the job received data, but it failed to transform.
cdf_write_error: indicates that ingesting the data to CDF failed.
ok: means that data was successfully ingested to CDF.

class cognite.client.data_classes.hosted_extractors.JobLogsList( resources: Sequence[T_CogniteResource], ): Bases: CogniteResourceList[JobLogs]

class cognite.client.data_classes.hosted_extractors.JobMetrics( job_external_id: str, timestamp: int, source_messages: int, cdf_input_values: int, cdf_requests: int, transform_failures: int, cdf_write_failures: int, cdf_skipped_values: int, cdf_failed_values: int, cdf_uploaded_values: int, )

Bases: CogniteResource

Metrics for a hosted extractor job.

Parameters:

job_external_id (str) – External ID of the job this metrics batch belongs to.
timestamp (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Metrics are from the UTC hour this timestamp is ingest. For example, if this timestamp is at 01:43:15, the metrics batch contains metrics from 01:00:00 to 01:43:15.
source_messages (int) – Number of messages received from the source system.
cdf_input_values (int) – Destination resources successfully transformed and passed to CDF.
cdf_requests (int) – Requests made to CDF containing data produced by this job.
transform_failures (int) – Source messages that failed to transform.
cdf_write_failures (int) – Times the destination received data from transformations, but failed to produce a valid request to CDF.
cdf_skipped_values (int) – Values the destination received from the source, then decided to skip due to data type mismatch, invalid content, or other.
cdf_failed_values (int) – Values the destination was unable to upload to CDF.
cdf_uploaded_values (int) – Values the destination successfully uploaded to CDF.

class cognite.client.data_classes.hosted_extractors.JobMetricsList( resources: Sequence[T_CogniteResource], ): Bases: CogniteResourceList[JobMetrics]

class cognite.client.data_classes.hosted_extractors.JobWrite( external_id: str, destination_id: str, source_id: str, format: JobFormat, config: JobConfig | None = None, )

Bases: _JobCore

A hosted extractor job represents the running extractor.

Jobs produce logs and metrics that give the state of the job.

This is the write/request format of the job.

Parameters:

external_id (str) – The external ID provided by the client. Must be unique for the resource type.
destination_id (str) – ID of the destination this job should write to.
source_id (str) – ID of the source this job should read from.
format – The format of the messages from the source. This is used to convert messages coming from the source system to a format that can be inserted into CDF.
config – Configuration for the job. This must match the source. For example, if the source is MQTT, this must be an MQTT configuration.

class cognite.client.data_classes.hosted_extractors.JobWriteList( resources: Sequence[T_CogniteResource], ): Bases: CogniteResourceList[JobWrite], ExternalIDTransformerMixin

class cognite.client.data_classes.hosted_extractors.KafkaConfig(topic: 'str', partitions: 'int' = 1): Bases: JobConfig

class cognite.client.data_classes.hosted_extractors.KafkaSource( external_id: str, bootstrap_brokers: Sequence[KafkaBroker], created_time: int, last_updated_time: int, authentication: Authentication | None = None, use_tls: bool = False, ca_certificate: CACertificate | None = None, auth_certificate: AuthCertificate | None = None, )

Bases: Source

A hosted extractor source represents an external source system on the internet. The source resource in CDF contains all the information the extractor needs to connect to the external source system.

This is the read/response format of the kafka resource.

Parameters:

external_id (str) – The external ID provided by the client. Must be unique for the resource type.
bootstrap_brokers (Sequence[KafkaBroker]) – List of redundant kafka brokers to connect to.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
authentication (Authentication | None) – Authentication information for the kafka source.
use_tls (bool) – If true, use TLS when connecting to the broker.
ca_certificate (CACertificate | None) – Custom certificate authority certificate to let the source use a self signed certificate.
auth_certificate (AuthCertificate | None) – Authentication certificate (if configured) used to authenticate to source.

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.KafkaSourceUpdate(external_id: str): Bases: SourceUpdate

class cognite.client.data_classes.hosted_extractors.KafkaSourceWrite( external_id: str, bootstrap_brokers: Sequence[KafkaBroker], authentication: AuthenticationWrite | None = None, use_tls: bool = False, ca_certificate: CACertificateWrite | None = None, auth_certificate: AuthCertificateWrite | None = None, )

Bases: SourceWrite

A hosted extractor source represents an external source system on the internet. The source resource in CDF contains all the information the extractor needs to connect to the external source system.

This is the write/request format of the kafka resource.

Parameters:

external_id (str) – The external ID provided by the client. Must be unique for the resource type.
bootstrap_brokers (Sequence[KafkaBroker]) – List of redundant kafka brokers to connect to.
authentication (AuthenticationWrite | None) – Authentication information for the kafka source.
use_tls (bool) – If true, use TLS when connecting to the broker.
ca_certificate (CACertificateWrite | None) – Custom certificate authority certificate to let the source use a self signed certificate.
auth_certificate (AuthCertificateWrite | None) – Authentication certificate (if configured) used to authenticate to source.

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.MQTT3Source( external_id: str, host: str, created_time: int, last_updated_time: int, port: int | None = None, authentication: Authentication | None = None, use_tls: bool = False, ca_certificate: CACertificate | None = None, auth_certificate: AuthCertificate | None = None, ): Bases: _MQTTSource

class cognite.client.data_classes.hosted_extractors.MQTT3SourceUpdate(external_id: str): Bases: _MQTTUpdate

class cognite.client.data_classes.hosted_extractors.MQTT3SourceWrite( external_id: str, host: str, port: int | None = None, authentication: AuthenticationWrite | None = None, use_tls: bool = False, ca_certificate: CACertificateWrite | None = None, auth_certificate: AuthCertificateWrite | None = None, ): Bases: _MQTTSourceWrite

class cognite.client.data_classes.hosted_extractors.MQTT5Source( external_id: str, host: str, created_time: int, last_updated_time: int, port: int | None = None, authentication: Authentication | None = None, use_tls: bool = False, ca_certificate: CACertificate | None = None, auth_certificate: AuthCertificate | None = None, ): Bases: _MQTTSource

class cognite.client.data_classes.hosted_extractors.MQTT5SourceUpdate(external_id: str): Bases: _MQTTUpdate

class cognite.client.data_classes.hosted_extractors.MQTT5SourceWrite( external_id: str, host: str, port: int | None = None, authentication: AuthenticationWrite | None = None, use_tls: bool = False, ca_certificate: CACertificateWrite | None = None, auth_certificate: AuthCertificateWrite | None = None, ): Bases: _MQTTSourceWrite

class cognite.client.data_classes.hosted_extractors.MQTTConfig(topic_filter: 'str'): Bases: JobConfig

class cognite.client.data_classes.hosted_extractors.Mapping( external_id: str, mapping: CustomMapping, published: bool, input: InputMapping, created_time: int, last_updated_time: int, )

Bases: _MappingCore

A mapping is a custom transformation, translating the source format to a format that can be ingested into CDF. Mappings are written in the Cognite transformation language.

This is the read/response format of a mapping.

Parameters:

external_id (str) – The external ID provided by the client. Must be unique for the resource type.
mapping (CustomMapping) – The custom mapping.
published (bool) – Whether this mapping is published and should be available to be used in jobs.
input (InputMapping) – The input mapping.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.MappingList( resources: Sequence[T_CogniteResource], ): Bases: WriteableCogniteResourceList[MappingWrite, Mapping], ExternalIDTransformerMixin

class cognite.client.data_classes.hosted_extractors.MappingWrite( external_id: str, mapping: CustomMapping, published: bool, input: InputMapping | Literal['csv', 'json', 'xml'] = 'json', )

Bases: _MappingCore

A mapping is a custom transformation, translating the source format to a format that can be ingested into CDF. Mappings are written in the Cognite transformation language.

This is the write/request format of a mapping.

Parameters:

external_id (str) – The external ID provided by the client. Must be unique for the resource type.
mapping (CustomMapping) – The custom mapping.
published (bool) – Whether this mapping is published and should be available to be used in jobs.
input (InputMapping | Literal['csv', 'json', 'xml']) – The input mapping. Defaults to ‘json’

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.MappingWriteList( resources: Sequence[T_CogniteResource], ): Bases: CogniteResourceList[MappingWrite], ExternalIDTransformerMixin

class cognite.client.data_classes.hosted_extractors.NextUrlLoad(value: 'str'): Bases: IncrementalLoad

class cognite.client.data_classes.hosted_extractors.Prefix(from_topic: 'bool | None' = None, prefix: 'str | None' = None): Bases: CogniteResource

class cognite.client.data_classes.hosted_extractors.ProtoBufInput(message_name: 'str', files: 'list[ProtoBufFile]')

Bases: InputMapping

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.QueryParamLoad(key: 'str', value: 'str'): Bases: IncrementalLoad

class cognite.client.data_classes.hosted_extractors.RestConfig( interval: "Literal['5m', '15m', '1h', '6h', '12h', '1d']", path: 'str', method: "Literal['get', 'post']" = 'get', body: 'str | None' = None, query: 'dict[str, str] | None' = None, headers: 'dict[str, str] | None' = None, incremental_load: 'IncrementalLoad | None' = None, pagination: 'IncrementalLoad | None' = None, )

Bases: JobConfig

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.RestSource( external_id: str, host: str, scheme: Literal['http', 'https'], created_time: int, last_updated_time: int, port: int | None = None, ca_certificate: CACertificate | None = None, authentication: Authentication | None = None, )

Bases: Source

A hosted extractor source represents an external source system on the internet. The source resource in CDF contains all the information the extractor needs to connect to the external source system.

This is the read/response format of the rest resource.

Parameters:

external_id (str) – The external ID provided by the client. Must be unique for the resource type.
host (str) – Host or IP address to connect to.
scheme (Literal['http', 'https']) – Type of connection to establish.
created_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
last_updated_time (int) – The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
port (int | None) – Port on server to connect to. Uses default ports based on the scheme if omitted.
ca_certificate (CACertificate | None) – Custom certificate authority certificate to let the source use a self signed certificate.
authentication (Authentication | None) – Authentication details for source.

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.RestSourceUpdate(external_id: str): Bases: SourceUpdate

class cognite.client.data_classes.hosted_extractors.RestSourceWrite( external_id: str, host: str, scheme: Literal['http', 'https'] = 'https', port: int | None = None, ca_certificate: CACertificateWrite | None = None, authentication: AuthenticationWrite | None = None, )

Bases: SourceWrite

A hosted extractor source represents an external source system on the internet. The source resource in CDF contains all the information the extractor needs to connect to the external source system.

This is the write/request format of the rest resource.

Parameters:

external_id (str) – The external ID provided by the client. Must be unique for the resource type.
host (str) – Host or IP address to connect to.
scheme (Literal['http', 'https']) – Type of connection to establish.
port (int | None) – Port on server to connect to. Uses default ports based on the scheme if omitted.
ca_certificate (CACertificateWrite | None) – Custom certificate authority certificate to let the source use a self signed certificate.
authentication (AuthenticationWrite | None) – Authentication details for source.

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.RockwellFormat( encoding: "Literal['utf16', 'utf16le'] | None" = None, compression: 'str | None' = None, prefix: 'Prefix | None' = None, )

Bases: JobFormat

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.SessionWrite(nonce: 'str'): Bases: CogniteResource

class cognite.client.data_classes.hosted_extractors.Source(external_id: str)

Bases: WriteableCogniteResource[T_WriteClass], ABC

A hosted extractor source represents an external source system on the internet. The source resource in CDF contains all the information the extractor needs to connect to the external source system.

This is the read/response format of the source resource.

Parameters:: external_id (str) – The external ID provided by the client. Must be unique for the resource type.

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.SourceList( resources: Sequence[T_CogniteResource], ): Bases: WriteableCogniteResourceList[SourceWrite, Source], ExternalIDTransformerMixin

class cognite.client.data_classes.hosted_extractors.SourceUpdate(external_id: str)

Bases: CogniteUpdate, ABC

dump( camel_case: Literal[True] = True, ) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (Literal[True]) – No description.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.SourceWrite(external_id: str)

Bases: CogniteResource, ABC

A hosted extractor source represents an external source system on the internet. The source resource in CDF contains all the information the extractor needs to connect to the external source system.

This is the write/request format of the source resource.

Parameters:: external_id (str) – The external ID provided by the client. Must be unique for the resource type.

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.SourceWriteList( resources: Sequence[T_CogniteResource], ): Bases: CogniteResourceList[SourceWrite], ExternalIDTransformerMixin

class cognite.client.data_classes.hosted_extractors.ValueFormat( encoding: "Literal['utf16', 'utf16le'] | None" = None, compression: 'str | None' = None, prefix: 'Prefix | None' = None, )

Bases: JobFormat

dump(camel_case: bool = True) → dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:: camel_case (bool) – Use camelCase for attribute names. Defaults to True.
Returns:: A dictionary representation of the instance.
Return type:: dict[str, Any]

class cognite.client.data_classes.hosted_extractors.XMLInput: Bases: InputMapping