CreateGdpPipelineDetails¶
- class oci.gdp.models.CreateGdpPipelineDetails(**kwargs)¶
Bases:
objectThe information about the new pipeline.
Methods:
__init__(**kwargs)Initializes a new CreateGdpPipelineDetails object with values from keyword arguments.
Attributes:
Gets the approval_key_vault_id of this CreateGdpPipelineDetails.
Gets the authorization_details of this CreateGdpPipelineDetails.
[Required] Gets the bucket_details of this CreateGdpPipelineDetails.
[Required] Gets the compartment_id of this CreateGdpPipelineDetails.
Gets the defined_tags of this CreateGdpPipelineDetails.
Gets the description of this CreateGdpPipelineDetails.
[Required] Gets the display_name of this CreateGdpPipelineDetails.
Gets the file_types of this CreateGdpPipelineDetails.
Gets the freeform_tags of this CreateGdpPipelineDetails.
Gets the is_approval_needed of this CreateGdpPipelineDetails.
Gets the is_chunking_enabled of this CreateGdpPipelineDetails.
Gets the is_file_override_in_destination_enabled of this CreateGdpPipelineDetails.
Gets the is_scanning_enabled of this CreateGdpPipelineDetails.
[Required] Gets the peering_region of this CreateGdpPipelineDetails.
[Required] Gets the pipeline_type of this CreateGdpPipelineDetails.
Gets the service_log_group_id of this CreateGdpPipelineDetails.
- __init__(**kwargs)¶
Initializes a new CreateGdpPipelineDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
compartment_id (str) – The value to assign to the compartment_id property of this CreateGdpPipelineDetails.
display_name (str) – The value to assign to the display_name property of this CreateGdpPipelineDetails.
description (str) – The value to assign to the description property of this CreateGdpPipelineDetails.
service_log_group_id (str) – The value to assign to the service_log_group_id property of this CreateGdpPipelineDetails.
pipeline_type (str) – The value to assign to the pipeline_type property of this CreateGdpPipelineDetails.
file_types (list[str]) – The value to assign to the file_types property of this CreateGdpPipelineDetails.
bucket_details (list[oci.gdp.models.BucketDetailsDefinition]) – The value to assign to the bucket_details property of this CreateGdpPipelineDetails.
peering_region (str) – The value to assign to the peering_region property of this CreateGdpPipelineDetails.
authorization_details (str) – The value to assign to the authorization_details property of this CreateGdpPipelineDetails.
is_file_override_in_destination_enabled (bool) – The value to assign to the is_file_override_in_destination_enabled property of this CreateGdpPipelineDetails.
is_scanning_enabled (bool) – The value to assign to the is_scanning_enabled property of this CreateGdpPipelineDetails.
is_chunking_enabled (bool) – The value to assign to the is_chunking_enabled property of this CreateGdpPipelineDetails.
is_approval_needed (bool) – The value to assign to the is_approval_needed property of this CreateGdpPipelineDetails.
approval_key_vault_id (str) – The value to assign to the approval_key_vault_id property of this CreateGdpPipelineDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateGdpPipelineDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateGdpPipelineDetails.
- property approval_key_vault_id¶
Gets the approval_key_vault_id of this CreateGdpPipelineDetails. The KMS vault OCID for the key to be used for file transfer approvals.
- Returns
The approval_key_vault_id of this CreateGdpPipelineDetails.
- Return type
str
- property authorization_details¶
Gets the authorization_details of this CreateGdpPipelineDetails. Authorization information about the pipeline being configured.
- Returns
The authorization_details of this CreateGdpPipelineDetails.
- Return type
str
- property bucket_details¶
[Required] Gets the bucket_details of this CreateGdpPipelineDetails. Information about the bucket in the pipeline being configured.
- Returns
The bucket_details of this CreateGdpPipelineDetails.
- Return type
- property compartment_id¶
[Required] Gets the compartment_id of this CreateGdpPipelineDetails. The OCID of the compartment.
- Returns
The compartment_id of this CreateGdpPipelineDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateGdpPipelineDetails. 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 CreateGdpPipelineDetails.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this CreateGdpPipelineDetails. Short field input by customer for a description of the data pipeline use-case.
- Returns
The description of this CreateGdpPipelineDetails.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this CreateGdpPipelineDetails. Pipeline short name.
- Returns
The display_name of this CreateGdpPipelineDetails.
- Return type
str
- property file_types¶
Gets the file_types of this CreateGdpPipelineDetails. 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 CreateGdpPipelineDetails.
- Return type
list[str]
- property freeform_tags¶
Gets the freeform_tags of this CreateGdpPipelineDetails. 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 CreateGdpPipelineDetails.
- Return type
dict(str, str)
- property is_approval_needed¶
Gets the is_approval_needed of this CreateGdpPipelineDetails. Determines whether file transfers need to go through an approval workflow.
- Returns
The is_approval_needed of this CreateGdpPipelineDetails.
- Return type
bool
- property is_chunking_enabled¶
Gets the is_chunking_enabled of this CreateGdpPipelineDetails. Determines whether file must be chunked during the transfer. This is only a property of SENDER pipelines.
- Returns
The is_chunking_enabled of this CreateGdpPipelineDetails.
- Return type
bool
- property is_file_override_in_destination_enabled¶
Gets the is_file_override_in_destination_enabled of this CreateGdpPipelineDetails. Enable file override feature in destination bucket
- Returns
The is_file_override_in_destination_enabled of this CreateGdpPipelineDetails.
- Return type
bool
- property is_scanning_enabled¶
Gets the is_scanning_enabled of this CreateGdpPipelineDetails. Determines whether GDP Scanning should be enabled for the pipeline.
- Returns
The is_scanning_enabled of this CreateGdpPipelineDetails.
- Return type
bool
- property peering_region¶
[Required] Gets the peering_region of this CreateGdpPipelineDetails. Public region name where the peered pipeline exists.
- Returns
The peering_region of this CreateGdpPipelineDetails.
- Return type
str
- property pipeline_type¶
[Required] Gets the pipeline_type of this CreateGdpPipelineDetails. Type of pipeline. Can be SENDER or RECEIVER.
- Returns
The pipeline_type of this CreateGdpPipelineDetails.
- Return type
str
- property service_log_group_id¶
Gets the service_log_group_id of this CreateGdpPipelineDetails. the OCID of the service log group.
- Returns
The service_log_group_id of this CreateGdpPipelineDetails.
- Return type
str