// Copyright 2025 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // @generated by protoc-gen-es v1.10.0 // @generated from file google/longrunning/operations.proto (package google.longrunning, syntax proto3) /* eslint-disable */ // @ts-nocheck import type { Any, BinaryReadOptions, Duration, Extension, FieldList, JsonReadOptions, JsonValue, MethodOptions, PartialMessage, PlainMessage } from "@bufbuild/protobuf"; import { Message, proto3 } from "@bufbuild/protobuf"; import type { Status } from "../rpc/status_pb.js"; /** * This resource represents a long-running operation that is the result of a * network API call. * * @generated from message google.longrunning.Operation */ export declare class Operation extends Message { /** * The server-assigned name, which is only unique within the same service that * originally returns it. If you use the default HTTP mapping, the * `name` should be a resource name ending with `operations/{unique_id}`. * * @generated from field: string name = 1; */ name: string; /** * 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. * * @generated from field: google.protobuf.Any metadata = 2; */ metadata?: Any; /** * 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. * * @generated from field: bool done = 3; */ done: boolean; /** * The operation result, which can be either an `error` or a valid `response`. * If `done` == `false`, neither `error` nor `response` is set. * If `done` == `true`, exactly one of `error` or `response` can be set. * Some services might not provide the result. * * @generated from oneof google.longrunning.Operation.result */ result: { /** * The error result of the operation in case of failure or cancellation. * * @generated from field: google.rpc.Status error = 4; */ value: Status; case: "error"; } | { /** * The normal, successful response of the operation. If the original * method returns no data on success, such as `Delete`, the response is * `google.protobuf.Empty`. If the original method is standard * `Get`/`Create`/`Update`, the response should be the resource. For other * methods, the response should have the type `XxxResponse`, where `Xxx` * is the original method name. For example, if the original method name * is `TakeSnapshot()`, the inferred response type is * `TakeSnapshotResponse`. * * @generated from field: google.protobuf.Any response = 5; */ value: Any; case: "response"; } | { case: undefined; value?: undefined }; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "google.longrunning.Operation"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): Operation; static fromJson(jsonValue: JsonValue, options?: Partial): Operation; static fromJsonString(jsonString: string, options?: Partial): Operation; static equals(a: Operation | PlainMessage | undefined, b: Operation | PlainMessage | undefined): boolean; } /** * The request message for * [Operations.GetOperation][google.longrunning.Operations.GetOperation]. * * @generated from message google.longrunning.GetOperationRequest */ export declare class GetOperationRequest extends Message { /** * The name of the operation resource. * * @generated from field: string name = 1; */ name: string; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "google.longrunning.GetOperationRequest"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): GetOperationRequest; static fromJson(jsonValue: JsonValue, options?: Partial): GetOperationRequest; static fromJsonString(jsonString: string, options?: Partial): GetOperationRequest; static equals(a: GetOperationRequest | PlainMessage | undefined, b: GetOperationRequest | PlainMessage | undefined): boolean; } /** * The request message for * [Operations.ListOperations][google.longrunning.Operations.ListOperations]. * * @generated from message google.longrunning.ListOperationsRequest */ export declare class ListOperationsRequest extends Message { /** * The name of the operation's parent resource. * * @generated from field: string name = 4; */ name: string; /** * The standard list filter. * * @generated from field: string filter = 1; */ filter: string; /** * The standard list page size. * * @generated from field: int32 page_size = 2; */ pageSize: number; /** * The standard list page token. * * @generated from field: string page_token = 3; */ pageToken: string; /** * When set to `true`, operations that are reachable are returned as normal, * and those that are unreachable are returned in the * [ListOperationsResponse.unreachable] field. * * This can only be `true` when reading across collections e.g. when `parent` * is set to `"projects/example/locations/-"`. * * This field is not by default supported and will result in an * `UNIMPLEMENTED` error if set unless explicitly documented otherwise in * service or product specific documentation. * * @generated from field: bool return_partial_success = 5; */ returnPartialSuccess: boolean; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "google.longrunning.ListOperationsRequest"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): ListOperationsRequest; static fromJson(jsonValue: JsonValue, options?: Partial): ListOperationsRequest; static fromJsonString(jsonString: string, options?: Partial): ListOperationsRequest; static equals(a: ListOperationsRequest | PlainMessage | undefined, b: ListOperationsRequest | PlainMessage | undefined): boolean; } /** * The response message for * [Operations.ListOperations][google.longrunning.Operations.ListOperations]. * * @generated from message google.longrunning.ListOperationsResponse */ export declare class ListOperationsResponse extends Message { /** * A list of operations that matches the specified filter in the request. * * @generated from field: repeated google.longrunning.Operation operations = 1; */ operations: Operation[]; /** * The standard List next-page token. * * @generated from field: string next_page_token = 2; */ nextPageToken: string; /** * Unordered list. Unreachable resources. Populated when the request sets * `ListOperationsRequest.return_partial_success` and reads across * collections e.g. when attempting to list all resources across all supported * locations. * * @generated from field: repeated string unreachable = 3; */ unreachable: string[]; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "google.longrunning.ListOperationsResponse"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): ListOperationsResponse; static fromJson(jsonValue: JsonValue, options?: Partial): ListOperationsResponse; static fromJsonString(jsonString: string, options?: Partial): ListOperationsResponse; static equals(a: ListOperationsResponse | PlainMessage | undefined, b: ListOperationsResponse | PlainMessage | undefined): boolean; } /** * The request message for * [Operations.CancelOperation][google.longrunning.Operations.CancelOperation]. * * @generated from message google.longrunning.CancelOperationRequest */ export declare class CancelOperationRequest extends Message { /** * The name of the operation resource to be cancelled. * * @generated from field: string name = 1; */ name: string; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "google.longrunning.CancelOperationRequest"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): CancelOperationRequest; static fromJson(jsonValue: JsonValue, options?: Partial): CancelOperationRequest; static fromJsonString(jsonString: string, options?: Partial): CancelOperationRequest; static equals(a: CancelOperationRequest | PlainMessage | undefined, b: CancelOperationRequest | PlainMessage | undefined): boolean; } /** * The request message for * [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation]. * * @generated from message google.longrunning.DeleteOperationRequest */ export declare class DeleteOperationRequest extends Message { /** * The name of the operation resource to be deleted. * * @generated from field: string name = 1; */ name: string; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "google.longrunning.DeleteOperationRequest"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): DeleteOperationRequest; static fromJson(jsonValue: JsonValue, options?: Partial): DeleteOperationRequest; static fromJsonString(jsonString: string, options?: Partial): DeleteOperationRequest; static equals(a: DeleteOperationRequest | PlainMessage | undefined, b: DeleteOperationRequest | PlainMessage | undefined): boolean; } /** * The request message for * [Operations.WaitOperation][google.longrunning.Operations.WaitOperation]. * * @generated from message google.longrunning.WaitOperationRequest */ export declare class WaitOperationRequest extends Message { /** * The name of the operation resource to wait on. * * @generated from field: string name = 1; */ name: string; /** * The maximum duration to wait before timing out. If left blank, the wait * will be at most the time permitted by the underlying HTTP/RPC protocol. * If RPC context deadline is also specified, the shorter one will be used. * * @generated from field: google.protobuf.Duration timeout = 2; */ timeout?: Duration; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "google.longrunning.WaitOperationRequest"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): WaitOperationRequest; static fromJson(jsonValue: JsonValue, options?: Partial): WaitOperationRequest; static fromJsonString(jsonString: string, options?: Partial): WaitOperationRequest; static equals(a: WaitOperationRequest | PlainMessage | undefined, b: WaitOperationRequest | PlainMessage | undefined): boolean; } /** * A message representing the message types used by a long-running operation. * * Example: * * rpc Export(ExportRequest) returns (google.longrunning.Operation) { * option (google.longrunning.operation_info) = { * response_type: "ExportResponse" * metadata_type: "ExportMetadata" * }; * } * * @generated from message google.longrunning.OperationInfo */ export declare class OperationInfo extends Message { /** * Required. The message name of the primary return type for this * long-running operation. * This type will be used to deserialize the LRO's response. * * If the response is in a different package from the rpc, a fully-qualified * message name must be used (e.g. `google.protobuf.Struct`). * * Note: Altering this value constitutes a breaking change. * * @generated from field: string response_type = 1; */ responseType: string; /** * Required. The message name of the metadata type for this long-running * operation. * * If the response is in a different package from the rpc, a fully-qualified * message name must be used (e.g. `google.protobuf.Struct`). * * Note: Altering this value constitutes a breaking change. * * @generated from field: string metadata_type = 2; */ metadataType: string; constructor(data?: PartialMessage); static readonly runtime: typeof proto3; static readonly typeName = "google.longrunning.OperationInfo"; static readonly fields: FieldList; static fromBinary(bytes: Uint8Array, options?: Partial): OperationInfo; static fromJson(jsonValue: JsonValue, options?: Partial): OperationInfo; static fromJsonString(jsonString: string, options?: Partial): OperationInfo; static equals(a: OperationInfo | PlainMessage | undefined, b: OperationInfo | PlainMessage | undefined): boolean; } /** * Additional information regarding long-running operations. * In particular, this specifies the types that are returned from * long-running operations. * * Required for methods that return `google.longrunning.Operation`; invalid * otherwise. * * @generated from extension: google.longrunning.OperationInfo operation_info = 1049; */ export declare const operation_info: Extension;