ExternalPublication

class oci.data_integration.models.ExternalPublication(**kwargs)

Bases: object

The external published object contains the audit summary information and the definition of the task.

Attributes:

STATUS_FAILED

A constant which can be used with the status property of a ExternalPublication.

STATUS_PUBLISHING

A constant which can be used with the status property of a ExternalPublication.

STATUS_SUCCESSFUL

A constant which can be used with the status property of a ExternalPublication.

application_compartment_id

Gets the application_compartment_id of this ExternalPublication.

application_id

Gets the application_id of this ExternalPublication.

configuration_details

Gets the configuration_details of this ExternalPublication.

description

Gets the description of this ExternalPublication.

display_name

Gets the display_name of this ExternalPublication.

error_message

Gets the error_message of this ExternalPublication.

identifier

Gets the identifier of this ExternalPublication.

key

Gets the key of this ExternalPublication.

key_map

Gets the key_map of this ExternalPublication.

metadata

Gets the metadata of this ExternalPublication.

model_type

Gets the model_type of this ExternalPublication.

model_version

Gets the model_version of this ExternalPublication.

name

Gets the name of this ExternalPublication.

object_status

Gets the object_status of this ExternalPublication.

object_version

Gets the object_version of this ExternalPublication.

parent_ref

Gets the parent_ref of this ExternalPublication.

resource_configuration

Gets the resource_configuration of this ExternalPublication.

status

Gets the status of this ExternalPublication.

Methods:

__init__(**kwargs)

Initializes a new ExternalPublication object with values from keyword arguments.

STATUS_FAILED = 'FAILED'

A constant which can be used with the status property of a ExternalPublication. This constant has a value of “FAILED”

STATUS_PUBLISHING = 'PUBLISHING'

A constant which can be used with the status property of a ExternalPublication. This constant has a value of “PUBLISHING”

STATUS_SUCCESSFUL = 'SUCCESSFUL'

A constant which can be used with the status property of a ExternalPublication. This constant has a value of “SUCCESSFUL”

__init__(**kwargs)

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

Parameters
  • application_id (str) – The value to assign to the application_id property of this ExternalPublication.

  • application_compartment_id (str) – The value to assign to the application_compartment_id property of this ExternalPublication.

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

  • resource_configuration (oci.data_integration.models.ResourceConfiguration) – The value to assign to the resource_configuration property of this ExternalPublication.

  • configuration_details (oci.data_integration.models.ConfigurationDetails) – The value to assign to the configuration_details property of this ExternalPublication.

  • status (str) – The value to assign to the status property of this ExternalPublication. Allowed values for this property are: “SUCCESSFUL”, “FAILED”, “PUBLISHING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • error_message (str) – The value to assign to the error_message property of this ExternalPublication.

  • key (str) – The value to assign to the key property of this ExternalPublication.

  • model_type (str) – The value to assign to the model_type property of this ExternalPublication.

  • model_version (str) – The value to assign to the model_version property of this ExternalPublication.

  • name (str) – The value to assign to the name property of this ExternalPublication.

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

  • object_version (int) – The value to assign to the object_version property of this ExternalPublication.

  • object_status (int) – The value to assign to the object_status property of this ExternalPublication.

  • identifier (str) – The value to assign to the identifier property of this ExternalPublication.

  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this ExternalPublication.

  • metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this ExternalPublication.

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

property application_compartment_id

Gets the application_compartment_id of this ExternalPublication. The OCID of the compartment where the application is created in the Oracle Cloud Infrastructure Data Flow Service.

Returns

The application_compartment_id of this ExternalPublication.

Return type

str

property application_id

Gets the application_id of this ExternalPublication. The unique OCID of the identifier that is returned after creating the Oracle Cloud Infrastructure Data Flow application.

Returns

The application_id of this ExternalPublication.

Return type

str

property configuration_details

Gets the configuration_details of this ExternalPublication.

Returns

The configuration_details of this ExternalPublication.

Return type

oci.data_integration.models.ConfigurationDetails

property description

Gets the description of this ExternalPublication. Detailed description for the object.

Returns

The description of this ExternalPublication.

Return type

str

property display_name

Gets the display_name of this ExternalPublication. The name of the application.

Returns

The display_name of this ExternalPublication.

Return type

str

property error_message

Gets the error_message of this ExternalPublication. The error of the published object in the application.

Returns

The error_message of this ExternalPublication.

Return type

str

property identifier

Gets the identifier of this ExternalPublication. Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns

The identifier of this ExternalPublication.

Return type

str

property key

Gets the key of this ExternalPublication. The object key.

Returns

The key of this ExternalPublication.

Return type

str

property key_map

Gets the key_map of this ExternalPublication. A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key.

Returns

The key_map of this ExternalPublication.

Return type

dict(str, str)

property metadata

Gets the metadata of this ExternalPublication.

Returns

The metadata of this ExternalPublication.

Return type

oci.data_integration.models.ObjectMetadata

property model_type

Gets the model_type of this ExternalPublication. The object type.

Returns

The model_type of this ExternalPublication.

Return type

str

property model_version

Gets the model_version of this ExternalPublication. This is a version number that is used by the service to upgrade objects if needed through releases of the service.

Returns

The model_version of this ExternalPublication.

Return type

str

property name

Gets the name of this ExternalPublication. Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns

The name of this ExternalPublication.

Return type

str

property object_status

Gets the object_status of this ExternalPublication. The status of an object that can be set to value 1 for shallow references across objects. Other values are reserved.

Returns

The object_status of this ExternalPublication.

Return type

int

property object_version

Gets the object_version of this ExternalPublication. The version of the object that is used to track changes in the object instance.

Returns

The object_version of this ExternalPublication.

Return type

int

property parent_ref

Gets the parent_ref of this ExternalPublication.

Returns

The parent_ref of this ExternalPublication.

Return type

oci.data_integration.models.ParentReference

property resource_configuration

Gets the resource_configuration of this ExternalPublication.

Returns

The resource_configuration of this ExternalPublication.

Return type

oci.data_integration.models.ResourceConfiguration

property status

Gets the status of this ExternalPublication. The status of the publishing action to Oracle Cloud Infrastructure Data Flow.

Allowed values for this property are: “SUCCESSFUL”, “FAILED”, “PUBLISHING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The status of this ExternalPublication.

Return type

str