Package com.oracle.bmc.batch.requests

Class ListBatchJobTasksRequest

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20251031")
public class ListBatchJobTasksRequest
extends BmcRequest<Void>

    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.86.0/batch/ListBatchJobTasksExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBatchJobTasksRequest.

    • Constructor Detail

      • ListBatchJobTasksRequest

        public ListBatchJobTasksRequest()

    • Method Detail

      • getBatchJobId

        public String getBatchJobId()
        The OCID of the batch job.

      • getLifecycleState

        public BatchTask.LifecycleState getLifecycleState()
        A filter to return only resources that match the given lifecycle state.

        The state value is case-insensitive.

      • getName

        public String getName()
        The hierarchical name of the batch task.

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

      • getTaskId

        public String getTaskId()
        The UUID of the batch task.

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

      • getGroupTaskName

        public String getGroupTaskName()
        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.

      • getType

        public BatchTask.Type getType()
        Filter tasks by type.

        Valid values are: COMPUTE, GROUP.

      • getHierarchyView

        public BatchTaskHierarchyView getHierarchyView()
        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.

      • getLimit

        public Integer getLimit()
        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.

      • getPage

        public String getPage()
        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.

      • getSortOrder

        public SortOrder getSortOrder()
        The sort order to use, either ascending (ASC) or descending (DESC).

      • getSortBy

        public BatchTaskSortBy getSortBy()
        The field to sort by.

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

      • getOpcRequestId

        public String getOpcRequestId()
        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.

      • equals

        public boolean equals​(Object o)
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
        Overrides:
        equals in class BmcRequest<Void>

      • hashCode

        public int hashCode()
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to generate a hash.
        Overrides:
        hashCode in class BmcRequest<Void>