Contact UsGet started

Virtual Private Cloud API, gRPC: PrivateEndpointService.ListOperations

Written by
Updated at October 17, 2024

List operations for the specified private endpoint.

gRPC request

rpc ListOperations (ListPrivateEndpointOperationsRequest) returns (ListPrivateEndpointOperationsResponse)

ListPrivateEndpointOperationsRequest

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

Field

Description

privateEndpointId

string

Required field. ID of the private endpoint to list operations for.

To get a private endpoint ID make a PrivateEndpointService.List request.

pageSize

int64

The maximum number of results per page to return. If the number of
available results is larger than pageSize, the service returns a
ListPrivateEndpointOperationsResponse.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 pageToken to the
ListPrivateEndpointOperationsResponse.nextPageToken returned by a
previous list request.

ListPrivateEndpointOperationsResponse

{
  "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 private endpoint.

nextPageToken

string

Token for getting the next page of the list. If the number of results is
greater than the specified
ListPrivateEndpointOperationsRequest.pageSize, use next_page_token as
the value for the ListPrivateEndpointOperationsRequest.pageToken
parameter in the next list request.

Each subsequent page 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
Audit Trails events