색인
Operations
(인터페이스)CancelOperationRequest
(메시지)DeleteOperationRequest
(메시지)GetOperationRequest
(메시지)ListOperationsRequest
(메시지)ListOperationsResponse
(메시지)Operation
(메시지)WaitOperationRequest
(메시지)
운영
API 서비스를 통해 장기 실행 작업을 관리합니다.
API 메서드가 완료되는 데 일반적으로 시간이 오래 걸리는 경우 클라이언트에 Operation
을 반환하도록 설계할 수 있습니다. 그러면 클라이언트는 이 인터페이스를 통해 작업 리소스를 폴링하여 실제 응답을 비동기식으로 수신하거나, 작업 리소스를 Pub/Sub API 등의 다른 API에 전달하여 응답을 수신할 수 있습니다. 장기 실행 작업을 반환하는 API 서비스는 Operations
인터페이스를 구현하여 개발자에게 일관적인 클라이언트 경험을 제공해야 합니다.
CancelOperation |
---|
장기 실행 작업에 대한 비동기 취소를 시작합니다. 서버는 작업이 취소되도록 최선을 다하지만 성공한다고 보장되지 않습니다. 서버에서 이 메서드를 지원하지 않으면
|
DeleteOperation |
---|
장기 실행 작업을 삭제합니다. 이 메소드는 클라이언트가 작업 결과에 더 이상 관심이 없음을 나타냅니다. 작업을 취소하지는 않습니다. 서버에서 이 메서드를 지원하지 않으면
|
GetOperation |
---|
장기 실행 작업의 최신 상태를 가져옵니다. 클라이언트는 이 메서드를 사용하여 API 서비스가 권장하는 간격으로 작업 결과를 폴링할 수 있습니다.
|
ListOperations |
---|
요청 시 지정된 필터와 일치하는 작업을 나열합니다. 서버에서 이 메서드를 지원하지 않으면
|
WaitOperation |
---|
지정된 장기 실행 작업이 완료되거나 지정된 최대 제한 시간에 도달할 때까지 기다렸다가 최신 상태를 반환합니다. 작업이 이미 완료된 경우 최신 상태가 즉시 반환됩니다. 지정된 제한시간이 기본 HTTP/RPC 제한시간보다 길면 HTTP/RPC 제한시간이 사용됩니다. 서버에서 이 메서드를 지원하지 않으면
|
CancelOperationRequest
Operations.CancelOperation
의 요청 메시지입니다.
필드 | |
---|---|
name |
취소할 작업 리소스의 이름입니다. |
DeleteOperationRequest
Operations.DeleteOperation
의 요청 메시지입니다.
필드 | |
---|---|
name |
삭제할 작업 리소스의 이름입니다. |
GetOperationRequest
Operations.GetOperation
의 요청 메시지입니다.
필드 | |
---|---|
name |
작업 리소스의 이름입니다. |
ListOperationsRequest
Operations.ListOperations
의 요청 메시지입니다.
필드 | |
---|---|
name |
작업의 상위 리소스 이름입니다. |
filter |
표준 목록 필터입니다. |
page_size |
표준 목록 페이지 크기입니다. |
page_token |
표준 목록 페이지 토큰입니다. |
ListOperationsResponse
Operations.ListOperations
의 응답 메시지입니다.
필드 | |
---|---|
operations[] |
요청에 지정된 필터와 일치하는 작업 목록입니다. |
next_page_token |
표준 목록 다음 페이지 토큰입니다. |
Operation
이 리소스는 네트워크 API 호출의 결과인 장기 실행 작업을 나타냅니다.
필드 | |
---|---|
name |
서버에 할당된 이름으로, 해당 이름을 최초로 반환한 서비스 내에서만 고유합니다. 기본 HTTP 매핑을 사용하는 경우 |
metadata |
작업과 관련된 서비스별 메타데이터입니다. 일반적으로 진행률 정보 및 생성 시간과 같은 일반 메타데이터가 포함됩니다. 일부 서비스는 이러한 메타데이터를 제공하지 않을 수 있습니다. 장기 실행 작업을 반환하는 메서드는 메타데이터 유형이 있는 경우 이를 문서화해야 합니다. |
done |
값이 |
통합 필드 result 는 작업 결과로, error 또는 유효한 response 일 수 있습니다. done == false 이면 error 와 response 가 모두 설정되지 않습니다. done == true 이면 error 또는 response 중 정확히 하나를 설정할 수 있습니다. 일부 서비스는 결과를 제공하지 않을 수 있습니다. result 는 다음 중 하나여야 합니다. |
|
error |
실패하거나 취소된 작업의 오류 결과입니다. |
response |
정상적인 성공한 작업 응답입니다. |
WaitOperationRequest
Operations.WaitOperation
의 요청 메시지입니다.
필드 | |
---|---|
name |
대기할 작업 리소스의 이름입니다. |
timeout |
제한시간이 되기 전에 기다릴 최대 시간입니다. 비워 두면 기본값인 HTTP/RPC 프로토콜에서 허용하는 최대 시간 동안 기다립니다. RPC 환경설정 기한도 지정되어 있는 경우, 더 짧은 시간이 사용됩니다. |