Method: operations.listOperations
Stay organized with collections
Save and categorize content based on your preferences.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
HTTP request
POST https://optimization.googleapis.com/v1/{name=projects/*}/operations
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
The name of the operation's parent resource.
|
Query parameters
| Parameters |
filter |
string
The standard list filter.
|
pageSize |
integer
The standard list page size.
|
pageToken |
string
The standard list page token.
|
Request body
The request body must be empty.
Response body
The response message for Operations.ListOperations.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"operations": [
{
object (Operation)
}
],
"nextPageToken": string
} |
| Fields |
operations[] |
object (Operation)
A list of operations that matches the specified filter in the request.
|
nextPageToken |
string
The standard List next-page token.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-15 UTC.
[null,null,["Last updated 2024-11-15 UTC."],[[["\u003cp\u003eLists Optimization AI operations based on a specified filter.\u003c/p\u003e\n"],["\u003cp\u003eUses standard list parameters like \u003ccode\u003efilter\u003c/code\u003e, \u003ccode\u003epageSize\u003c/code\u003e, and \u003ccode\u003epageToken\u003c/code\u003e for querying.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of operations matching the filter and a token for retrieving subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eEmploys gRPC Transcoding for the request URL structure.\u003c/p\u003e\n"],["\u003cp\u003eRequires an empty request body and provides structured JSON response containing operation details.\u003c/p\u003e\n"]]],["The provided content outlines an API operation for listing operations. A `POST` request is made to a specific URL, defined by a `name` path parameter. The request can use `filter`, `pageSize`, and `pageToken` query parameters. The request body must be empty. A successful response returns a JSON object containing a list of matching operations and a `nextPageToken` for pagination, with the operations described by `operations[]`. If the server does not support the request it returns `UNIMPLEMENTED`.\n"],null,["# Method: operations.listOperations\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListOperationsResponse.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.\n\n### HTTP request\n\n`POST https://optimization.googleapis.com/v1/{name=projects/*}/operations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-------------------------------------------------------|\n| `name` | `string` The name of the operation's parent resource. |\n\n### Query parameters\n\n| Parameters ||\n|---------------|----------------------------------------|\n| `filter` | `string` The standard list filter. |\n| `page``Size` | `integer` The standard list page size. |\n| `page``Token` | `string` The standard list page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response message for [Operations.ListOperations](/optimization/service/reference/rest/v1/operations/listOperations#google.longrunning.Operations.ListOperations).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"operations\": [ { object (/optimization/service/reference/rest/v1/operations#Operation) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `operations[]` | `object (`[Operation](/optimization/service/reference/rest/v1/operations#Operation)`)` A list of operations that matches the specified filter in the request. |\n| `next``Page``Token` | `string` The standard List next-page token. |"]]
