DeadlineCloud / Client / search_tasks

search_tasks#

DeadlineCloud.Client.search_tasks(**kwargs)#

Searches for tasks.

See also: AWS API Documentation

Request Syntax

response = client.search_tasks(
    farmId='string',
    queueIds=[
        'string',
    ],
    jobId='string',
    filterExpressions={
        'filters': [
            {
                'dateTimeFilter': {
                    'name': 'string',
                    'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
                    'dateTime': datetime(2015, 1, 1)
                },
                'parameterFilter': {
                    'name': 'string',
                    'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
                    'value': 'string'
                },
                'searchTermFilter': {
                    'searchTerm': 'string'
                },
                'stringFilter': {
                    'name': 'string',
                    'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
                    'value': 'string'
                },
                'groupFilter': {'... recursive ...'}
            },
        ],
        'operator': 'AND'|'OR'
    },
    sortExpressions=[
        {
            'userJobsFirst': {
                'userIdentityId': 'string'
            },
            'fieldSort': {
                'sortOrder': 'ASCENDING'|'DESCENDING',
                'name': 'string'
            },
            'parameterSort': {
                'sortOrder': 'ASCENDING'|'DESCENDING',
                'name': 'string'
            }
        },
    ],
    itemOffset=123,
    pageSize=123
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The farm ID of the task.

  • queueIds (list) –

    [REQUIRED]

    The queue IDs to include in the search.

    • (string) –

  • jobId (string) – The job ID for the task search.

  • filterExpressions (dict) –

    The filter expression, AND or OR, to use when searching among a group of search strings in a resource.

    You can use two groupings per search each within parenthesis ().

    • filters (list) – [REQUIRED]

      The filters to use for the search.

      • (dict) –

        The type of search filter to apply.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: dateTimeFilter, parameterFilter, searchTermFilter, stringFilter, groupFilter.

        • dateTimeFilter (dict) –

          Filters based on date and time.

          • name (string) – [REQUIRED]

            The name of the date-time field to filter on.

          • operator (string) – [REQUIRED]

            The type of comparison to use to filter the results.

          • dateTime (datetime) – [REQUIRED]

            The date and time.

        • parameterFilter (dict) –

          Filters by parameter.

          • name (string) – [REQUIRED]

            The name of the parameter to filter on.

          • operator (string) – [REQUIRED]

            The type of comparison to use to filter results.

          • value (string) – [REQUIRED]

            The parameter’s value.

        • searchTermFilter (dict) –

          Filters by a specified search term.

          • searchTerm (string) – [REQUIRED]

            The term to search for.

        • stringFilter (dict) –

          Filters by a string.

          • name (string) – [REQUIRED]

            The field name to search.

          • operator (string) – [REQUIRED]

            The type of comparison to use for this search.

          • value (string) – [REQUIRED]

            The string to search for.

        • groupFilter (dict) –

          Filters by group.

    • operator (string) – [REQUIRED]

      The operators to include in the search.

  • sortExpressions (list) –

    The search terms for a resource.

    • (dict) –

      The resources to search.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: userJobsFirst, fieldSort, parameterSort.

      • userJobsFirst (dict) –

        Options for sorting a particular user’s jobs first.

        • userIdentityId (string) – [REQUIRED]

          The user’s ID.

      • fieldSort (dict) –

        Options for sorting by a field.

        • sortOrder (string) – [REQUIRED]

          The sort order for the field.

        • name (string) – [REQUIRED]

          The name of the field.

      • parameterSort (dict) –

        Options for sorting by a parameter.

        • sortOrder (string) – [REQUIRED]

          The sort order for the parameter.

        • name (string) – [REQUIRED]

          The parameter name to sort by.

  • itemOffset (integer) –

    [REQUIRED]

    Defines how far into the scrollable list to start the return of results.

  • pageSize (integer) – Specifies the number of items per page for the resource.

Return type:

dict

Returns:

Response Syntax

{
    'tasks': [
        {
            'taskId': 'string',
            'stepId': 'string',
            'jobId': 'string',
            'queueId': 'string',
            'runStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
            'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
            'parameters': {
                'string': {
                    'int': 'string',
                    'float': 'string',
                    'string': 'string',
                    'path': 'string'
                }
            },
            'failureRetryCount': 123,
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1)
        },
    ],
    'nextItemOffset': 123,
    'totalResults': 123
}

Response Structure

  • (dict) –

    • tasks (list) –

      Tasks in the search.

      • (dict) –

        The details of a task search.

        • taskId (string) –

          The task ID.

        • stepId (string) –

          The step ID.

        • jobId (string) –

          The job ID.

        • queueId (string) –

          The queue ID.

        • runStatus (string) –

          The run status of the task.

        • targetRunStatus (string) –

          The run status that the task is being updated to.

        • parameters (dict) –

          The parameters to search for.

          • (string) –

            • (dict) –

              The data types for the task parameters.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: int, float, string, path. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • int (string) –

                A signed integer represented as a string.

              • float (string) –

                A double precision IEEE-754 floating point number represented as a string.

              • string (string) –

                A UTF-8 string.

              • path (string) –

                A file system path represented as a string.

        • failureRetryCount (integer) –

          The number of times that the task failed and was retried.

        • startedAt (datetime) –

          The date and time the resource started running.

        • endedAt (datetime) –

          The date and time the resource ended running.

    • nextItemOffset (integer) –

      The next incremental starting point after the defined itemOffset.

    • totalResults (integer) –

      The total number of results in the search.

Exceptions