list method

Future<GoogleCloudIntegrationsV1alphaListExecutionsResponse> list(
  1. String parent, {
  2. String? filter,
  3. String? filterParams_customFilter,
  4. String? filterParams_endTime,
  5. List<String>? filterParams_eventStatuses,
  6. String? filterParams_executionId,
  7. String? filterParams_parameterKey,
  8. String? filterParams_parameterPairKey,
  9. String? filterParams_parameterPairValue,
  10. String? filterParams_parameterType,
  11. String? filterParams_parameterValue,
  12. String? filterParams_startTime,
  13. List<String>? filterParams_taskStatuses,
  14. String? filterParams_workflowName,
  15. String? orderBy,
  16. int? pageSize,
  17. String? pageToken,
  18. String? readMask,
  19. bool? refreshAcl,
  20. bool? snapshotMetadataWithoutParams,
  21. bool? truncateParams,
  22. String? $fields,
})

Lists the results of all the integration executions.

The response includes the same information as the execution log in the Integration UI.

Request parameters:

parent - Required. The parent resource name of the integration execution. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/products/\[^/\]+/integrations/\[^/\]+$.

filter - Optional. Standard filter field, we support filtering on following fields: workflow_name: the name of the integration. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: "parameter_type" HAS "string" Also supports operators like AND, OR, NOT For example, trigger_id="id1" AND workflow_name="testWorkflow"

filterParams_customFilter - Optional user-provided custom filter.

filterParams_endTime - End timestamp.

filterParams_eventStatuses - List of possible event statuses.

filterParams_executionId - Execution id.

filterParams_parameterKey - Param key. DEPRECATED. User parameter_pair_key instead.

filterParams_parameterPairKey - Param key in the key value pair filter.

filterParams_parameterPairValue - Param value in the key value pair filter.

filterParams_parameterType - Param type.

filterParams_parameterValue - Param value. DEPRECATED. User parameter_pair_value instead.

filterParams_startTime - Start timestamp.

filterParams_taskStatuses - List of possible task statuses.

filterParams_workflowName - Workflow name.

orderBy - Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".

pageSize - Optional. The size of entries in the response.

pageToken - Optional. The token returned in the previous response.

readMask - Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.

refreshAcl - Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.

snapshotMetadataWithoutParams - Optional. If true, the service will provide execution info with snapshot metadata only i.e. without event parameters.

truncateParams - Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleCloudIntegrationsV1alphaListExecutionsResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleCloudIntegrationsV1alphaListExecutionsResponse> list(
  core.String parent, {
  core.String? filter,
  core.String? filterParams_customFilter,
  core.String? filterParams_endTime,
  core.List<core.String>? filterParams_eventStatuses,
  core.String? filterParams_executionId,
  core.String? filterParams_parameterKey,
  core.String? filterParams_parameterPairKey,
  core.String? filterParams_parameterPairValue,
  core.String? filterParams_parameterType,
  core.String? filterParams_parameterValue,
  core.String? filterParams_startTime,
  core.List<core.String>? filterParams_taskStatuses,
  core.String? filterParams_workflowName,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.String? readMask,
  core.bool? refreshAcl,
  core.bool? snapshotMetadataWithoutParams,
  core.bool? truncateParams,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (filterParams_customFilter != null)
      'filterParams.customFilter': [filterParams_customFilter],
    if (filterParams_endTime != null)
      'filterParams.endTime': [filterParams_endTime],
    if (filterParams_eventStatuses != null)
      'filterParams.eventStatuses': filterParams_eventStatuses,
    if (filterParams_executionId != null)
      'filterParams.executionId': [filterParams_executionId],
    if (filterParams_parameterKey != null)
      'filterParams.parameterKey': [filterParams_parameterKey],
    if (filterParams_parameterPairKey != null)
      'filterParams.parameterPairKey': [filterParams_parameterPairKey],
    if (filterParams_parameterPairValue != null)
      'filterParams.parameterPairValue': [filterParams_parameterPairValue],
    if (filterParams_parameterType != null)
      'filterParams.parameterType': [filterParams_parameterType],
    if (filterParams_parameterValue != null)
      'filterParams.parameterValue': [filterParams_parameterValue],
    if (filterParams_startTime != null)
      'filterParams.startTime': [filterParams_startTime],
    if (filterParams_taskStatuses != null)
      'filterParams.taskStatuses': filterParams_taskStatuses,
    if (filterParams_workflowName != null)
      'filterParams.workflowName': [filterParams_workflowName],
    if (orderBy != null) 'orderBy': [orderBy],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (readMask != null) 'readMask': [readMask],
    if (refreshAcl != null) 'refreshAcl': ['${refreshAcl}'],
    if (snapshotMetadataWithoutParams != null)
      'snapshotMetadataWithoutParams': ['${snapshotMetadataWithoutParams}'],
    if (truncateParams != null) 'truncateParams': ['${truncateParams}'],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/executions';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return GoogleCloudIntegrationsV1alphaListExecutionsResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}