Operation

This resource represents a long-running operation that is the result of a network API call.

HealthcareFHIRHL7v2DICOMMedical ImagingDe-identificationInteroperabilityCloud

Properties

Name	Type	Description
done	boolean	If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
error	object	The error result of the operation in case of failure or cancellation.
metadata	object	Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method t
name	string	The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{un
response	object	The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Operation",
  "description": "This resource represents a long-running operation that is the result of a network API call.",
  "properties": {
    "done": {
      "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
      "type": "boolean"
    },
    "error": {
      "$ref": "#/components/schemas/Status",
      "description": "The error result of the operation in case of failure or cancellation."
    },
    "metadata": {
      "additionalProperties": {
        "description": "Properties of the object. Contains field @type with type URL."
      },
      "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
      "type": "object"
    },
    "name": {
      "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
      "type": "string"
    },
    "response": {
      "additionalProperties": {
        "description": "Properties of the object. Contains field @type with type URL."
      },
      "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
      "type": "object"
    }
  },
  "type": "object"
}