CreateDataIngestionJobDetails

class oci.generative_ai_agent.models.CreateDataIngestionJobDetails(**kwargs)

Bases: object

The data to create a data ingestion job.

Methods:

__init__(**kwargs)

Initializes a new CreateDataIngestionJobDetails object with values from keyword arguments.

Attributes:

compartment_id

[Required] Gets the compartment_id of this CreateDataIngestionJobDetails.

data_source_id

[Required] Gets the data_source_id of this CreateDataIngestionJobDetails.

defined_tags

Gets the defined_tags of this CreateDataIngestionJobDetails.

description

Gets the description of this CreateDataIngestionJobDetails.

display_name

Gets the display_name of this CreateDataIngestionJobDetails.

freeform_tags

Gets the freeform_tags of this CreateDataIngestionJobDetails.

__init__(**kwargs)

Initializes a new CreateDataIngestionJobDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • display_name (str) – The value to assign to the display_name property of this CreateDataIngestionJobDetails.

  • description (str) – The value to assign to the description property of this CreateDataIngestionJobDetails.

  • data_source_id (str) – The value to assign to the data_source_id property of this CreateDataIngestionJobDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this CreateDataIngestionJobDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDataIngestionJobDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDataIngestionJobDetails.

property compartment_id

[Required] Gets the compartment_id of this CreateDataIngestionJobDetails. The OCID of the compartment to create the data ingestion job in.

Returns

The compartment_id of this CreateDataIngestionJobDetails.

Return type

str

property data_source_id

[Required] Gets the data_source_id of this CreateDataIngestionJobDetails. The OCID of the parent DataSource.

Returns

The data_source_id of this CreateDataIngestionJobDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateDataIngestionJobDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this CreateDataIngestionJobDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this CreateDataIngestionJobDetails. A user-friendly description of the data ingestion job.

Returns

The description of this CreateDataIngestionJobDetails.

Return type

str

property display_name

Gets the display_name of this CreateDataIngestionJobDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns

The display_name of this CreateDataIngestionJobDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateDataIngestionJobDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns

The freeform_tags of this CreateDataIngestionJobDetails.

Return type

dict(str, str)