Operation
이 리소스는 네트워크 API 호출의 결과인 장기 실행 작업을 나타냅니다.
JSON 표현 |
{
"name": string,
"metadata": {
"@type": string,
field1: ...,
...
},
"done": boolean,
// Union field result can be only one of the following:
"error": {
object (Status )
},
"response": {
"@type": string,
field1: ...,
...
}
// End of list of possible types for union field result .
} |
필드 |
name |
string
서버에 할당된 이름으로, 해당 이름을 최초로 반환한 서비스 내에서만 고유합니다. 기본 HTTP 매핑을 사용하는 경우 name 은 operations/{unique_id} 로 끝나는 리소스 이름이어야 합니다.
|
metadata |
object
작업과 관련된 서비스별 메타데이터입니다. 일반적으로 진행률 정보 및 생성 시간과 같은 일반 메타데이터가 포함됩니다. 일부 서비스는 이러한 메타데이터를 제공하지 않을 수 있습니다. 장기 실행 작업을 반환하는 메소드는 메타데이터 유형이 있는 경우 이를 문서화해야 합니다. 임의 유형의 필드를 포함하는 객체입니다. 추가 필드 "@type" 은 유형을 식별하는 URI를 포함합니다. 예를 들면 { "id": 1234, "@type": "types.example.com/standard/id" } 입니다.
|
done |
boolean
값이 false 이면 작업이 아직 진행 중이라는 의미입니다. true 이면 작업이 완료된 것이며, error 또는 response 를 사용할 수 있습니다.
|
통합 필드 result 는 작업 결과로, error 또는 유효한 response 일 수 있습니다. done == false 이면 error 와 response 가 모두 설정되지 않습니다. done == true 이면 error 또는 response 중 정확히 하나만 설정할 수 있습니다. 일부 서비스는 결과를 제공하지 않을 수 있습니다. result 는 다음 중 하나여야 합니다. |
error |
object (Status )
실패하거나 취소된 작업의 오류 결과입니다.
|
response |
object
정상적인 성공한 작업 응답입니다. Delete 와 같이 원래 메서드가 성공 시 데이터를 반환하지 않는 경우 응답은 google.protobuf.Empty 입니다. 원래 메서드가 표준 Get /Create /Update 이면 응답은 리소스여야 합니다. 다른 메서드의 경우 응답은 XxxResponse 유형이어야 하며, 여기에서 Xxx 는 원래 메서드의 이름입니다. 예를 들어 원래 메서드 이름이 TakeSnapshot() 이면 추론된 응답 유형은 TakeSnapshotResponse 입니다. 임의 유형의 필드를 포함하는 객체입니다. 추가 필드 "@type" 은 유형을 식별하는 URI를 포함합니다. 예: { "id": 1234, "@type": "types.example.com/standard/id" }
|
달리 명시되지 않는 한 이 페이지의 콘텐츠에는 Creative Commons Attribution 4.0 라이선스에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책을 참조하세요. 자바는 Oracle 및/또는 Oracle 계열사의 등록 상표입니다.
최종 업데이트: 2024-09-10(UTC)
[null,null,["최종 업데이트: 2024-09-10(UTC)"],[[["This resource describes the JSON representation of a long-running operation initiated by a network API call."],["The representation includes fields for operation name (`name`), metadata (`metadata`), completion status (`done`), and result (`result`)."],["The `result` field provides either an error (`error`) or a response (`response`) based on the operation outcome."],["While the operation is in progress, `done` is `false` and neither `error` nor `response` are set; upon completion, `done` becomes `true` and either `error` or `response` is populated."]]],[]]