Package google.longrunning

색인

운영

API 서비스를 사용하여 장기 실행 작업을 관리합니다.

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

취소작업

rpc CancelOperation( CancelOperationRequest ) returns ( Empty )

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

승인 범위

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

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

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

삭제작업

rpc DeleteOperation( DeleteOperationRequest ) returns ( Empty )

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

승인 범위

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

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

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

GetOperation

rpc GetOperation( GetOperationRequest ) returns ( Operation )

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

승인 범위

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

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

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

목록작업

rpc ListOperations( ListOperationsRequest ) returns ( ListOperationsResponse )

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

승인 범위

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

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

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

대기작업

rpc WaitOperation( WaitOperationRequest ) returns ( Operation )

지정된 장기 실행 작업이 완료되거나 최대 지정된 시간 초과에 도달할 때까지 기다렸다가 최신 상태를 반환합니다. 작업이 이미 완료된 경우 최신 상태가 즉시 반환됩니다. 지정된 시간 초과가 기본 HTTP/RPC 시간 초과보다 크면 HTTP/RPC 시간 초과가 사용됩니다. 서버가 이 메소드를 지원하지 않으면 google.rpc.Code.UNIMPLEMENTED 를 반환합니다. 이 방법은 최선의 노력을 기반으로 합니다. 지정된 제한 시간(즉시 포함) 이전에 최신 상태를 반환할 수 있습니다. 즉, 즉각적인 응답이라도 작업이 완료되었다는 보장은 없습니다.

승인 범위

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

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

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

취소작업요청

Operations.CancelOperation 에 대한 요청 메시지입니다.

필드
name

string

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

삭제작업요청

Operations.DeleteOperation 에 대한 요청 메시지입니다.

필드
name

string

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

GetOperationRequest

Operations.GetOperation 에 대한 요청 메시지입니다.

필드
name

string

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

ListOperations요청

Operations.ListOperations 에 대한 요청 메시지입니다.

필드
name

string

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

filter

string

표준 목록 필터입니다.

page_size

int32

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

page_token

string

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

목록작업응답

Operations.ListOperations 에 대한 응답 메시지입니다.

필드
operations[]

Operation

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

next_page_token

string

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

작업

이 리소스는 네트워크 API 호출의 결과인 장기 실행 작업을 나타냅니다.

필드
name

string

원래 반환한 동일한 서비스 내에서만 고유한 서버 할당 이름입니다. 기본 HTTP 매핑을 사용하는 경우 name operations/{unique_id} 로 끝나는 리소스 이름이어야 합니다.

metadata

Any

작업과 관련된 서비스별 메타데이터입니다. 일반적으로 진행 정보와 생성 시간과 같은 일반적인 메타데이터가 포함됩니다. 일부 서비스는 이러한 메타데이터를 제공하지 않을 수 있습니다. 장기 실행 작업을 반환하는 모든 메서드는 메타데이터 유형(있는 경우)을 문서화해야 합니다.

done

bool

값이 false 이면 작업이 아직 진행 중임을 의미합니다. true 이면 작업이 완료되고 error 또는 response 사용할 수 있습니다.

Union 필드 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 입니다.

대기작업요청

Operations.WaitOperation 에 대한 요청 메시지입니다.

필드
name

string

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

timeout

Duration

제한 시간이 초과되기 전에 대기할 최대 기간입니다. 비워 두면 기본 HTTP/RPC 프로토콜에서 허용하는 최대 시간 동안 대기합니다. RPC 컨텍스트 최종 기한도 지정된 경우 더 짧은 것이 사용됩니다.