GdpPipelineSummary¶

class oci.gdp.models.GdpPipelineSummary(**kwargs)¶

Bases: object

Retrieves summary pipeline configuration information by identifier.

Methods

__init__(**kwargs) Initializes a new GdpPipelineSummary object with values from keyword arguments.

Attributes

`authorization_details`	Gets the authorization_details of this GdpPipelineSummary.
`compartment_id`	[Required] Gets the compartment_id of this GdpPipelineSummary.
`defined_tags`	[Required] Gets the defined_tags of this GdpPipelineSummary.
`description`	Gets the description of this GdpPipelineSummary.
`display_name`	[Required] Gets the display_name of this GdpPipelineSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this GdpPipelineSummary.
`id`	[Required] Gets the id of this GdpPipelineSummary.
`is_approval_needed`	Gets the is_approval_needed of this GdpPipelineSummary.
`is_chunking_enabled`	Gets the is_chunking_enabled of this GdpPipelineSummary.
`is_file_override_in_destination_enabled`	Gets the is_file_override_in_destination_enabled of this GdpPipelineSummary.
`is_scanning_enabled`	Gets the is_scanning_enabled of this GdpPipelineSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this GdpPipelineSummary.
`peering_region`	[Required] Gets the peering_region of this GdpPipelineSummary.
`pipeline_type`	[Required] Gets the pipeline_type of this GdpPipelineSummary.
`service_log_group_id`	Gets the service_log_group_id of this GdpPipelineSummary.
`system_tags`	Gets the system_tags of this GdpPipelineSummary.
`time_created`	[Required] Gets the time_created of this GdpPipelineSummary.
`time_updated`	[Required] Gets the time_updated of this GdpPipelineSummary.

__init__(**kwargs)¶

Initializes a new GdpPipelineSummary 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 GdpPipelineSummary.
compartment_id (str) – The value to assign to the compartment_id property of this GdpPipelineSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this GdpPipelineSummary.
display_name (str) – The value to assign to the display_name property of this GdpPipelineSummary.
description (str) – The value to assign to the description property of this GdpPipelineSummary.
service_log_group_id (str) – The value to assign to the service_log_group_id property of this GdpPipelineSummary.
pipeline_type (str) – The value to assign to the pipeline_type property of this GdpPipelineSummary.
peering_region (str) – The value to assign to the peering_region property of this GdpPipelineSummary.
authorization_details (str) – The value to assign to the authorization_details property of this GdpPipelineSummary.
time_created (datetime) – The value to assign to the time_created property of this GdpPipelineSummary.
time_updated (datetime) – The value to assign to the time_updated property of this GdpPipelineSummary.
is_file_override_in_destination_enabled (bool) – The value to assign to the is_file_override_in_destination_enabled property of this GdpPipelineSummary.
is_scanning_enabled (bool) – The value to assign to the is_scanning_enabled property of this GdpPipelineSummary.
is_chunking_enabled (bool) – The value to assign to the is_chunking_enabled property of this GdpPipelineSummary.
is_approval_needed (bool) – The value to assign to the is_approval_needed property of this GdpPipelineSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this GdpPipelineSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this GdpPipelineSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this GdpPipelineSummary.

authorization_details¶

Gets the authorization_details of this GdpPipelineSummary. Free-text field containing tracking information for approval tracking.

Returns:	The authorization_details of this GdpPipelineSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this GdpPipelineSummary. The OCID of the compartment.

Returns:	The compartment_id of this GdpPipelineSummary.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this GdpPipelineSummary. 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 GdpPipelineSummary.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this GdpPipelineSummary. Short field input by customer for a description of the data pipeline use-case.

Returns:	The description of this GdpPipelineSummary.
Return type:	str

display_name¶

[Required] Gets the display_name of this GdpPipelineSummary. Pipeline short name.

Returns:	The display_name of this GdpPipelineSummary.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this GdpPipelineSummary. 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 GdpPipelineSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this GdpPipelineSummary. The OCID of the pipeline.

Returns:	The id of this GdpPipelineSummary.
Return type:	str

is_approval_needed¶

Gets the is_approval_needed of this GdpPipelineSummary. Determines whether file transfers need to go through an approval workflow.

Returns:	The is_approval_needed of this GdpPipelineSummary.
Return type:	bool

is_chunking_enabled¶

Gets the is_chunking_enabled of this GdpPipelineSummary. Determines whether file must be chunked during the transfer. This is only a property of SENDER pipelines.

Returns:	The is_chunking_enabled of this GdpPipelineSummary.
Return type:	bool

is_file_override_in_destination_enabled¶

Gets the is_file_override_in_destination_enabled of this GdpPipelineSummary. Enable file override feature in destination bucket

Returns:	The is_file_override_in_destination_enabled of this GdpPipelineSummary.
Return type:	bool

is_scanning_enabled¶

Gets the is_scanning_enabled of this GdpPipelineSummary. Determines whether GDP Scanning should be enabled for the pipeline.

Returns:	The is_scanning_enabled of this GdpPipelineSummary.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this GdpPipelineSummary. The current state of the pipeline.

Returns:	The lifecycle_state of this GdpPipelineSummary.
Return type:	str

peering_region¶

[Required] Gets the peering_region of this GdpPipelineSummary. Public region name where the peered pipeline exists.

Returns:	The peering_region of this GdpPipelineSummary.
Return type:	str

pipeline_type¶

[Required] Gets the pipeline_type of this GdpPipelineSummary. Type of pipeline. Can be SENDER or RECEIVER.

Returns:	The pipeline_type of this GdpPipelineSummary.
Return type:	str

service_log_group_id¶

Gets the service_log_group_id of this GdpPipelineSummary. the OCID of the service log group.

Returns:	The service_log_group_id of this GdpPipelineSummary.
Return type:	str

system_tags¶

Gets the system_tags of this GdpPipelineSummary. 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 GdpPipelineSummary.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this GdpPipelineSummary. The time the pipeline was created. An RFC3339 formatted datetime string.

Returns:	The time_created of this GdpPipelineSummary.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this GdpPipelineSummary. The time the pipeline was updated. An RFC3339 formatted datetime string.

Returns:	The time_updated of this GdpPipelineSummary.
Return type:	datetime