rpc CancelOperation(CancelOperationRequest) returns (Empty)

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returnsgoogle.rpc.Code.UNIMPLEMENTED. Clients can useOperations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with anOperation.error value with agoogle.rpc.Status.code of1, corresponding toCode.CANCELLED.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see theAuthentication Overview.

rpc GetOperation(GetOperationRequest) returns (Operation)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see theAuthentication Overview.

IAM Permissions

Requires the followingIAM permission on thename resource:

• discoveryengine.operations.get

For more information, see theIAM documentation.

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returnsUNIMPLEMENTED.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see theAuthentication Overview.

IAM Permissions

Requires the followingIAM permission on thename resource:

• discoveryengine.operations.list

For more information, see theIAM documentation.

string

The name of the operation resource to be cancelled.

string

The name of the operation resource.

string

The name of the operation's parent resource.

string

The standard list filter.

int32

The standard list page size.

string

The standard list page token.

bool

When set totrue, operations that are reachable are returned as normal, and those that are unreachable are returned in theListOperationsResponse.unreachable field.

This can only betrue when reading across collections. For example, whenparent is set to"projects/example/locations/-".

This field is not supported by default and will result in anUNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.

Operation

A list of operations that matches the specified filter in the request.

string

The standard List next-page token.

string

Unordered list. Unreachable resources. Populated when the request setsListOperationsRequest.return_partial_success and reads across collections. For example, when attempting to list all resources across all supported locations.

string

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, thename should be a resource name ending withoperations/{unique_id}.

Any

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

bool

If the value isfalse, it means the operation is still in progress. Iftrue, the operation is completed, and eithererror orresponse is available.

Status

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

Any

The normal, successful response of the operation. If the original method returns no data on success, such asDelete, the response isgoogle.protobuf.Empty. If the original method is standardGet/Create/Update, the response should be the resource. For other methods, the response should have the typeXxxResponse, whereXxx is the original method name. For example, if the original method name isTakeSnapshot(), the inferred response type isTakeSnapshotResponse.