Package io.tiledb.cloud.rest_api.model

Class ArrayTask

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-09-14T18:46:41.869452+03:00[Europe/Athens]")
public class ArrayTask
extends java.lang.Object
    Synchronous Task to Run

    • Field Detail

      • SERIALIZED_NAME_ID

        public static final java.lang.String SERIALIZED_NAME_ID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_NAME

        public static final java.lang.String SERIALIZED_NAME_NAME
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_DESCRIPTION

        public static final java.lang.String SERIALIZED_NAME_DESCRIPTION
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ARRAY_METADATA

        public static final java.lang.String SERIALIZED_NAME_ARRAY_METADATA
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_SUBARRAY

        public static final java.lang.String SERIALIZED_NAME_SUBARRAY
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_MEMORY

        public static final java.lang.String SERIALIZED_NAME_MEMORY
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_CPU

        public static final java.lang.String SERIALIZED_NAME_CPU
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_NAMESPACE

        public static final java.lang.String SERIALIZED_NAME_NAMESPACE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_STATUS

        public static final java.lang.String SERIALIZED_NAME_STATUS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_START_TIME

        public static final java.lang.String SERIALIZED_NAME_START_TIME
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_FINISH_TIME

        public static final java.lang.String SERIALIZED_NAME_FINISH_TIME
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_COST

        public static final java.lang.String SERIALIZED_NAME_COST
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_EGRESS_COST

        public static final java.lang.String SERIALIZED_NAME_EGRESS_COST
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ACCESS_COST

        public static final java.lang.String SERIALIZED_NAME_ACCESS_COST
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_QUERY_TYPE

        public static final java.lang.String SERIALIZED_NAME_QUERY_TYPE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_UDF_CODE

        public static final java.lang.String SERIALIZED_NAME_UDF_CODE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_UDF_LANGUAGE

        public static final java.lang.String SERIALIZED_NAME_UDF_LANGUAGE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_SQL_QUERY

        public static final java.lang.String SERIALIZED_NAME_SQL_QUERY
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_TYPE

        public static final java.lang.String SERIALIZED_NAME_TYPE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ACTIVITY

        public static final java.lang.String SERIALIZED_NAME_ACTIVITY
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_LOGS

        public static final java.lang.String SERIALIZED_NAME_LOGS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_DURATION

        public static final java.lang.String SERIALIZED_NAME_DURATION
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_SQL_INIT_COMMANDS

        public static final java.lang.String SERIALIZED_NAME_SQL_INIT_COMMANDS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_SQL_PARAMETERS

        public static final java.lang.String SERIALIZED_NAME_SQL_PARAMETERS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_RESULT_FORMAT

        public static final java.lang.String SERIALIZED_NAME_RESULT_FORMAT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_TASK_GRAPH_UUID

        public static final java.lang.String SERIALIZED_NAME_TASK_GRAPH_UUID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_CLIENT_NODE_UUID

        public static final java.lang.String SERIALIZED_NAME_CLIENT_NODE_UUID
        See Also:
        Constant Field Values

      • openapiFields

        public static java.util.HashSet<java.lang.String> openapiFields

      • openapiRequiredFields

        public static java.util.HashSet<java.lang.String> openapiRequiredFields

    • Constructor Detail

      • ArrayTask

        public ArrayTask()

    • Method Detail

      • id

        public ArrayTask id​(java.lang.String id)

      • getId

        @Nullable
public java.lang.String getId()
        task ID
        Returns:
        id

      • setId

        public void setId​(java.lang.String id)

      • name

        public ArrayTask name​(java.lang.String name)

      • getName

        @Nullable
public java.lang.String getName()
        Optional task name
        Returns:
        name

      • setName

        public void setName​(java.lang.String name)

      • description

        public ArrayTask description​(java.lang.String description)

      • getDescription

        @Nullable
