GenerateEnrichmentJobDetails

class oci.generative_ai_data.models.GenerateEnrichmentJobDetails(**kwargs)

Bases: object

The details required to create an EnrichmentJob.

Attributes:

ENRICHMENT_JOB_TYPE_DELTA_REFRESH

A constant which can be used with the enrichment_job_type property of a GenerateEnrichmentJobDetails.

ENRICHMENT_JOB_TYPE_FULL_BUILD

A constant which can be used with the enrichment_job_type property of a GenerateEnrichmentJobDetails.

ENRICHMENT_JOB_TYPE_PARTIAL_BUILD

A constant which can be used with the enrichment_job_type property of a GenerateEnrichmentJobDetails.

defined_tags

Gets the defined_tags of this GenerateEnrichmentJobDetails.

description

Gets the description of this GenerateEnrichmentJobDetails.

display_name

Gets the display_name of this GenerateEnrichmentJobDetails.

enrichment_job_configuration

[Required] Gets the enrichment_job_configuration of this GenerateEnrichmentJobDetails.

enrichment_job_type

Gets the enrichment_job_type of this GenerateEnrichmentJobDetails.

freeform_tags

Gets the freeform_tags of this GenerateEnrichmentJobDetails.

Methods:

__init__(**kwargs)

Initializes a new GenerateEnrichmentJobDetails object with values from keyword arguments.

ENRICHMENT_JOB_TYPE_DELTA_REFRESH = 'DELTA_REFRESH'

A constant which can be used with the enrichment_job_type property of a GenerateEnrichmentJobDetails. This constant has a value of “DELTA_REFRESH”

ENRICHMENT_JOB_TYPE_FULL_BUILD = 'FULL_BUILD'

A constant which can be used with the enrichment_job_type property of a GenerateEnrichmentJobDetails. This constant has a value of “FULL_BUILD”

ENRICHMENT_JOB_TYPE_PARTIAL_BUILD = 'PARTIAL_BUILD'

A constant which can be used with the enrichment_job_type property of a GenerateEnrichmentJobDetails. This constant has a value of “PARTIAL_BUILD”

__init__(**kwargs)

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

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

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

  • enrichment_job_type (str) – The value to assign to the enrichment_job_type property of this GenerateEnrichmentJobDetails. Allowed values for this property are: “FULL_BUILD”, “PARTIAL_BUILD”, “DELTA_REFRESH”

  • enrichment_job_configuration (oci.generative_ai_data.models.EnrichmentJobConfiguration) – The value to assign to the enrichment_job_configuration property of this GenerateEnrichmentJobDetails.

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

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

property defined_tags

Gets the defined_tags of this GenerateEnrichmentJobDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this GenerateEnrichmentJobDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this GenerateEnrichmentJobDetails. An optional description of the EnrichmentJob.

Returns

The description of this GenerateEnrichmentJobDetails.

Return type

str

property display_name

Gets the display_name of this GenerateEnrichmentJobDetails. A user-friendly display name. It does not have to be unique and can be modified. Avoid entering confidential information.

Returns

The display_name of this GenerateEnrichmentJobDetails.

Return type

str

property enrichment_job_configuration

[Required] Gets the enrichment_job_configuration of this GenerateEnrichmentJobDetails.

Returns

The enrichment_job_configuration of this GenerateEnrichmentJobDetails.

Return type

oci.generative_ai_data.models.EnrichmentJobConfiguration

property enrichment_job_type

Gets the enrichment_job_type of this GenerateEnrichmentJobDetails. Deprecated. Use EnrichmentJobConfiguration.enrichmentJobType instead.

Allowed values for this property are: “FULL_BUILD”, “PARTIAL_BUILD”, “DELTA_REFRESH”

Returns

The enrichment_job_type of this GenerateEnrichmentJobDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this GenerateEnrichmentJobDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns

The freeform_tags of this GenerateEnrichmentJobDetails.

Return type

dict(str, str)