Contact UsGet started

Audit Trails API, gRPC: TrailService.ListOperations

Written by
Updated at October 28, 2024

Lists operations for the specified trail.

gRPC request

rpc ListOperations (ListTrailOperationsRequest) returns (ListTrailOperationsResponse)

ListTrailOperationsRequest

{
  "trailId": "string",
  "pageSize": "int64",
  "pageToken": "string"
}

Field

Description

trailId

string

Required field. ID of the trail to get operations for.

pageSize

int64

The maximum number of results per page that should be returned. If the number of available
results is larger than page_size, the service returns a ListTrailOperationsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

pageToken

string

Page token. To get the next page of results, set page_token to the
[ListTrailOperationsRequest.next_page_token] returned by a previous list request.

ListTrailOperationsResponse

{
  "operations": [
    {
      "id": "string",
      "description": "string",
      "createdAt": "google.protobuf.Timestamp",
      "createdBy": "string",
      "modifiedAt": "google.protobuf.Timestamp",
      "done": "bool",
      "metadata": "google.protobuf.Any",
      // Includes only one of the fields `error`, `response`
      "error": "google.rpc.Status",
      "response": "google.protobuf.Any"
      // end of the list of possible fields
    }
  ],
  "nextPageToken": "string"
}

Field

Description

operations[]

Operation

List of operations for the specified trail.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than [ListTrailOperationsResponse.page_size], use the next_page_token as the value
for the [ListTrailOperationsResponse.page_token] query parameter in the next list request.
Each subsequent list request will have its own next_page_token to continue paging through the results.

Operation

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

google.protobuf.Any

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Any

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.
Previous
Delete
Next
ListAccessBindings