Method: investigationSteps.list

Full name: projects.locations.instances.investigations.investigationSteps.list

investigationSteps.list is used to retrieve existing investigation steps for a given investigation.

HTTP request


Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of steps. Format: projects/{project}/locations/{location}/instances/{instance}/investigations/{investigation}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of steps to return. The service may return fewer than this value. If unspecified, at most 100 steps will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous investigationSteps.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to investigationSteps.list must match the call that provided the page token.
orderBy

string

Optional. Configures ordering of investigations in the response. If not specified, investigations are returned in descending order of their create time. The default ordering is by create time in descending order. The orderBy string is a comma separated list of fields. For example: "startTime desc, endTime" Supported fields: * startTime

Request body

The request body must be empty.

Response body

Response message for investigationSteps.list method.

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

JSON representation 
{
  "investigationSteps": [
    {
      object (InvestigationStep)
    }
  ],
  "nextPageToken": string
}
Fields
investigationSteps[]

object (InvestigationStep)

The investigation steps from the specified investigation.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.