중요: 괄호 안에 나열된 URL에 액세스하려면 인터넷에 연결해야 합니다. URL은 오프라인 환경 외부에서 액세스할 수 있도록 제공됩니다.
작업
API 서비스를 통해 장기 실행 작업을 관리합니다.
API 메서드가 완료되는 데 일반적으로 시간이 오래 걸리는 경우 클라이언트에 Operation을 반환하도록 설계할 수 있습니다. 그러면 클라이언트는 이 인터페이스를 통해 작업 리소스를 폴링하여 실제 응답을 비동기식으로 수신하거나, 작업 리소스를 Google Cloud Pub/Sub API 등의 다른 API에 전달하여 응답을 수신할 수 있습니다. 장기 실행 작업을 반환하는 API 서비스는 Operations 인터페이스를 구현하여 개발자에게 일관적인 클라이언트 경험을 제공해야 합니다.
요청에 지정된 필터와 일치하는 작업을 나열합니다. 서버에서 이 메서드를 지원하지 않는 경우 UNIMPLEMENTED가 반환됩니다.
참고: API 서비스는 name 바인딩을 재정의하여 users/*/operations 등의 다른 리소스 이름 스키마를 사용할 수 있습니다. API 서비스에서 바인딩을 재정의하려면 해당 서비스 구성에 "/v1/{name=users/*}/operations" 등의 바인딩을 추가합니다. 이전 버전과의 호환성을 위해 기본 이름에 작업 컬렉션 ID가 포함되지만, 재정의하는 사용자는 이름 바인딩이 작업 컬렉션 ID가 없는 상위 리소스인지 확인해야 합니다.
서버에 할당된 이름으로, 해당 이름을 최초로 반환한 서비스 내에서만 고유합니다. 기본 HTTP 매핑을 사용하는 경우 name은 operations/{unique_id}로 끝나는 리소스 이름이어야 합니다.
metadata
Any (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any)
작업과 관련된 서비스별 메타데이터입니다. 일반적으로 진행률 정보 및 생성 시간과 같은 일반 메타데이터가 포함됩니다. 일부 서비스는 이러한 메타데이터를 제공하지 않을 수 있습니다. 장기 실행 작업을 반환하는 메서드는 메타데이터 유형이 있는 경우 이를 문서화해야 합니다.
done
bool
값이 false이면 작업이 아직 진행 중이라는 의미입니다. true이면 작업이 완료된 것이며, error 또는 response를 사용할 수 있습니다.
통합 필드 result는 작업 결과로, error 또는 유효한 response일 수 있습니다. done == false이면 error와 response가 모두 설정되지 않습니다. done == true이면 error 또는 response 중 정확히 하나를 설정할 수 있습니다. 일부 서비스는 결과를 제공하지 않을 수 있습니다. result는 다음 중 하나여야 합니다.
error
Status (/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/translation/rpc/google.rpc#google.rpc.Status)
실패하거나 취소된 작업의 오류 결과입니다.
response
Any (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any)
성공한 작업의 일반적인 응답입니다. Delete와 같이 원래 메서드가 성공 시 데이터를 반환하지 않는 경우 응답은 google.protobuf.Empty입니다. 원래 메서드가 표준 Get/Create/Update이면 응답은 리소스여야 합니다. 다른 메서드의 경우 응답은 XxxResponse 유형이어야 하며, 여기에서 Xxx는 원래 메서드의 이름입니다. 예를 들어 원래 메서드 이름이 TakeSnapshot()이면 추론된 응답 유형은 TakeSnapshotResponse입니다.
[[["이해하기 쉬움","easyToUnderstand","thumb-up"],["문제가 해결됨","solvedMyProblem","thumb-up"],["기타","otherUp","thumb-up"]],[["이해하기 어려움","hardToUnderstand","thumb-down"],["잘못된 정보 또는 샘플 코드","incorrectInformationOrSampleCode","thumb-down"],["필요한 정보/샘플이 없음","missingTheInformationSamplesINeed","thumb-down"],["번역 문제","translationIssue","thumb-down"],["기타","otherDown","thumb-down"]],["최종 업데이트: 2025-07-31(UTC)"],[[["\u003cp\u003eOperations manages long-running API tasks, allowing clients to receive asynchronous responses.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGetOperation\u003c/code\u003e method allows clients to check the status of an operation by polling at intervals suggested by the API service.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListOperations\u003c/code\u003e method enables clients to retrieve a list of operations based on specified filters.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eOperation\u003c/code\u003e resource includes fields for tracking an operation's name, metadata, status (\u003ccode\u003edone\u003c/code\u003e), and result (either an \u003ccode\u003eerror\u003c/code\u003e or a \u003ccode\u003eresponse\u003c/code\u003e).\u003c/p\u003e\n"]]],[],null,["# Package google.longrunning\n\nImportant: To access the URL listed within parentheses, you must connect to the internet. The URL is provided to access outside of your air-gapped environment.\n\nOperations\n----------\n\nManages long-running operations with an API service.\n\nWhen an API method normally takes long time to complete, it can be designed to return [Operation](/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/translation/rpc/google.longrunning#google.longrunning.Operation) to the client, and the client can use this interface to receive the real response asynchronously by polling the operation resource, or pass the operation resource to another API (such as Google Cloud Pub/Sub API) to receive the response. Any API service that returns long-running operations should implement the `Operations` interface so developers can have a consistent client experience.\n\nGetOperationRequest\n-------------------\n\nThe request message for [Operations.GetOperation](/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/translation/rpc/google.longrunning#google.longrunning.Operations.GetOperation).\n\nListOperationsRequest\n---------------------\n\nThe request message for [Operations.ListOperations](/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/translation/rpc/google.longrunning#google.longrunning.Operations.ListOperations).\n\nListOperationsResponse\n----------------------\n\nThe response message for [Operations.ListOperations](/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/translation/rpc/google.longrunning#google.longrunning.Operations.ListOperations).\n\nOperation\n---------\n\nThis resource represents a long-running operation that is the result of a network API call."]]
