Class SqlEndpoint.Builder

  • Enclosing class:
    SqlEndpoint

    public static class SqlEndpoint.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • id

        public SqlEndpoint.Builder id​(String id)
        The provision identifier that is immutable on creation.
        Parameters:
        id - the value to set
        Returns:
        this builder
      • displayName

        public SqlEndpoint.Builder displayName​(String displayName)
        The SQL Endpoint name, which can be changed.
        Parameters:
        displayName - the value to set
        Returns:
        this builder
      • compartmentId

        public SqlEndpoint.Builder compartmentId​(String compartmentId)
        The OCID of a compartment.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder
      • jdbcEndpointUrl

        public SqlEndpoint.Builder jdbcEndpointUrl​(String jdbcEndpointUrl)
        The JDBC URL field.

        For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

        Parameters:
        jdbcEndpointUrl - the value to set
        Returns:
        this builder
      • timeCreated

        public SqlEndpoint.Builder timeCreated​(Date timeCreated)
        The time the Sql Endpoint was created.

        An RFC3339 formatted datetime string.

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder
      • timeUpdated

        public SqlEndpoint.Builder timeUpdated​(Date timeUpdated)
        The time the Sql Endpoint was updated.

        An RFC3339 formatted datetime string.

        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder
      • stateMessage

        public SqlEndpoint.Builder stateMessage​(String stateMessage)
        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.

        Parameters:
        stateMessage - the value to set
        Returns:
        this builder
      • sqlEndpointVersion

        public SqlEndpoint.Builder sqlEndpointVersion​(String sqlEndpointVersion)
        The version of SQL Endpoint.
        Parameters:
        sqlEndpointVersion - the value to set
        Returns:
        this builder
      • driverShape

        public SqlEndpoint.Builder driverShape​(String driverShape)
        The shape of the SQL Endpoint driver instance.
        Parameters:
        driverShape - the value to set
        Returns:
        this builder
      • executorShape

        public SqlEndpoint.Builder executorShape​(String executorShape)
        The shape of the SQL Endpoint executor instance.
        Parameters:
        executorShape - the value to set
        Returns:
        this builder
      • minExecutorCount

        public SqlEndpoint.Builder minExecutorCount​(Integer minExecutorCount)
        The minimum number of executors.
        Parameters:
        minExecutorCount - the value to set
        Returns:
        this builder
      • maxExecutorCount

        public SqlEndpoint.Builder maxExecutorCount​(Integer maxExecutorCount)
        The maximum number of executors.
        Parameters:
        maxExecutorCount - the value to set
        Returns:
        this builder
      • metastoreId

        public SqlEndpoint.Builder metastoreId​(String metastoreId)
        The OCID of OCI Hive Metastore.
        Parameters:
        metastoreId - the value to set
        Returns:
        this builder
      • lakeId

        public SqlEndpoint.Builder lakeId​(String lakeId)
        The OCID of OCI Lake.
        Parameters:
        lakeId - the value to set
        Returns:
        this builder
      • warehouseBucketUri

        public SqlEndpoint.Builder warehouseBucketUri​(String warehouseBucketUri)
        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

        Parameters:
        warehouseBucketUri - the value to set
        Returns:
        this builder
      • description

        public SqlEndpoint.Builder description​(String description)
        The description of the SQL Endpoint.
        Parameters:
        description - the value to set
        Returns:
        this builder
      • lastAcceptedRequestToken

        public SqlEndpoint.Builder lastAcceptedRequestToken​(String lastAcceptedRequestToken)
        This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.
        Parameters:
        lastAcceptedRequestToken - the value to set
        Returns:
        this builder
      • freeformTags

        public SqlEndpoint.Builder freeformTags​(Map<String,​String> freeformTags)
        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”}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder
      • definedTags

        public SqlEndpoint.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder
      • systemTags

        public SqlEndpoint.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        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}}

        Parameters:
        systemTags - the value to set
        Returns:
        this builder
      • sparkAdvancedConfigurations

        public SqlEndpoint.Builder sparkAdvancedConfigurations​(Map<String,​String> sparkAdvancedConfigurations)
        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.

        Parameters:
        sparkAdvancedConfigurations - the value to set
        Returns:
        this builder
      • bannerMessage

        public SqlEndpoint.Builder bannerMessage​(String bannerMessage)
        The SQL Endpoint message displayed as a banner to provide user with any action items required on the resource.
        Parameters:
        bannerMessage - the value to set
        Returns:
        this builder