UpdateSqlEndpointDetails

class oci.data_flow.models.UpdateSqlEndpointDetails(**kwargs)

Bases: object

The information about all updatable parameters of a SQL Endpoint.

Attributes:

LOG_OPERATION_DELETE

A constant which can be used with the log_operation property of a UpdateSqlEndpointDetails.

LOG_OPERATION_DISABLE

A constant which can be used with the log_operation property of a UpdateSqlEndpointDetails.

LOG_OPERATION_ENABLE

A constant which can be used with the log_operation property of a UpdateSqlEndpointDetails.

defined_tags

Gets the defined_tags of this UpdateSqlEndpointDetails.

description

Gets the description of this UpdateSqlEndpointDetails.

display_name

Gets the display_name of this UpdateSqlEndpointDetails.

driver_shape

Gets the driver_shape of this UpdateSqlEndpointDetails.

driver_shape_config

Gets the driver_shape_config of this UpdateSqlEndpointDetails.

executor_shape

Gets the executor_shape of this UpdateSqlEndpointDetails.

executor_shape_config

Gets the executor_shape_config of this UpdateSqlEndpointDetails.

freeform_tags

Gets the freeform_tags of this UpdateSqlEndpointDetails.

lake_id

Gets the lake_id of this UpdateSqlEndpointDetails.

log_compartment_id

Gets the log_compartment_id of this UpdateSqlEndpointDetails.

log_display_name

Gets the log_display_name of this UpdateSqlEndpointDetails.

log_group_id

Gets the log_group_id of this UpdateSqlEndpointDetails.

log_operation

Gets the log_operation of this UpdateSqlEndpointDetails.

log_retention_duration

Gets the log_retention_duration of this UpdateSqlEndpointDetails.

max_executor_count

Gets the max_executor_count of this UpdateSqlEndpointDetails.

metastore_id

Gets the metastore_id of this UpdateSqlEndpointDetails.

min_executor_count

Gets the min_executor_count of this UpdateSqlEndpointDetails.

spark_advanced_configurations

Gets the spark_advanced_configurations of this UpdateSqlEndpointDetails.

Methods:

__init__(**kwargs)

Initializes a new UpdateSqlEndpointDetails object with values from keyword arguments.

LOG_OPERATION_DELETE = 'DELETE'

A constant which can be used with the log_operation property of a UpdateSqlEndpointDetails. This constant has a value of “DELETE”

LOG_OPERATION_DISABLE = 'DISABLE'

A constant which can be used with the log_operation property of a UpdateSqlEndpointDetails. This constant has a value of “DISABLE”

LOG_OPERATION_ENABLE = 'ENABLE'

A constant which can be used with the log_operation property of a UpdateSqlEndpointDetails. This constant has a value of “ENABLE”

__init__(**kwargs)

Initializes a new UpdateSqlEndpointDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateSqlEndpointDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateSqlEndpointDetails.

  • display_name (str) – The value to assign to the display_name property of this UpdateSqlEndpointDetails.

  • description (str) – The value to assign to the description property of this UpdateSqlEndpointDetails.

  • driver_shape (str) – The value to assign to the driver_shape property of this UpdateSqlEndpointDetails.

  • driver_shape_config (oci.data_flow.models.ShapeConfig) – The value to assign to the driver_shape_config property of this UpdateSqlEndpointDetails.

  • executor_shape (str) – The value to assign to the executor_shape property of this UpdateSqlEndpointDetails.

  • executor_shape_config (oci.data_flow.models.ShapeConfig) – The value to assign to the executor_shape_config property of this UpdateSqlEndpointDetails.

  • min_executor_count (int) – The value to assign to the min_executor_count property of this UpdateSqlEndpointDetails.

  • max_executor_count (int) – The value to assign to the max_executor_count property of this UpdateSqlEndpointDetails.

  • metastore_id (str) – The value to assign to the metastore_id property of this UpdateSqlEndpointDetails.

  • lake_id (str) – The value to assign to the lake_id property of this UpdateSqlEndpointDetails.

  • log_group_id (str) – The value to assign to the log_group_id property of this UpdateSqlEndpointDetails.

  • log_compartment_id (str) – The value to assign to the log_compartment_id property of this UpdateSqlEndpointDetails.

  • log_display_name (str) – The value to assign to the log_display_name property of this UpdateSqlEndpointDetails.

  • log_retention_duration (int) – The value to assign to the log_retention_duration property of this UpdateSqlEndpointDetails.

  • log_operation (str) – The value to assign to the log_operation property of this UpdateSqlEndpointDetails. Allowed values for this property are: “ENABLE”, “DISABLE”, “DELETE”

  • spark_advanced_configurations (dict(str, str)) – The value to assign to the spark_advanced_configurations property of this UpdateSqlEndpointDetails.

