searchSteps method

Future<SearchStepsResponse> searchSteps({ required String farmId, required int itemOffset, required List<String> queueIds, SearchGroupedFilterExpressions? filterExpressions, String? jobId, int? pageSize, List<SearchSortExpression>? sortExpressions, })

Searches for steps.

May throw AccessDeniedException. May throw InternalServerErrorException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter farmId : The farm ID to use for the step search.

Parameter itemOffset : The offset for the search results.

Parameter queueIds : The queue IDs in the step search.

Parameter filterExpressions : The search terms for a resource.

Parameter jobId : The job ID to use in the step search.

Parameter pageSize : Specifies the number of results to return.

Parameter sortExpressions : The search terms for a resource.

Implementation

Future<SearchStepsResponse> searchSteps({
  required String farmId,
  required int itemOffset,
  required List<String> queueIds,
  SearchGroupedFilterExpressions? filterExpressions,
  String? jobId,
  int? pageSize,
  List<SearchSortExpression>? sortExpressions,
}) async {
  final $payload = <String, dynamic>{
    'itemOffset': itemOffset,
    'queueIds': queueIds,
    if (filterExpressions != null) 'filterExpressions': filterExpressions,
    if (jobId != null) 'jobId': jobId,
    if (pageSize != null) 'pageSize': pageSize,
    if (sortExpressions != null) 'sortExpressions': sortExpressions,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri:
        '/2023-10-12/farms/${Uri.encodeComponent(farmId)}/search/steps',
    exceptionFnMap: _exceptionFns,
  );
  return SearchStepsResponse.fromJson(response);
}