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

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

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

done

boolean

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

Union 필드 result . error 또는 유효한 response 일 수 있는 작업 결과입니다. done == false 인 경우 error response 모두 설정되지 않습니다. done == true 인 경우 error 또는 response 중 정확히 하나만 설정될 수 있습니다. 일부 서비스에서는 결과를 제공하지 못할 수도 있습니다. result 다음 중 하나만 가능합니다.
error

object ( Status )

실패 또는 취소 시 작업의 오류 결과입니다.

response

object

성공 시 작업의 정상적인 응답입니다. 원래 메소드가 성공 시 데이터를 반환하지 않는 경우(예: Delete ) 응답은 google.protobuf.Empty 입니다. 원래 메서드가 표준 Get / Create / Update 인 경우 응답은 리소스여야 합니다. 다른 메서드의 경우 응답에는 XxxResponse 유형이 있어야 합니다. 여기서 Xxx 는 원래 메서드 이름입니다. 예를 들어 원래 메서드 이름이 TakeSnapshot() 이면 유추된 응답 유형은 TakeSnapshotResponse 입니다.

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

상태

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

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

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