public java.lang.String getDescription()
        Optional task description (Tasks purpose)
        Returns:
        description

      • setDescription

        public void setDescription​(java.lang.String description)

      • getArrayMetadata

        @Nullable
public ArrayInfo getArrayMetadata()
        Get arrayMetadata
        Returns:
        arrayMetadata

      • setArrayMetadata

        public void setArrayMetadata​(ArrayInfo arrayMetadata)

      • getSubarray

        @Nullable
public DomainArray getSubarray()
        Get subarray
        Returns:
        subarray

      • setSubarray

        public void setSubarray​(DomainArray subarray)

      • memory

        public ArrayTask memory​(java.lang.Integer memory)

      • getMemory

        @Nullable
public java.lang.Integer getMemory()
        memory allocated to task in bytes
        Returns:
        memory

      • setMemory

        public void setMemory​(java.lang.Integer memory)

      • cpu

        public ArrayTask cpu​(java.lang.Integer cpu)

      • getCpu

        @Nullable
public java.lang.Integer getCpu()
        millicpu allocated to task
        Returns:
        cpu

      • setCpu

        public void setCpu​(java.lang.Integer cpu)

      • namespace

        public ArrayTask namespace​(java.lang.String namespace)

      • getNamespace

        @Nullable
public java.lang.String getNamespace()
        namespace task is tied to
        Returns:
        namespace

      • setNamespace

        public void setNamespace​(java.lang.String namespace)

      • getStatus

        @Nullable
public ArrayTaskStatus getStatus()
        Get status
        Returns:
        status

      • startTime

        public ArrayTask startTime​(java.time.OffsetDateTime startTime)

      • getStartTime

        @Nullable
public java.time.OffsetDateTime getStartTime()
        Start time RFC3339 for job
        Returns:
        startTime

      • setStartTime

        public void setStartTime​(java.time.OffsetDateTime startTime)

      • finishTime

        public ArrayTask finishTime​(java.time.OffsetDateTime finishTime)

      • getFinishTime

        @Nullable
public java.time.OffsetDateTime getFinishTime()
        Finish time RFC3339 for job
        Returns:
        finishTime

      • setFinishTime

        public void setFinishTime​(java.time.OffsetDateTime finishTime)

      • cost

        public ArrayTask cost​(java.lang.Double cost)

      • getCost

        @Nullable
public java.lang.Double getCost()
        Total accumulated for task in USD, example is $0.12
        Returns:
        cost

      • setCost

        public void setCost​(java.lang.Double cost)

      • egressCost

        public ArrayTask egressCost​(java.lang.Double egressCost)

      • getEgressCost

        @Nullable
public java.lang.Double getEgressCost()
        Total accumulated for egress task in USD, example is $0.12
        Returns:
        egressCost

      • setEgressCost

        public void setEgressCost​(java.lang.Double egressCost)

      • accessCost

        public ArrayTask accessCost​(java.lang.Double accessCost)

      • getAccessCost

        @Nullable
public java.lang.Double getAccessCost()
        Cost accumulated for access task in USD, example is $0.12
        Returns:
        accessCost

      • setAccessCost

        public void setAccessCost​(java.lang.Double accessCost)

      • getQueryType

        @Nullable
public Querytype getQueryType()
        Get queryType
        Returns:
        queryType

      • setQueryType

        public void setQueryType​(Querytype queryType)

      • udfCode

        public ArrayTask udfCode​(java.lang.String udfCode)

      • getUdfCode

        @Nullable
public java.lang.String getUdfCode()
        Optional actual code that is going to be executed
        Returns:
        udfCode

      • setUdfCode

        public void setUdfCode​(java.lang.String udfCode)

      • udfLanguage

        public ArrayTask udfLanguage​(java.lang.String udfLanguage)

      • getUdfLanguage

        @Nullable
public java.lang.String getUdfLanguage()
        Optional actual language used to express udf_code
        Returns:
        udfLanguage

      • setUdfLanguage

        public void setUdfLanguage​(java.lang.String udfLanguage)

      • sqlQuery

        public ArrayTask sqlQuery​(java.lang.String sqlQuery)

      • getSqlQuery

        @Nullable
