자원: 작업
이 리소스는 네트워크 API 호출의 결과인 장기 실행 작업을 나타냅니다.
JSON 표현 |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
필드 | |
---|---|
name | 원래 반환한 동일한 서비스 내에서만 고유한 서버 할당 이름입니다. 기본 HTTP 매핑을 사용하는 경우 |
metadata | 작업과 관련된 서비스별 메타데이터입니다. 일반적으로 진행 정보와 생성 시간과 같은 일반적인 메타데이터가 포함됩니다. 일부 서비스는 이러한 메타데이터를 제공하지 않을 수 있습니다. 장기 실행 작업을 반환하는 모든 메서드는 메타데이터 유형(있는 경우)을 문서화해야 합니다. 임의 유형의 필드를 포함하는 객체입니다. 추가 필드 |
done | 값이 |
Union 필드 result . error 또는 유효한 response 일 수 있는 작업 결과입니다. done == false 인 경우 error response 모두 설정되지 않습니다. done == true 인 경우 error 또는 response 중 정확히 하나만 설정될 수 있습니다. 일부 서비스에서는 결과를 제공하지 못할 수도 있습니다. result 다음 중 하나만 가능합니다. | |
error | 실패 또는 취소 시 작업의 오류 결과입니다. |
response | 성공 시 작업의 정상적인 응답입니다. 원래 메소드가 성공 시 데이터를 반환하지 않는 경우(예: 임의 유형의 필드를 포함하는 객체입니다. 추가 필드 |
상태
Status
유형은 REST API 및 RPC API를 포함한 다양한 프로그래밍 환경에 적합한 논리적 오류 모델을 정의합니다. gRPC 에서 사용됩니다. 각 Status
메시지에는 오류 코드, 오류 메시지, 오류 세부정보라는 세 가지 데이터가 포함되어 있습니다.
API 디자인 가이드 에서 이 오류 모델과 이를 사용하는 방법에 대해 자세히 알아볼 수 있습니다.
JSON 표현 |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
필드 | |
---|---|
code | |
message | 개발자에게 표시되는 오류 메시지는 영어로 작성되어야 합니다. 사용자에게 표시되는 모든 오류 메시지는 현지화되어 |
details[] | 오류 세부정보를 전달하는 메시지 목록입니다. API에서 사용할 수 있는 공통 메시지 유형 세트가 있습니다. 임의 유형의 필드를 포함하는 객체입니다. 추가 필드 |
행동 양식 | |
---|---|
| 장기 실행 작업의 최신 상태를 가져옵니다. |