Method: operations.streamSearch

Full name: projects.locations.instances.operations.streamSearch

Streams the results of an in-progress search operation, or returns the final results of a completed operation.

HTTP request


Path parameters

Parameters
name

string

Required. The name of the operation resource to stream results from. Format: projects/{project}/locations/{location}/instances/{instance}/operations/{operation}

Query parameters

Parameters
eventIndexStart

integer

Optional. Event index to start from. If unset (or 0), entire result set will be returned.
eventIndexEnd

integer

Optional. Last event index.
pageRequest

boolean

Optional. For page request, trim the response to only include requested events.
sortAscending

boolean

Optional. Sort order for the results, default is descending, i.e., false.
sortColumn

string

Optional. Sort column name for the results, default is based on timestamp.

Request body

The request body must be empty.

Response body

The current state of a search operation.

For the types of metadata and response, see documentation for the method that created the operation.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "operation": {
    object (Operation)
  }
}
Fields
operation

object (Operation)

The current state of the operation, including the latest streaming response.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.operations.streamSearch

For more information, see the IAM documentation.