CreateSqlEndpointDetails¶

class oci.data_flow.models.CreateSqlEndpointDetails(**kwargs)¶

Bases: object

The information about a new SQL Endpoint.

Methods:

__init__(**kwargs)

Initializes a new CreateSqlEndpointDetails object with values from keyword arguments.

Attributes:

`compartment_id`	[Required] Gets the compartment_id of this CreateSqlEndpointDetails.
`defined_tags`	Gets the defined_tags of this CreateSqlEndpointDetails.
`description`	Gets the description of this CreateSqlEndpointDetails.
`display_name`	[Required] Gets the display_name of this CreateSqlEndpointDetails.
`driver_shape`	[Required] Gets the driver_shape of this CreateSqlEndpointDetails.
`driver_shape_config`	Gets the driver_shape_config of this CreateSqlEndpointDetails.
`executor_shape`	[Required] Gets the executor_shape of this CreateSqlEndpointDetails.
`executor_shape_config`	Gets the executor_shape_config of this CreateSqlEndpointDetails.
`freeform_tags`	Gets the freeform_tags of this CreateSqlEndpointDetails.
`lake_id`	[Required] Gets the lake_id of this CreateSqlEndpointDetails.
`log_compartment_id`	Gets the log_compartment_id of this CreateSqlEndpointDetails.
`log_display_name`	Gets the log_display_name of this CreateSqlEndpointDetails.
`log_group_id`	Gets the log_group_id of this CreateSqlEndpointDetails.
`log_retention_duration`	Gets the log_retention_duration of this CreateSqlEndpointDetails.
`max_executor_count`	[Required] Gets the max_executor_count of this CreateSqlEndpointDetails.
`metastore_id`	[Required] Gets the metastore_id of this CreateSqlEndpointDetails.
`min_executor_count`	[Required] Gets the min_executor_count of this CreateSqlEndpointDetails.
`network_configuration`	[Required] Gets the network_configuration of this CreateSqlEndpointDetails.
`spark_advanced_configurations`	Gets the spark_advanced_configurations of this CreateSqlEndpointDetails.
`sql_endpoint_version`	[Required] Gets the sql_endpoint_version of this CreateSqlEndpointDetails.
`warehouse_bucket_uri`	[Required] Gets the warehouse_bucket_uri of this CreateSqlEndpointDetails.

__init__(**kwargs)¶

Initializes a new CreateSqlEndpointDetails 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 CreateSqlEndpointDetails.
display_name (str) – The value to assign to the display_name property of this CreateSqlEndpointDetails.
description (str) – The value to assign to the description property of this CreateSqlEndpointDetails.
sql_endpoint_version (str) – The value to assign to the sql_endpoint_version property of this CreateSqlEndpointDetails.
driver_shape (str) – The value to assign to the driver_shape property of this CreateSqlEndpointDetails.
driver_shape_config (oci.data_flow.models.ShapeConfig) – The value to assign to the driver_shape_config property of this CreateSqlEndpointDetails.
executor_shape (str) – The value to assign to the executor_shape property of this CreateSqlEndpointDetails.
executor_shape_config (oci.data_flow.models.ShapeConfig) – The value to assign to the executor_shape_config property of this CreateSqlEndpointDetails.
min_executor_count (int) – The value to assign to the min_executor_count property of this CreateSqlEndpointDetails.
max_executor_count (int) – The value to assign to the max_executor_count property of this CreateSqlEndpointDetails.
metastore_id (str) – The value to assign to the metastore_id property of this CreateSqlEndpointDetails.
lake_id (str) – The value to assign to the lake_id property of this CreateSqlEndpointDetails.
warehouse_bucket_uri (str) – The value to assign to the warehouse_bucket_uri property of this CreateSqlEndpointDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateSqlEndpointDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateSqlEndpointDetails.
spark_advanced_configurations (dict(str, str)) – The value to assign to the spark_advanced_configurations property of this CreateSqlEndpointDetails.
network_configuration (oci.data_flow.models.SqlEndpointNetworkConfiguration) – The value to assign to the network_configuration property of this CreateSqlEndpointDetails.
log_group_id (str) – The value to assign to the log_group_id property of this CreateSqlEndpointDetails.
log_compartment_id (str) – The value to assign to the log_compartment_id property of this CreateSqlEndpointDetails.
log_display_name (str) – The value to assign to the log_display_name property of this CreateSqlEndpointDetails.
log_retention_duration (int) – The value to assign to the log_retention_duration property of this CreateSqlEndpointDetails.

