DeadlineCloud / Client / search_steps

search_steps#

DeadlineCloud.Client.search_steps(**kwargs)#

Searches for steps.

Request Syntax

response = client.search_steps(
    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 to use for the step search.
queueIds (list) –
[REQUIRED]

The queue IDs in the step search.
- (string) –
jobId (string) – The job ID to use in the step 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

{
    'steps': [
        {
            'stepId': 'string',
            'jobId': 'string',
            'queueId': 'string',
            'name': 'string',
            'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED',
            'lifecycleStatusMessage': 'string',
            'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
            'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
            'taskRunStatusCounts': {
                'string': 123
            },
            'createdAt': datetime(2015, 1, 1),
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'parameterSpace': {
                'parameters': [
                    {
                        'name': 'string',
                        'type': 'INT'|'FLOAT'|'STRING'|'PATH'
                    },
                ],
                'combination': 'string'
            }
        },
    ],
    'nextItemOffset': 123,
    'totalResults': 123
}

Response Structure

(dict) –
- steps (list) –
  
  The steps in the search.
  - (dict) –
    
    The details of a step search.
    - stepId (string) –
      
      The step ID.
    - jobId (string) –
      
      The job ID.
    - queueId (string) –
      
      The queue ID.
    - name (string) –
      
      The step name.
    - lifecycleStatus (string) –
      
      The life cycle status.
    - lifecycleStatusMessage (string) –
      
      The life cycle status message.
    - taskRunStatus (string) –
      
      The task run status for the job.
      - PENDING–pending and waiting for resources.
      - READY–ready to be processed.
      - ASSIGNED–assigned and will run next on a worker.
      - SCHEDULED–scheduled to be run on a worker.
      - INTERRUPTING–being interrupted.
      - RUNNING–running on a worker.
      - SUSPENDED–the task is suspended.
      - CANCELED–the task has been canceled.
      - FAILED–the task has failed.
      - SUCCEEDED–the task has succeeded.
    - targetTaskRunStatus (string) –
      
      The task status to start with on the job.
    - taskRunStatusCounts (dict) –
      
      The number of tasks running on the job.
      - (string) –
        
        (integer) –
    - createdAt (datetime) –
      
      The date and time the resource was created.
    - startedAt (datetime) –
      
      The date and time the resource started running.
    - endedAt (datetime) –
      
      The date and time the resource ended running.
    - parameterSpace (dict) –
      
      The parameters and combination expressions for the search.
      - parameters (list) –
        
        The parameters to search for.
        
        (dict) –
        
        The details of a step parameter.
        
        name (string) –
        
        The name of the parameter.
        
        type (string) –
        
        The data type of the parameter.
      - combination (string) –
        
        The combination expression to use in the search.
- nextItemOffset (integer) –
  
  The next incremental starting point after the defined itemOffset.
- totalResults (integer) –
  
  The total number of results in the search.

Exceptions

DeadlineCloud.Client.exceptions.AccessDeniedException
DeadlineCloud.Client.exceptions.InternalServerErrorException
DeadlineCloud.Client.exceptions.ResourceNotFoundException
DeadlineCloud.Client.exceptions.ThrottlingException
DeadlineCloud.Client.exceptions.ValidationException