Class SqlEndpoint

The description of a SQL Endpoint.

Inheritance
object
SqlEndpoint
Inherited Members
Namespace: Oci.DataflowService.Models
Assembly: OCI.DotNetSDK.Dataflow.dll
Syntax
public class SqlEndpoint

Properties

BannerMessage

Declaration
[JsonProperty(PropertyName = "bannerMessage")]
public string BannerMessage { get; set; }
Property Value
Type Description
string

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

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of a compartment.
Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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

Description

Declaration
[Required(ErrorMessage = "Description is required.")]
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

The description of the SQL Endpoint.
Remarks

Required

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

The SQL Endpoint name, which can be changed.
Remarks

Required

DriverShape

Declaration
[Required(ErrorMessage = "DriverShape is required.")]
[JsonProperty(PropertyName = "driverShape")]
public string DriverShape { get; set; }
Property Value
Type Description
string

The shape of the SQL Endpoint driver instance.
Remarks

Required

DriverShapeConfig

Declaration
[JsonProperty(PropertyName = "driverShapeConfig")]
public ShapeConfig DriverShapeConfig { get; set; }
Property Value
Type Description
ShapeConfig

ExecutorShape

Declaration
[Required(ErrorMessage = "ExecutorShape is required.")]
[JsonProperty(PropertyName = "executorShape")]
public string ExecutorShape { get; set; }
Property Value
Type Description
string

The shape of the SQL Endpoint executor instance.
Remarks

Required

ExecutorShapeConfig

Declaration
[JsonProperty(PropertyName = "executorShapeConfig")]
public ShapeConfig ExecutorShapeConfig { get; set; }
Property Value
Type Description
ShapeConfig

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The provision identifier that is immutable on creation.
Remarks

Required

JdbcEndpointUrl

Declaration
[JsonProperty(PropertyName = "jdbcEndpointUrl")]
public string JdbcEndpointUrl { get; set; }
Property Value
Type Description
string

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

LakeId

Declaration
[Required(ErrorMessage = "LakeId is required.")]
[JsonProperty(PropertyName = "lakeId")]
public string LakeId { get; set; }
Property Value
Type Description
string

The OCID of OCI Lake.
Remarks

Required

LastAcceptedRequestToken

Declaration
[JsonProperty(PropertyName = "lastAcceptedRequestToken")]
public string LastAcceptedRequestToken { get; set; }
Property Value
Type Description
string

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

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SqlEndpointLifecycleState? LifecycleState { get; set; }
Property Value
Type Description
SqlEndpointLifecycleState?

The current state of the Sql Endpoint.

MaxExecutorCount

Declaration
[Required(ErrorMessage = "MaxExecutorCount is required.")]
[JsonProperty(PropertyName = "maxExecutorCount")]
public int? MaxExecutorCount { get; set; }
Property Value
Type Description
int?

The maximum number of executors.
Remarks

Required

MetastoreId

Declaration
[Required(ErrorMessage = "MetastoreId is required.")]
[JsonProperty(PropertyName = "metastoreId")]
public string MetastoreId { get; set; }
Property Value
Type Description
string

The OCID of OCI Hive Metastore.
Remarks

Required

MinExecutorCount

Declaration
[Required(ErrorMessage = "MinExecutorCount is required.")]
[JsonProperty(PropertyName = "minExecutorCount")]
public int? MinExecutorCount { get; set; }
Property Value
Type Description
int?

The minimum number of executors.
Remarks

Required

NetworkConfiguration

Declaration
[JsonProperty(PropertyName = "networkConfiguration")]
public SqlEndpointNetworkConfiguration NetworkConfiguration { get; set; }
Property Value
Type Description
SqlEndpointNetworkConfiguration

SparkAdvancedConfigurations

Declaration
[JsonProperty(PropertyName = "sparkAdvancedConfigurations")]
public Dictionary<string, string> SparkAdvancedConfigurations { get; set; }
Property Value
Type Description
Dictionary<string, string>

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 isnot allowed to be overwritten will cause a 400 status to be returned.

SqlEndpointVersion

Declaration
[Required(ErrorMessage = "SqlEndpointVersion is required.")]
[JsonProperty(PropertyName = "sqlEndpointVersion")]
public string SqlEndpointVersion { get; set; }
Property Value
Type Description
string

The version of SQL Endpoint.
Remarks

Required

StateMessage

Declaration
[JsonProperty(PropertyName = "stateMessage")]
public string StateMessage { get; set; }
Property Value
Type Description
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.

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, 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: {orcl-cloud: {free-tier-retain: true}}

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

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

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

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

WarehouseBucketUri

Declaration
[Required(ErrorMessage = "WarehouseBucketUri is required.")]
[JsonProperty(PropertyName = "warehouseBucketUri")]
public string WarehouseBucketUri { get; set; }
Property Value
Type Description
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
Remarks

Required