Package com.oracle.bmc.batch.requests

Class ListBatchJobTasksRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • lifecycleState

        public ListBatchJobTasksRequest.Builder lifecycleState​(BatchTask.LifecycleState lifecycleState)
        A filter to return only resources that match the given lifecycle state.

        The state value is case-insensitive.

        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder instance

      • name

        public ListBatchJobTasksRequest.Builder name​(String name)
        The hierarchical name of the batch task.

        Mutually exclusive with the task id query parameter: you can’t pass both.

        Parameters:
        name - the value to set
        Returns:
        this builder instance

      • taskId

        public ListBatchJobTasksRequest.Builder taskId​(String taskId)
        The UUID of the batch task.

        Mutually exclusive with the task name and group task name query parameters: you can’t pass both.

        Parameters:
        taskId - the value to set
        Returns:
        this builder instance

      • groupTaskName

        public ListBatchJobTasksRequest.Builder groupTaskName​(String groupTaskName)
        Hierarchical name of the group task.

        A filter to return only tasks contained within the selected group task. Omit to return top-level tasks only. Can be combined with task name query parameter, in which case task name becomes a hierarchical name relative to the selected group task, e.g. ?groupTaskName=A.B&taskName=C.D is equal to ?taskName=A.B.C.D. Mutually exclusive with the task id query parameter: you can’t pass both.

        Parameters:
        groupTaskName - the value to set
        Returns:
        this builder instance

      • hierarchyView

        public ListBatchJobTasksRequest.Builder hierarchyView​(BatchTaskHierarchyView hierarchyView)
        Defines the hierarchical scope of the tasks to be returned.

        When set to SHALLOW, which is default, only tasks contained directly (non-recursively) within current hierarchy entry are returned. When set to DEEP, tasks contained within current hierarchy entry and all its descendants recursively are returned. The default hierarchy entry is root, i.e. batch job itself. To use a different hierarchy entry, provide the group task name as a query parameter. The specified group task becomes the entry point instead of the batch job.

        Parameters:
        hierarchyView - the value to set
        Returns:
        this builder instance

      • limit

        public ListBatchJobTasksRequest.Builder limit​(Integer limit)
        For list pagination.

        The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

        Parameters:
        limit - the value to set
        Returns:
        this builder instance

      • page

        public ListBatchJobTasksRequest.Builder page​(String page)
        For list pagination.

        The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

        Parameters:
        page - the value to set
        Returns:
        this builder instance

      • sortOrder

        public ListBatchJobTasksRequest.Builder sortOrder​(SortOrder sortOrder)
        The sort order to use, either ascending (ASC) or descending (DESC).
        Parameters:
        sortOrder - the value to set
        Returns:
        this builder instance

      • sortBy

        public ListBatchJobTasksRequest.Builder sortBy​(BatchTaskSortBy sortBy)
        The field to sort by.

        You can provide only one sort order. Default order for name is ascending.

        Parameters:
        sortBy - the value to set
        Returns:
        this builder instance

      • opcRequestId

        public ListBatchJobTasksRequest.Builder opcRequestId​(String opcRequestId)
        Unique Oracle-assigned identifier for the request.

        If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

        Parameters:
        opcRequestId - the value to set
        Returns:
        this builder instance

      • invocationCallback

        public ListBatchJobTasksRequest.Builder invocationCallback​(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
        Set the invocation callback for the request to be built.
        Parameters:
        invocationCallback - the invocation callback to be set for the request
        Returns:
        this builder instance

      • retryConfiguration

        public ListBatchJobTasksRequest.Builder retryConfiguration​(RetryConfiguration retryConfiguration)
        Set the retry configuration for the request to be built.
        Parameters:
        retryConfiguration - the retry configuration to be used for the request
        Returns:
        this builder instance