Package google.longrunning

색인

운영

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

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

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

장기 실행 작업에 대한 비동기 취소를 시작합니다. 서버는 작업이 취소되도록 최선을 다하지만 성공한다고 보장되지 않습니다. 서버에서 이 메서드를 지원하지 않으면 google.rpc.Code.UNIMPLEMENTED가 반환됩니다. 클라이언트는 Operations.GetOperation 또는 다른 메서드를 사용하여 취소가 성공했는지 또는 취소에도 불구하고 작업이 완료되었는지 여부를 확인할 수 있습니다. 취소가 성공하면 작업은 삭제되지 않고 대신 Operation.error 값을 갖는 작업이 되며 google.rpc.Status.code가 1로 설정됩니다. 이 값은 Code.CANCELLED에 해당합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
DeleteOperation

rpc DeleteOperation(DeleteOperationRequest) returns (Empty)

장기 실행 작업을 삭제합니다. 이 메소드는 클라이언트가 작업 결과에 더 이상 관심이 없음을 나타냅니다. 작업을 취소하지는 않습니다. 서버에서 이 메서드를 지원하지 않으면 google.rpc.Code.UNIMPLEMENTED가 반환됩니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation)

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

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

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

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
WaitOperation

rpc WaitOperation(WaitOperationRequest) returns (Operation)

지정된 장기 실행 작업이 완료될 때까지 기다리거나 지정된 제한 시간에 도달하여 최신 상태를 반환합니다. 작업이 이미 완료된 경우 최신 상태가 즉시 반환됩니다. 지정된 제한시간이 기본 HTTP/RPC 제한시간보다 길면 HTTP/RPC 제한시간이 사용됩니다. 서버에서 이 메서드를 지원하지 않으면 google.rpc.Code.UNIMPLEMENTED가 반환됩니다. 이 메서드는 최상의 방식으로 수행됩니다. 즉시 반환되거나 지정된 제한시간 전에 최신 상태를 반환할 수 있으며 즉시 응답하더라도 작업이 완료됨을 보장하지는 않습니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

CancelOperationRequest

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

입력란
name

string

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

DeleteOperationRequest

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

입력란
name

string

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

GetOperationRequest

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

필드
name

string

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

ListOperationsRequest

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

입력란
name

string

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

string

표준 목록 필터입니다.
page_size

int32

표준 목록 페이지 크기입니다.
page_token

string

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

ListOperationsResponse

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

입력란
operations[]

Operation

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

string

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

작업

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

WaitOperationRequest

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

입력란
name

string

대기할 작업 리소스의 이름입니다.
timeout

Duration

제한시간이 되기 전에 기다릴 최대 시간입니다. 비워 두면 기본값인 HTTP/RPC 프로토콜에서 허용하는 최대 시간 동안 기다립니다. RPC 환경설정 기한도 지정되어 있는 경우, 더 짧은 시간이 사용됩니다.