REST Resource: operations

리소스: 작업

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

JSON 표현 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
필드
name

string

서버에 할당된 이름으로, 해당 이름을 최초로 반환한 서비스 내에서만 고유합니다. 기본 HTTP 매핑을 사용하는 경우 name은 operations/{unique_id}로 끝나는 리소스 이름이어야 합니다.
metadata

object

claimAsync, unclaimAsync 또는 updateMetadataAsync에서 작업을 생성한 경우 이 필드에 DevicesLongRunningOperationMetadata 객체가 포함됩니다.

임의 유형의 필드를 포함하는 객체입니다. 추가 필드 "@type"은 유형을 식별하는 URI를 포함합니다. 예를 들면 { "id": 1234, "@type": "types.example.com/standard/id" }입니다.
done

boolean

값이 false이면 작업이 아직 진행 중이라는 의미입니다. true이면 작업이 완료된 것이며, error 또는 response를 사용할 수 있습니다.
통합 필드 result는 작업 결과로, error 또는 유효한 response일 수 있습니다. done == false이면 error와 response가 모두 설정되지 않습니다. done == true이면 error 또는 response 중 정확히 하나를 설정할 수 있습니다. 일부 서비스는 결과를 제공하지 않을 수도 있습니다. result은 다음 중 하나여야 합니다.
error

object (Status)

이 필드는 claimAsync, unclaimAsync 또는 updateMetadataAsync에서 생성된 경우에는 항상 설정되지 않습니다. 이 경우 각 기기의 오류 정보는 response.perDeviceStatus.result.status에 설정됩니다.
response

object

claimAsync, unclaimAsync 또는 updateMetadataAsync에서 작업을 생성한 경우 이 필드에 DevicesLongRunningOperationResponse 객체가 포함됩니다.

임의 유형의 필드를 포함하는 객체입니다. 추가 필드 "@type"은 유형을 식별하는 URI를 포함합니다. 예를 들면 { "id": 1234, "@type": "types.example.com/standard/id" }입니다.

상태

Status 유형은 REST API, RPC API를 비롯하여 다양한 프로그래밍 환경에 적합한 논리적 오류 모델을 정의하며, gRPC에서 사용됩니다. 각 Status 메시지에는 오류 코드, 오류 메시지, 오류 세부정보라는 3가지 데이터가 포함됩니다.

API 설계 가이드에서 이 오류 모델과 모델 작업 방법에 대해 자세히 알아볼 수 있습니다.

JSON 표현 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
필드
code

integer

상태 코드로, google.rpc.Code의 열거형 값이어야 합니다.
message

string

개발자에게 정보를 제공하는 오류 메시지로, 영어로 작성되어야 합니다. 사용자에게 표시되는 모든 오류 메시지는 현지화되어 google.rpc.Status.details 필드에 전송되거나, 클라이언트 측에서 현지화되어야 합니다.
details[]

object

오류 세부정보를 설명하는 메시지 목록입니다. API에서 사용할 일반적인 메시지 유형 집합이 있습니다.

임의 유형의 필드를 포함하는 객체입니다. 추가 필드 "@type"은 유형을 식별하는 URI를 포함합니다. 예를 들면 { "id": 1234, "@type": "types.example.com/standard/id" }입니다.

방법

get

 장기 실행 작업의 최신 상태를 가져옵니다.