google.longrunning 패키지

색인

Operations(인터페이스)
GetOperationRequest(메시지)
ListOperationsRequest(메시지)
ListOperationsResponse(메시지)
Operation(메시지)

운영

API 서비스를 통해 장기 실행 작업을 관리합니다.

API 메서드가 완료되는 데 일반적으로 시간이 오래 걸리는 경우 클라이언트에 Operation을 반환하도록 설계할 수 있습니다. 그러면 클라이언트는 이 인터페이스를 통해 작업 리소스를 폴링하여 실제 응답을 비동기식으로 수신하거나, 작업 리소스를 Google Cloud Pub/Sub API 등의 다른 API에 전달하여 응답을 수신할 수 있습니다. 장기 실행 작업을 반환하는 API 서비스는 Operations 인터페이스를 구현하여 개발자에게 일관적인 클라이언트 경험을 제공해야 합니다.

GetOperation

GetOperation
`rpc GetOperation(GetOperationRequest) returns (Operation)` 장기 실행 작업의 최신 상태를 가져옵니다. 클라이언트는 이 메소드를 사용하여 API 서비스가 권장하는 간격으로 작업 결과를 폴링할 수 있습니다. 승인 범위 다음 OAuth 범위 중 하나가 필요합니다. `https://www.googleapis.com/auth/cloud-healthcare` `https://www.googleapis.com/auth/cloud-platform` 자세한 내용은 인증 개요를 참조하세요.

rpc GetOperation(GetOperationRequest) returns (Operation)

장기 실행 작업의 최신 상태를 가져옵니다. 클라이언트는 이 메소드를 사용하여 API 서비스가 권장하는 간격으로 작업 결과를 폴링할 수 있습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

https://www.googleapis.com/auth/cloud-healthcare
https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

ListOperations

ListOperations
`rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)` 요청에 지정된 필터와 일치하는 작업을 나열합니다. 서버에서 이 메서드를 지원하지 않는 경우 `UNIMPLEMENTED`가 반환됩니다. 참고: API 서비스는 `name` 바인딩을 재정의하여 `users//operations` 등의 다른 리소스 이름 스키마를 사용할 수 있습니다. API 서비스에서 바인딩을 재정의하려면 해당 서비스 구성에 `"/v1/{name=users/}/operations"` 등의 바인딩을 추가합니다. 이전 버전과의 호환성을 위해 기본 이름에 작업 컬렉션 ID가 포함되지만, 재정의하는 사용자는 이름 바인딩이 작업 컬렉션 ID가 없는 상위 리소스인지 확인해야 합니다. 승인 범위 다음 OAuth 범위 중 하나가 필요합니다. `https://www.googleapis.com/auth/cloud-healthcare` `https://www.googleapis.com/auth/cloud-platform` 자세한 내용은 인증 개요를 참조하세요.

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

요청에 지정된 필터와 일치하는 작업을 나열합니다. 서버에서 이 메서드를 지원하지 않는 경우 UNIMPLEMENTED가 반환됩니다.

참고: API 서비스는 name 바인딩을 재정의하여 users/*/operations 등의 다른 리소스 이름 스키마를 사용할 수 있습니다. API 서비스에서 바인딩을 재정의하려면 해당 서비스 구성에 "/v1/{name=users/*}/operations" 등의 바인딩을 추가합니다. 이전 버전과의 호환성을 위해 기본 이름에 작업 컬렉션 ID가 포함되지만, 재정의하는 사용자는 이름 바인딩이 작업 컬렉션 ID가 없는 상위 리소스인지 확인해야 합니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

https://www.googleapis.com/auth/cloud-healthcare
https://www.googleapis.com/auth/cloud-platform

자세한 내용은 인증 개요를 참조하세요.

GetOperationRequest

Operations.GetOperation의 요청 메시지입니다.

필드

필드
`name`	`string` 작업 리소스의 이름입니다.

name

string

작업 리소스의 이름입니다.

ListOperationsRequest

Operations.ListOperations의 요청 메시지입니다.

필드
`name`	`string` 작업의 상위 리소스 이름입니다.
`filter`	`string` 표준 목록 필터입니다.
`page_size`	`int32` 표준 목록 페이지 크기입니다.
`page_token`	`string` 표준 목록 페이지 토큰입니다.

ListOperationsResponse

Operations.ListOperations의 응답 메시지입니다.

필드

필드
`operations[]`	`Operation` 요청에 지정된 필터와 일치하는 작업 목록입니다.
`next_page_token`	`string` 표준 목록 다음 페이지 토큰입니다.

operations[]

Operation

요청에 지정된 필터와 일치하는 작업 목록입니다.

next_page_token

string

표준 목록 다음 페이지 토큰입니다.

Operation

이 리소스는 네트워크 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`입니다.