property defined_tags

Gets the defined_tags of this UpdateSqlEndpointDetails. 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 UpdateSqlEndpointDetails.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this UpdateSqlEndpointDetails.

Return type

str

property display_name

Gets the display_name of this UpdateSqlEndpointDetails. The SQL Endpoint name, which can be changed.

Returns

The display_name of this UpdateSqlEndpointDetails.

Return type

str

property driver_shape

Gets the driver_shape of this UpdateSqlEndpointDetails. The shape of the SQL Endpoint driver instance.

Returns

The driver_shape of this UpdateSqlEndpointDetails.

Return type

str

property driver_shape_config

Gets the driver_shape_config of this UpdateSqlEndpointDetails.

Returns

The driver_shape_config of this UpdateSqlEndpointDetails.

Return type

oci.data_flow.models.ShapeConfig

property executor_shape

Gets the executor_shape of this UpdateSqlEndpointDetails. The shape of the SQL Endpoint worker instance.

Returns

The executor_shape of this UpdateSqlEndpointDetails.

Return type

str

property executor_shape_config

Gets the executor_shape_config of this UpdateSqlEndpointDetails.

Returns

The executor_shape_config of this UpdateSqlEndpointDetails.

Return type

oci.data_flow.models.ShapeConfig

property freeform_tags

Gets the freeform_tags of this UpdateSqlEndpointDetails. 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 UpdateSqlEndpointDetails.

Return type

dict(str, str)

property lake_id

Gets the lake_id of this UpdateSqlEndpointDetails. OCI lake OCID

Returns

The lake_id of this UpdateSqlEndpointDetails.

Return type

str

property log_compartment_id

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

Returns

The log_compartment_id of this UpdateSqlEndpointDetails.

Return type

str

property log_display_name

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

Returns

The log_display_name of this UpdateSqlEndpointDetails.

Return type

str

property log_group_id

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

Returns

The log_group_id of this UpdateSqlEndpointDetails.

Return type

str

property log_operation

Gets the log_operation of this UpdateSqlEndpointDetails. The log operation will be performed for the Sql Endpoint.

Allowed values for this property are: “ENABLE”, “DISABLE”, “DELETE”

Returns

The log_operation of this UpdateSqlEndpointDetails.

Return type

str

property log_retention_duration

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

Returns

The log_retention_duration of this UpdateSqlEndpointDetails.

Return type

int

property max_executor_count

Gets the max_executor_count of this UpdateSqlEndpointDetails. The maximum number of executors.

Returns

The max_executor_count of this UpdateSqlEndpointDetails.

Return type

int

property metastore_id

Gets the metastore_id of this UpdateSqlEndpointDetails. Metastore OCID

Returns

The metastore_id of this UpdateSqlEndpointDetails.

Return type

str

property min_executor_count

Gets the min_executor_count of this UpdateSqlEndpointDetails. The minimum number of executors.

Returns

The min_executor_count of this UpdateSqlEndpointDetails.

Return type

int

property spark_advanced_configurations

Gets the spark_advanced_configurations of this UpdateSqlEndpointDetails. 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 UpdateSqlEndpointDetails.

Return type

dict(str, str)