SqlEndpoint (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.dataflow.model.SqlEndpoint

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200129")
public final class SqlEndpoint
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
The description of a SQL Endpoint.
Note: Objects should always be created or deserialized using the SqlEndpoint.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SqlEndpoint.Builder, which maintain a set of all explicitly set fields called SqlEndpoint.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SqlEndpoint.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`SqlEndpoint.Builder`

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor and Description
SqlEndpoint(String id, String displayName, String compartmentId, String jdbcEndpointUrl, Date timeCreated, Date timeUpdated, SqlEndpointLifecycleState lifecycleState, String stateMessage, String sqlEndpointVersion, String driverShape, ShapeConfig driverShapeConfig, String executorShape, ShapeConfig executorShapeConfig, Integer minExecutorCount, Integer maxExecutorCount, String metastoreId, String lakeId, String warehouseBucketUri, String description, String lastAcceptedRequestToken, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, Map<String,String> sparkAdvancedConfigurations, String bannerMessage, SqlEndpointNetworkConfiguration networkConfiguration) Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SqlEndpoint.Builder`	`builder()` Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getBannerMessage()` The SQL Endpoint message displayed as a banner to provide user with any action items required on the resource.
`String`	`getCompartmentId()` The OCID of a compartment.
`Map<String,Map<String,Object>>`	`getDefinedTags()` Defined tags for this resource.
`String`	`getDescription()` The description of the SQL Endpoint.
`String`	`getDisplayName()` The SQL Endpoint name, which can be changed.
`String`	`getDriverShape()` The shape of the SQL Endpoint driver instance.
`ShapeConfig`	`getDriverShapeConfig()`
`String`	`getExecutorShape()` The shape of the SQL Endpoint executor instance.
`ShapeConfig`	`getExecutorShapeConfig()`
`Map<String,String>`	`getFreeformTags()` Free-form tags for this resource.
`String`	`getId()` The provision identifier that is immutable on creation.
`String`	`getJdbcEndpointUrl()` The JDBC URL field.
`String`	`getLakeId()` The OCID of OCI Lake.
`String`	`getLastAcceptedRequestToken()` This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.
`SqlEndpointLifecycleState`	`getLifecycleState()` The current state of the Sql Endpoint.
`Integer`	`getMaxExecutorCount()` The maximum number of executors.
`String`	`getMetastoreId()` The OCID of OCI Hive Metastore.
`Integer`	`getMinExecutorCount()` The minimum number of executors.
`SqlEndpointNetworkConfiguration`	`getNetworkConfiguration()`
`Map<String,String>`	`getSparkAdvancedConfigurations()` The Spark configuration passed to the running process.
`String`	`getSqlEndpointVersion()` The version of SQL Endpoint.
`String`	`getStateMessage()` A message describing the reason why the resource is in it’s current state.
`Map<String,Map<String,Object>>`	`getSystemTags()` The system tags associated with this resource, if any.
`Date`	`getTimeCreated()` The time the Sql Endpoint was created.
`Date`	`getTimeUpdated()` The time the Sql Endpoint was updated.
`String`	`getWarehouseBucketUri()` The warehouse bucket URI.
`int`	`hashCode()`
`SqlEndpoint.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)` Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SqlEndpoint

@Deprecated
 @ConstructorProperties(value={"id","displayName","compartmentId","jdbcEndpointUrl","timeCreated","timeUpdated","lifecycleState","stateMessage","sqlEndpointVersion","driverShape","driverShapeConfig","executorShape","executorShapeConfig","minExecutorCount","maxExecutorCount","metastoreId","lakeId","warehouseBucketUri","description","lastAcceptedRequestToken","freeformTags","definedTags","systemTags","sparkAdvancedConfigurations","bannerMessage","networkConfiguration"})
public SqlEndpoint(String id,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String displayName,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String compartmentId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String jdbcEndpointUrl,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Date timeCreated,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Date timeUpdated,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SqlEndpointLifecycleState lifecycleState,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String stateMessage,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String sqlEndpointVersion,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String driverShape,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ShapeConfig driverShapeConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String executorShape,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ShapeConfig executorShapeConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Integer minExecutorCount,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Integer maxExecutorCount,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String metastoreId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String lakeId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String warehouseBucketUri,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String description,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String lastAcceptedRequestToken,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Map<String,Map<String,Object>> systemTags,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Map<String,String> sparkAdvancedConfigurations,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String bannerMessage,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SqlEndpointNetworkConfiguration networkConfiguration)

Deprecated.

Method Detail
- builder
```
public static SqlEndpoint.Builder builder()
```
  Create a new builder.
- toBuilder
```
public SqlEndpoint.Builder toBuilder()
```
- getId
```
public String getId()
```
  The provision identifier that is immutable on creation.
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  The SQL Endpoint name, which can be changed.
  
  Returns:
  
  the value
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of a compartment.
  
  Returns:
  
  the value
- getJdbcEndpointUrl
```
public String getJdbcEndpointUrl()
```
  The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI
  
  Returns:
  
  the value
- getTimeCreated
```
public Date getTimeCreated()
```
  The time the Sql Endpoint was created. An RFC3339 formatted datetime string.
  
  Returns:
  
  the value
- getTimeUpdated
```
public Date getTimeUpdated()
```
  The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.
  
  Returns:
  
  the value
- getLifecycleState
```
public SqlEndpointLifecycleState getLifecycleState()
```
  The current state of the Sql Endpoint.
  
  Returns:
  
  the value
- getStateMessage
```
public String getStateMessage()
```
  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 value
- getSqlEndpointVersion
```
public String getSqlEndpointVersion()
```
  The version of SQL Endpoint.
  
  Returns:
  
  the value
- getDriverShape
```
public String getDriverShape()
```
  The shape of the SQL Endpoint driver instance.
  
  Returns:
  
  the value
- getDriverShapeConfig
```
public ShapeConfig getDriverShapeConfig()
```
- getExecutorShape
```
public String getExecutorShape()
```
  The shape of the SQL Endpoint executor instance.
  
  Returns:
  
  the value
- getExecutorShapeConfig
```
public ShapeConfig getExecutorShapeConfig()
```
- getMinExecutorCount
```
public Integer getMinExecutorCount()
```
  The minimum number of executors.
  
  Returns:
  
  the value
- getMaxExecutorCount
```
public Integer getMaxExecutorCount()
```
  The maximum number of executors.
  
  Returns:
  
  the value
- getMetastoreId
```
public String getMetastoreId()
```
  The OCID of OCI Hive Metastore.
  
  Returns:
  
  the value
- getLakeId
```
public String getLakeId()
```
  The OCID of OCI Lake.
  
  Returns:
  
  the value
- getWarehouseBucketUri
```
public String getWarehouseBucketUri()
```
  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 value
- getDescription
```
public String getDescription()
```
  The description of the SQL Endpoint.
  
  Returns:
  
  the value
- getLastAcceptedRequestToken
```
public String getLastAcceptedRequestToken()
```
  This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.
  
  Returns:
  
  the value
- getFreeformTags
```
public Map<String,String> getFreeformTags()
```
  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 value
- getDefinedTags
```
public Map<String,Map<String,Object>> getDefinedTags()
```
  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 value
- getSystemTags
```
public Map<String,Map<String,Object>> getSystemTags()
```
  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 value
- getSparkAdvancedConfigurations
```
public Map<String,String> getSparkAdvancedConfigurations()
```
  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 value
- getBannerMessage
```
public String getBannerMessage()
```
  The SQL Endpoint message displayed as a banner to provide user with any action items required on the resource.
  
  Returns:
  
  the value
- getNetworkConfiguration
```
public SqlEndpointNetworkConfiguration getNetworkConfiguration()
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- toString
```
public String toString(boolean includeByteArrayContents)
```
  Return a string representation of the object.
  
  Parameters:
  
  includeByteArrayContents - true to include the full contents of byte arrays
  
  Returns:
  
  string representation
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Class SqlEndpoint

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

SqlEndpoint

Method Detail

builder

toBuilder

getId

getDisplayName

getCompartmentId

getJdbcEndpointUrl

getTimeCreated

getTimeUpdated

getLifecycleState

getStateMessage

getSqlEndpointVersion

getDriverShape

getDriverShapeConfig

getExecutorShape

getExecutorShapeConfig

getMinExecutorCount

getMaxExecutorCount

getMetastoreId

getLakeId

getWarehouseBucketUri

getDescription

getLastAcceptedRequestToken

getFreeformTags

getDefinedTags

getSystemTags

getSparkAdvancedConfigurations

getBannerMessage

getNetworkConfiguration

toString

toString

equals

hashCode