Package google.longrunning
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
عملیات
این منبع یک عملیات طولانی مدت را نشان می دهد که نتیجه تماس API شبکه است.
فیلدها |
---|
name | string نام اختصاص داده شده به سرور، که فقط در همان سرویسی که در ابتدا آن را برمی گرداند منحصر به فرد است. اگر از نگاشت پیشفرض HTTP استفاده میکنید، name باید یک نام منبع باشد که با operations/{unique_id} ختم میشود. |
metadata | Any
فراداده خاص سرویس مرتبط با عملیات. معمولاً حاوی اطلاعات پیشرفت و ابرداده های رایج مانند زمان ایجاد است. برخی از خدمات ممکن است چنین متادیتا را ارائه ندهند. هر روشی که عملیات طولانیمدت را برمیگرداند، در صورت وجود، باید نوع ابرداده را مستند کند. |
done | bool اگر مقدار false باشد، به این معنی است که عملیات هنوز در حال انجام است. اگر true ، عملیات تکمیل شده و error یا response در دسترس است. |
result میدان اتحادیه نتیجه عملیات، که می تواند یک error یا یک response معتبر باشد. اگر done == false ، نه error و نه response تنظیم می شود. اگر done == true ، دقیقاً یکی از error یا response تنظیم می شود. result می تواند تنها یکی از موارد زیر باشد: |
error | Status
نتیجه خطای عملیات در صورت خرابی یا لغو. |
response | Any
پاسخ طبیعی عملیات در صورت موفقیت. اگر روش اصلی هیچ دادهای را در مورد موفقیت بازگرداند، مانند Delete ، پاسخ google.protobuf.Empty است. اگر روش اصلی استاندارد Get / Create / Update باشد، پاسخ باید منبع باشد. برای روشهای دیگر، پاسخ باید دارای نوع XxxResponse باشد که Xxx نام روش اصلی است. به عنوان مثال، اگر نام متد اصلی TakeSnapshot() باشد، نوع پاسخ استنباط شده TakeSnapshotResponse است. |
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-24 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eThe \u003ccode\u003eOperation\u003c/code\u003e resource represents a long-running operation initiated by a network API call, containing details about its progress and outcome.\u003c/p\u003e\n"],["\u003cp\u003eOperations are identified by a unique \u003ccode\u003ename\u003c/code\u003e and can include service-specific \u003ccode\u003emetadata\u003c/code\u003e for progress tracking.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edone\u003c/code\u003e field indicates operation completion status, with \u003ccode\u003eerror\u003c/code\u003e or \u003ccode\u003eresponse\u003c/code\u003e providing details upon completion.\u003c/p\u003e\n"],["\u003cp\u003eThe operation's outcome is represented by either an \u003ccode\u003eerror\u003c/code\u003e object for failures or a \u003ccode\u003eresponse\u003c/code\u003e object for successes, depending on the original method's expected return type.\u003c/p\u003e\n"]]],["The `Operation` message represents a long-running network API call. It includes a server-assigned `name` and `metadata` for progress and details. The `done` field indicates if the operation is complete. The `result` field, a union, contains either an `error` status or a successful `response`. If `done` is false, both `error` and `response` are unset. If `done` is true, only one of the two fields will have a value.\n"],null,["# Package google.longrunning\n\nIndex\n-----\n\n- [Operation](/spectrum-access-system/reference/rpc/google.longrunning#google.longrunning.Operation) (message)\n\nOperation\n---------\n\nThis resource represents a long-running operation that is the result of a network API call.\n\n| Fields ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| `name` | `string` 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}`. |\n| `metadata` | [Any](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.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. |\n| `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. |\n| Union field `result`. 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` is set. `result` can be only one of the following: |||\n| `error` | [Status](/spectrum-access-system/reference/rpc/google.rpc#google.rpc.Status) The error result of the operation in case of failure or cancellation. |\n| `response` | [Any](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#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 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`. |"]]