Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SqlEndpoint

The description of a SQL Endpoint.

Properties

Optional bannerMessage

bannerMessage: undefined | string

The SQL Endpoint message displayed as a banner to provide user with any action items required on the resource.

compartmentId

compartmentId: string

The OCID of a compartment.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

description

description: string

The description of the SQL Endpoint.

displayName

displayName: string

The SQL Endpoint name, which can be changed.

driverShape

driverShape: string

The shape of the SQL Endpoint driver instance.

Optional driverShapeConfig

driverShapeConfig: model.ShapeConfig

executorShape

executorShape: string

The shape of the SQL Endpoint executor instance.

Optional executorShapeConfig

executorShapeConfig: model.ShapeConfig

Optional freeformTags

freeformTags: undefined | object

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: {@code {"Department": "Finance"}}

id

id: string

The provision identifier that is immutable on creation.

Optional jdbcEndpointUrl

jdbcEndpointUrl: undefined | string

The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

lakeId

lakeId: string

The OCID of OCI Lake.

Optional lastAcceptedRequestToken

lastAcceptedRequestToken: undefined | string

This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

Optional lifecycleState

lifecycleState: model.SqlEndpointLifecycleState

The current state of the Sql Endpoint.

maxExecutorCount

maxExecutorCount: number

The maximum number of executors. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

metastoreId

metastoreId: string

The OCID of OCI Hive Metastore.

minExecutorCount

minExecutorCount: number

The minimum number of executors. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional networkConfiguration

Optional sparkAdvancedConfigurations

sparkAdvancedConfigurations: undefined | object

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.

sqlEndpointVersion

sqlEndpointVersion: string

The version of SQL Endpoint.

Optional stateMessage

stateMessage: undefined | string

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.

Optional systemTags

systemTags: undefined | object

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: {@code {orcl-cloud: {free-tier-retain: true}}}

Optional timeCreated

timeCreated: Date

The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.

warehouseBucketUri

warehouseBucketUri: string

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

Functions

getDeserializedJsonObj

getJsonObj