public java.lang.String getSqlQuery()
        Optional actual sql query that is going to be executed
        Returns:
        sqlQuery

      • setSqlQuery

        public void setSqlQuery​(java.lang.String sqlQuery)

      • getType

        @Nullable
public ArrayTaskType getType()
        Get type
        Returns:
        type

      • getActivity

        @Nullable
public java.util.List<ArrayActivityLog> getActivity()
        Array activity logs for task
        Returns:
        activity

      • setActivity

        public void setActivity​(java.util.List<ArrayActivityLog> activity)

      • logs

        public ArrayTask logs​(java.lang.String logs)

      • getLogs

        @Nullable
public java.lang.String getLogs()
        logs from array task
        Returns:
        logs

      • setLogs

        public void setLogs​(java.lang.String logs)

      • duration

        public ArrayTask duration​(java.math.BigDecimal duration)

      • getDuration

        @Nullable
public java.math.BigDecimal getDuration()
        duration in nanoseconds of an array task
        Returns:
        duration

      • setDuration

        public void setDuration​(java.math.BigDecimal duration)

      • sqlInitCommands

        public ArrayTask sqlInitCommands​(java.util.List<java.lang.String> sqlInitCommands)

      • addSqlInitCommandsItem

        public ArrayTask addSqlInitCommandsItem​(java.lang.String sqlInitCommandsItem)

      • getSqlInitCommands

        @Nullable
public java.util.List<java.lang.String> getSqlInitCommands()
        SQL queries or commands to run before main sql query
        Returns:
        sqlInitCommands

      • setSqlInitCommands

        public void setSqlInitCommands​(java.util.List<java.lang.String> sqlInitCommands)

      • sqlParameters

        public ArrayTask sqlParameters​(java.util.List<java.lang.Object> sqlParameters)

      • addSqlParametersItem

        public ArrayTask addSqlParametersItem​(java.lang.Object sqlParametersItem)

      • getSqlParameters

        @Nullable
public java.util.List<java.lang.Object> getSqlParameters()
        SQL query parameters
        Returns:
        sqlParameters

      • setSqlParameters

        public void setSqlParameters​(java.util.List<java.lang.Object> sqlParameters)

      • getResultFormat

        @Nullable
public ResultFormat getResultFormat()
        Get resultFormat
        Returns:
        resultFormat

      • setResultFormat

        public void setResultFormat​(ResultFormat resultFormat)

      • taskGraphUuid

        public ArrayTask taskGraphUuid​(java.lang.String taskGraphUuid)

      • getTaskGraphUuid

        @Nullable
public java.lang.String getTaskGraphUuid()
        If set, the ID of the log for the task graph that this was part of.
        Returns:
        taskGraphUuid

      • setTaskGraphUuid

        public void setTaskGraphUuid​(java.lang.String taskGraphUuid)

      • clientNodeUuid

        public ArrayTask clientNodeUuid​(java.lang.String clientNodeUuid)

      • getClientNodeUuid

        @Nullable
public java.lang.String getClientNodeUuid()
        If set, the client-defined ID of the node within this task's graph.
        Returns:
        clientNodeUuid

      • setClientNodeUuid

        public void setClientNodeUuid​(java.lang.String clientNodeUuid)

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • validateJsonObject

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                               throws java.io.IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        java.io.IOException - if the JSON Object is invalid with respect to ArrayTask

      • fromJson

        public static ArrayTask fromJson​(java.lang.String jsonString)
                          throws java.io.IOException
        Create an instance of ArrayTask given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of ArrayTask
        Throws:
        java.io.IOException - if the JSON string is invalid with respect to ArrayTask

      • toJson

        public java.lang.String toJson()
        Convert an instance of ArrayTask to an JSON string
        Returns:
        JSON string