SqlEndpointSummary¶

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

Bases: object

A summary of the Sql Endpoint.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a SqlEndpointSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a SqlEndpointSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a SqlEndpointSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a SqlEndpointSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a SqlEndpointSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a SqlEndpointSummary.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a SqlEndpointSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a SqlEndpointSummary.
`compartment_id`	[Required] Gets the compartment_id of this SqlEndpointSummary.
`defined_tags`	Gets the defined_tags of this SqlEndpointSummary.
`description`	[Required] Gets the description of this SqlEndpointSummary.
`display_name`	[Required] Gets the display_name of this SqlEndpointSummary.
`driver_shape`	[Required] Gets the driver_shape of this SqlEndpointSummary.
`driver_shape_config`	Gets the driver_shape_config of this SqlEndpointSummary.
`executor_shape`	[Required] Gets the executor_shape of this SqlEndpointSummary.
`executor_shape_config`	Gets the executor_shape_config of this SqlEndpointSummary.
`freeform_tags`	Gets the freeform_tags of this SqlEndpointSummary.
`id`	[Required] Gets the id of this SqlEndpointSummary.
`jdbc_endpoint_url`	Gets the jdbc_endpoint_url of this SqlEndpointSummary.
`lake_id`	[Required] Gets the lake_id of this SqlEndpointSummary.
`last_accepted_request_token`	Gets the last_accepted_request_token of this SqlEndpointSummary.
`lifecycle_state`	Gets the lifecycle_state of this SqlEndpointSummary.
`max_executor_count`	[Required] Gets the max_executor_count of this SqlEndpointSummary.
`metastore_id`	[Required] Gets the metastore_id of this SqlEndpointSummary.
`min_executor_count`	[Required] Gets the min_executor_count of this SqlEndpointSummary.
`network_configuration`	Gets the network_configuration of this SqlEndpointSummary.
`owner_principal_id`	Gets the owner_principal_id of this SqlEndpointSummary.
`spark_advanced_configurations`	Gets the spark_advanced_configurations of this SqlEndpointSummary.
`sql_endpoint_version`	[Required] Gets the sql_endpoint_version of this SqlEndpointSummary.
`state_message`	Gets the state_message of this SqlEndpointSummary.
`system_tags`	Gets the system_tags of this SqlEndpointSummary.
`time_created`	Gets the time_created of this SqlEndpointSummary.
`time_updated`	Gets the time_updated of this SqlEndpointSummary.
`warehouse_bucket_uri`	[Required] Gets the warehouse_bucket_uri of this SqlEndpointSummary.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a SqlEndpointSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a SqlEndpointSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a SqlEndpointSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a SqlEndpointSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a SqlEndpointSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a SqlEndpointSummary. 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 SqlEndpointSummary. 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 SqlEndpointSummary. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new SqlEndpointSummary 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 SqlEndpointSummary.
display_name (str) – The value to assign to the display_name property of this SqlEndpointSummary.
compartment_id (str) – The value to assign to the compartment_id property of this SqlEndpointSummary.
jdbc_endpoint_url (str) – The value to assign to the jdbc_endpoint_url property of this SqlEndpointSummary.
time_created (datetime) – The value to assign to the time_created property of this SqlEndpointSummary.
time_updated (datetime) – The value to assign to the time_updated property of this SqlEndpointSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SqlEndpointSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “UPDATING”, “NEEDS_ATTENTION”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
state_message (str) – The value to assign to the state_message property of this SqlEndpointSummary.
sql_endpoint_version (str) – The value to assign to the sql_endpoint_version property of this SqlEndpointSummary.
driver_shape (str) – The value to assign to the driver_shape property of this SqlEndpointSummary.
driver_shape_config (oci.data_flow.models.ShapeConfig) – The value to assign to the driver_shape_config property of this SqlEndpointSummary.
executor_shape (str) – The value to assign to the executor_shape property of this SqlEndpointSummary.
executor_shape_config (oci.data_flow.models.ShapeConfig) – The value to assign to the executor_shape_config property of this SqlEndpointSummary.
min_executor_count (int) – The value to assign to the min_executor_count property of this SqlEndpointSummary.
max_executor_count (int) – The value to assign to the max_executor_count property of this SqlEndpointSummary.
owner_principal_id (str) – The value to assign to the owner_principal_id property of this SqlEndpointSummary.
metastore_id (str) – The value to assign to the metastore_id property of this SqlEndpointSummary.
lake_id (str) – The value to assign to the lake_id property of this SqlEndpointSummary.
warehouse_bucket_uri (str) – The value to assign to the warehouse_bucket_uri property of this SqlEndpointSummary.
description (str) – The value to assign to the description property of this SqlEndpointSummary.
last_accepted_request_token (str) – The value to assign to the last_accepted_request_token property of this SqlEndpointSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SqlEndpointSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SqlEndpointSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SqlEndpointSummary.
spark_advanced_configurations (dict(str, str)) – The value to assign to the spark_advanced_configurations property of this SqlEndpointSummary.
network_configuration (oci.data_flow.models.SqlEndpointNetworkConfiguration) – The value to assign to the network_configuration property of this SqlEndpointSummary.

compartment_id¶

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

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

defined_tags¶

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

description¶

[Required] Gets the description of this SqlEndpointSummary. The description of the SQL Endpoint.

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

display_name¶

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

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

driver_shape¶

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

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

driver_shape_config¶

Gets the driver_shape_config of this SqlEndpointSummary.

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

executor_shape¶

[Required] Gets the executor_shape of this SqlEndpointSummary. The shape of the SQL Endpoint executor instance.

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

executor_shape_config¶

Gets the executor_shape_config of this SqlEndpointSummary.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this SqlEndpointSummary. The provision identifier that is immutable on creation.

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

jdbc_endpoint_url¶

Gets the jdbc_endpoint_url of this SqlEndpointSummary. The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

Returns:	The jdbc_endpoint_url of this SqlEndpointSummary.
Return type:	str

lake_id¶

[Required] Gets the lake_id of this SqlEndpointSummary. The OCID of OCI Lake.

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

last_accepted_request_token¶

Gets the last_accepted_request_token of this SqlEndpointSummary. This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

Returns:	The last_accepted_request_token of this SqlEndpointSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this SqlEndpointSummary. The current state of the Sql Endpoint.

Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “UPDATING”, “NEEDS_ATTENTION”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

max_executor_count¶

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

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

metastore_id¶

[Required] Gets the metastore_id of this SqlEndpointSummary. The OCID of OCI Hive Metastore.

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

min_executor_count¶

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

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

network_configuration¶

Gets the network_configuration of this SqlEndpointSummary.

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

owner_principal_id¶

Gets the owner_principal_id of this SqlEndpointSummary. The OCID of the user who created the resource.

Returns:	The owner_principal_id of this SqlEndpointSummary.
Return type:	str

spark_advanced_configurations¶

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

sql_endpoint_version¶

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

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

state_message¶

Gets the state_message of this SqlEndpointSummary. A message describing the reason why the resource is in it’s current state. Helps bubble up errors in state changes. For example, it can be used to provide actionable information for a resource in the Failed state.

Returns:	The state_message of this SqlEndpointSummary.
Return type:	str

system_tags¶

Gets the system_tags of this SqlEndpointSummary. The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

Returns:	The system_tags of this SqlEndpointSummary.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this SqlEndpointSummary. The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

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

time_updated¶

Gets the time_updated of this SqlEndpointSummary. The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.

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

warehouse_bucket_uri¶

[Required] Gets the warehouse_bucket_uri of this SqlEndpointSummary. 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 SqlEndpointSummary.
Return type:	str