Package google.longrunning

색인

운영

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

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

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

이전을 취소합니다. transferOperations.get 메서드를 사용하여 취소에 성공했는지 또는 cancel 요청에도 불구하고 작업이 완료되었는지 확인합니다.

작업을 취소하면 현재 실행 중인 전송이 중단됩니다. 반복 전송 작업의 경우 전송 작업의 다음 인스턴스는 계속 실행됩니다. 예를 들어 작업이 매일 오후 1시에 실행되도록 구성되어 있고 오후 1시 5분에 월요일 작업을 취소하면 월요일의 전송이 중지됩니다. 하지만 화요일에 전송 작업이 시도됩니다.

이는 현재 실행 중인 작업에만 적용됩니다. 현재 작업이 실행 중이 아니면 cancel는 아무것도 실행하지 않습니다.

작업을 취소하면 다음 작업에서 파일의 차등을 계산하고 일치하지 않는 상태를 수정할 수 있습니다. 예를 들어 매일 작업을 실행하고 오늘의 작업에서 10개의 새 파일을 찾아 작업을 취소하기 전에 5개의 파일을 전송한 경우, 내일의 전송 작업에서는 오늘 복사되지 않은 5개의 파일과 내일 발견된 새 파일로 새 대수를 계산합니다.

승인 범위

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

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

자세한 내용은 Authentication Overview를 참고하세요.
GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation)

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

승인 범위

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

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

자세한 내용은 Authentication Overview를 참고하세요.
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

전송 작업을 나열합니다. 작업은 생성 시간별로 역순으로 정렬됩니다.

승인 범위

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

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

자세한 내용은 Authentication Overview를 참고하세요.

CancelOperationRequest

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

필드
name

string

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

GetOperationRequest

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

필드
name

string

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

ListOperationsRequest

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

필드
name

string

필수 입력란입니다. 나열되는 유형의 이름입니다. transferOperations이어야 합니다.
filter

string

필수 입력란입니다. {"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobNamePattern": "job_name_pattern", "operationNames":["opid1","opid2",...], "operationNamePattern": "operation_name_pattern", "minCreationTime": "min_creation_time", "maxCreationTime": "max_creation_time", "transferStatuses":["status1","status2",...]} 형식의 JSON 텍스트로 지정된 쿼리 매개변수 목록입니다.

jobNames, operationNames, transferStatuses는 여러 값을 지원하므로 배열 표기법으로 지정해야 합니다. projectId는 유일한 필수 인수입니다. 지정된 경우 jobNamePattern 및 operationNamePattern은 각각 전체 작업 또는 작업 이름과 일치해야 합니다. '*'는 0개 이상의 문자와 일치하는 와일드 카드입니다. minCreationTime 및 maxCreationTime는 RFC 3339 형식의 문자열로 인코딩된 타임스탬프여야 합니다. 유효한 transferStatuses 값은 대소문자를 구분하지 않습니다. IN_PROGRESS, PAUSED, SUCCESS, FAILED, ABORTED입니다.
page_size

int32

목록 페이지 크기입니다. 허용되는 최대값은 256입니다.
page_token

string

목록 페이지 토큰입니다.

ListOperationsResponse

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

필드
operations[]

Operation

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

string

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

작업

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

필드
name

string

서버에 할당된 고유한 이름입니다. name의 형식은 transferOperations/some/unique/name입니다.
metadata

Any

전송 작업 객체를 나타냅니다. TransferOperation 객체를 요청하려면 transferOperations.get를 사용하세요.
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입니다.