property compartment_id¶

[Required] Gets the compartment_id of this CreateSqlEndpointDetails. The identifier of the compartment used with the SQL Endpoint.

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

property defined_tags¶

Gets the defined_tags of this CreateSqlEndpointDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns: The defined_tags of this CreateSqlEndpointDetails.
Return type: dict(str, dict(str, object))

property description¶

Gets the description of this CreateSqlEndpointDetails. The description of CreateSQLEndpointDetails.

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

property display_name¶

[Required] Gets the display_name of this CreateSqlEndpointDetails. The SQL Endpoint name, which can be changed.

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

property driver_shape¶

[Required] Gets the driver_shape of this CreateSqlEndpointDetails. The shape of the SQL Endpoint driver instance.

Returns: The driver_shape of this CreateSqlEndpointDetails.
Return type: str

property driver_shape_config¶

Gets the driver_shape_config of this CreateSqlEndpointDetails.

Returns: The driver_shape_config of this CreateSqlEndpointDetails.
Return type: oci.data_flow.models.ShapeConfig

property executor_shape¶

[Required] Gets the executor_shape of this CreateSqlEndpointDetails. The shape of the SQL Endpoint worker instance.

Returns: The executor_shape of this CreateSqlEndpointDetails.
Return type: str

property executor_shape_config¶

Gets the executor_shape_config of this CreateSqlEndpointDetails.

Returns: The executor_shape_config of this CreateSqlEndpointDetails.
Return type: oci.data_flow.models.ShapeConfig

property freeform_tags¶

Gets the freeform_tags of this CreateSqlEndpointDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

Returns: The freeform_tags of this CreateSqlEndpointDetails.
Return type: dict(str, str)

property lake_id¶

[Required] Gets the lake_id of this CreateSqlEndpointDetails. OCI lake OCID

Returns: The lake_id of this CreateSqlEndpointDetails.
Return type: str

property log_compartment_id¶

Gets the log_compartment_id of this CreateSqlEndpointDetails. The identifier of the log group compartment used with the SQL Endpoint.

Returns: The log_compartment_id of this CreateSqlEndpointDetails.
Return type: str

property log_display_name¶

Gets the log_display_name of this CreateSqlEndpointDetails. The friendly name of the log object used with the SQL Endpoint.

Returns: The log_display_name of this CreateSqlEndpointDetails.
Return type: str

property log_group_id¶

Gets the log_group_id of this CreateSqlEndpointDetails. The identifier of the log group used with the SQL Endpoint.

Returns: The log_group_id of this CreateSqlEndpointDetails.
Return type: str

property log_retention_duration¶

Gets the log_retention_duration of this CreateSqlEndpointDetails. Log retention duration in days

Returns: The log_retention_duration of this CreateSqlEndpointDetails.
Return type: int

property max_executor_count¶

[Required] Gets the max_executor_count of this CreateSqlEndpointDetails. The maximum number of executors.

Returns: The max_executor_count of this CreateSqlEndpointDetails.
Return type: int

property metastore_id¶

[Required] Gets the metastore_id of this CreateSqlEndpointDetails. Metastore OCID

Returns: The metastore_id of this CreateSqlEndpointDetails.
Return type: str

property min_executor_count¶

[Required] Gets the min_executor_count of this CreateSqlEndpointDetails. The minimum number of executors.

Returns: The min_executor_count of this CreateSqlEndpointDetails.
Return type: int

property network_configuration¶

[Required] Gets the network_configuration of this CreateSqlEndpointDetails.

Returns: The network_configuration of this CreateSqlEndpointDetails.
Return type: oci.data_flow.models.SqlEndpointNetworkConfiguration

property spark_advanced_configurations¶

Gets the spark_advanced_configurations of this CreateSqlEndpointDetails. The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { “spark.app.name” : “My App Name”, “spark.shuffle.io.maxRetries” : “4” } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.

Returns: The spark_advanced_configurations of this CreateSqlEndpointDetails.
Return type: dict(str, str)

property sql_endpoint_version¶

[Required] Gets the sql_endpoint_version of this CreateSqlEndpointDetails. The version of the SQL Endpoint.

Returns: The sql_endpoint_version of this CreateSqlEndpointDetails.
Return type: str

property warehouse_bucket_uri¶

[Required] Gets the warehouse_bucket_uri of this CreateSqlEndpointDetails. The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html

Returns: The warehouse_bucket_uri of this CreateSqlEndpointDetails.
Return type: str