GdpPipeline¶
- class oci.gdp.models.GdpPipeline(**kwargs)¶
Bases:
objectRetrieves pipeline configuration information by identifier.
Attributes:
A constant which can be used with the lifecycle_state property of a GdpPipeline.
A constant which can be used with the lifecycle_state property of a GdpPipeline.
A constant which can be used with the lifecycle_state property of a GdpPipeline.
A constant which can be used with the lifecycle_state property of a GdpPipeline.
A constant which can be used with the lifecycle_state property of a GdpPipeline.
A constant which can be used with the lifecycle_state property of a GdpPipeline.
A constant which can be used with the lifecycle_state property of a GdpPipeline.
A constant which can be used with the lifecycle_state property of a GdpPipeline.
A constant which can be used with the pipeline_type property of a GdpPipeline.
A constant which can be used with the pipeline_type property of a GdpPipeline.
Gets the approval_key_vault_id of this GdpPipeline.
Gets the authorization_details of this GdpPipeline.
Gets the bucket_details of this GdpPipeline.
[Required] Gets the compartment_id of this GdpPipeline.
[Required] Gets the defined_tags of this GdpPipeline.
Gets the description of this GdpPipeline.
[Required] Gets the display_name of this GdpPipeline.
Gets the file_types of this GdpPipeline.
[Required] Gets the freeform_tags of this GdpPipeline.
[Required] Gets the id of this GdpPipeline.
Gets the is_approval_needed of this GdpPipeline.
Gets the is_chunking_enabled of this GdpPipeline.
Gets the is_file_override_in_destination_enabled of this GdpPipeline.
Gets the is_scanning_enabled of this GdpPipeline.
Gets the lifecycle_details of this GdpPipeline.
[Required] Gets the lifecycle_state of this GdpPipeline.
Gets the peered_gdp_pipeline_id of this GdpPipeline.
[Required] Gets the peering_region of this GdpPipeline.
[Required] Gets the pipeline_type of this GdpPipeline.
Gets the service_log_group_id of this GdpPipeline.
Gets the system_tags of this GdpPipeline.
[Required] Gets the time_created of this GdpPipeline.
[Required] Gets the time_updated of this GdpPipeline.
Methods:
__init__(**kwargs)Initializes a new GdpPipeline object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a GdpPipeline. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a GdpPipeline. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a GdpPipeline. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a GdpPipeline. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a GdpPipeline. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a GdpPipeline. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶
A constant which can be used with the lifecycle_state property of a GdpPipeline. This constant has a value of “NEEDS_ATTENTION”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a GdpPipeline. This constant has a value of “UPDATING”
- PIPELINE_TYPE_RECEIVER = 'RECEIVER'¶
A constant which can be used with the pipeline_type property of a GdpPipeline. This constant has a value of “RECEIVER”
- PIPELINE_TYPE_SENDER = 'SENDER'¶
A constant which can be used with the pipeline_type property of a GdpPipeline. This constant has a value of “SENDER”
- __init__(**kwargs)¶
Initializes a new GdpPipeline object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this GdpPipeline.
compartment_id (str) – The value to assign to the compartment_id property of this GdpPipeline.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this GdpPipeline. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this GdpPipeline.
display_name (str) – The value to assign to the display_name property of this GdpPipeline.
description (str) – The value to assign to the description property of this GdpPipeline.
service_log_group_id (str) – The value to assign to the service_log_group_id property of this GdpPipeline.
pipeline_type (str) – The value to assign to the pipeline_type property of this GdpPipeline. Allowed values for this property are: “SENDER”, “RECEIVER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
file_types (list[str]) – The value to assign to the file_types property of this GdpPipeline.
authorization_details (str) – The value to assign to the authorization_details property of this GdpPipeline.
bucket_details (list[oci.gdp.models.BucketDetailsDefinition]) – The value to assign to the bucket_details property of this GdpPipeline.
peering_region (str) – The value to assign to the peering_region property of this GdpPipeline.
peered_gdp_pipeline_id (str) – The value to assign to the peered_gdp_pipeline_id property of this GdpPipeline.
time_created (datetime) – The value to assign to the time_created property of this GdpPipeline.
time_updated (datetime) – The value to assign to the time_updated property of this GdpPipeline.
is_file_override_in_destination_enabled (bool) – The value to assign to the is_file_override_in_destination_enabled property of this GdpPipeline.
is_scanning_enabled (bool) – The value to assign to the is_scanning_enabled property of this GdpPipeline.
is_chunking_enabled (bool) – The value to assign to the is_chunking_enabled property of this GdpPipeline.
is_approval_needed (bool) – The value to assign to the is_approval_needed property of this GdpPipeline.
approval_key_vault_id (str) – The value to assign to the approval_key_vault_id property of this GdpPipeline.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this GdpPipeline.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this GdpPipeline.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this GdpPipeline.
- property approval_key_vault_id¶
Gets the approval_key_vault_id of this GdpPipeline. The KMS vault OCID for the key to be used for file transfer approvals.
- Returns
The approval_key_vault_id of this GdpPipeline.
- Return type
str
- property authorization_details¶
Gets the authorization_details of this GdpPipeline. Authorization information about the pipeline being configured.
- Returns
The authorization_details of this GdpPipeline.
- Return type
str
- property bucket_details¶
Gets the bucket_details of this GdpPipeline. Information about the bucket in the pipeline being configured.
- Returns
The bucket_details of this GdpPipeline.
- Return type
- property compartment_id¶
[Required] Gets the compartment_id of this GdpPipeline. The OCID of the compartment.
- Returns
The compartment_id of this GdpPipeline.
- Return type
str
- property defined_tags¶
[Required] Gets the defined_tags of this GdpPipeline. 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 GdpPipeline.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this GdpPipeline. Short field input by customer for a description of the data pipeline use-case.
- Returns
The description of this GdpPipeline.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this GdpPipeline. Pipeline short name.
- Returns
The display_name of this GdpPipeline.
- Return type
str
- property file_types¶
Gets the file_types of this GdpPipeline. List of file types allowed to be transferred in the pipeline according to the authorization details (e.g. .pdf, .xml, .doc).
- Returns
The file_types of this GdpPipeline.
- Return type
list[str]
- property freeform_tags¶
[Required] Gets the freeform_tags of this GdpPipeline. 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 GdpPipeline.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this GdpPipeline. The OCID of the pipeline.
- Returns
The id of this GdpPipeline.
- Return type
str
- property is_approval_needed¶
Gets the is_approval_needed of this GdpPipeline. Determines whether file transfers need to go through an approval workflow.
- Returns
The is_approval_needed of this GdpPipeline.
- Return type
bool
- property is_chunking_enabled¶
Gets the is_chunking_enabled of this GdpPipeline. Determines whether file must be chunked during the transfer. This is only a property of SENDER pipelines.
- Returns
The is_chunking_enabled of this GdpPipeline.
- Return type
bool
- property is_file_override_in_destination_enabled¶
Gets the is_file_override_in_destination_enabled of this GdpPipeline. Enable file override feature in destination bucket
- Returns
The is_file_override_in_destination_enabled of this GdpPipeline.
- Return type
bool
- property is_scanning_enabled¶
Gets the is_scanning_enabled of this GdpPipeline. Determines whether GDP Scanning should be enabled for the pipeline.
- Returns
The is_scanning_enabled of this GdpPipeline.
- Return type
bool
- property lifecycle_details¶
Gets the lifecycle_details of this GdpPipeline. Additional details about the current state of the pipeline.
- Returns
The lifecycle_details of this GdpPipeline.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this GdpPipeline. The current state of the pipeline.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this GdpPipeline.
- Return type
str
- property peered_gdp_pipeline_id¶
Gets the peered_gdp_pipeline_id of this GdpPipeline. OCID of the peered pipeline.
- Returns
The peered_gdp_pipeline_id of this GdpPipeline.
- Return type
str
- property peering_region¶
[Required] Gets the peering_region of this GdpPipeline. Public region name where the peered pipeline exists.
- Returns
The peering_region of this GdpPipeline.
- Return type
str
- property pipeline_type¶
[Required] Gets the pipeline_type of this GdpPipeline. Type of pipeline. Can be SENDER or RECEIVER.
Allowed values for this property are: “SENDER”, “RECEIVER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The pipeline_type of this GdpPipeline.
- Return type
str
- property service_log_group_id¶
Gets the service_log_group_id of this GdpPipeline. the OCID of the service log group.
- Returns
The service_log_group_id of this GdpPipeline.
- Return type
str
- property system_tags¶
Gets the system_tags of this GdpPipeline. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this GdpPipeline.
- Return type
dict(str, dict(str, object))
- property time_created¶
[Required] Gets the time_created of this GdpPipeline. The time the the pipeline was created. An RFC3339 formatted datetime string.
- Returns
The time_created of this GdpPipeline.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this GdpPipeline. The time the pipeline was updated. An RFC3339 formatted datetime string.
- Returns
The time_updated of this GdpPipeline.
- Return type
datetime