Class SqlEndpointSummary


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20200129")
    public final class SqlEndpointSummary
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A summary of the Sql Endpoint.
    Note: Objects should always be created or deserialized using the SqlEndpointSummary.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 SqlEndpointSummary.Builder, which maintain a set of all explicitly set fields called SqlEndpointSummary.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).
    • Method Detail

      • 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
      • getOwnerPrincipalId

        public String getOwnerPrincipalId()
        The OCID of the user who created the resource.
        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
      • 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