Current section

Files

Jump to
google_api_composer lib google_api composer v1beta1 model operation.ex
Raw

lib/google_api/composer/v1beta1/model/operation.ex

# Copyright 2017 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# NOTE: This class is auto generated by the swagger code generator program.
# https://github.com/swagger-api/swagger-codegen.git
# Do not edit the class manually.
defmodule GoogleApi.Composer.V1beta1.Model.Operation do
@moduledoc """
This resource represents a long-running operation that is the result of a network API call.
## Attributes
- 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. Defaults to: `null`.
- error (Status): The error result of the operation in case of failure or cancellation. Defaults to: `null`.
- metadata (%{optional(String.t) => String.t}): 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. Defaults to: `null`.
- name (String.t): 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 have the format of `operations/some/unique/name`. Defaults to: `null`.
- response (%{optional(String.t) => String.t}): The normal response of the operation in case of success. 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`. Defaults to: `null`.
"""
use GoogleApi.Gax.ModelBase
@type t :: %__MODULE__{
:done => any(),
:error => GoogleApi.Composer.V1beta1.Model.Status.t(),
:metadata => map(),
:name => any(),
:response => map()
}
field(:done)
field(:error, as: GoogleApi.Composer.V1beta1.Model.Status)
field(:metadata, type: :map)
field(:name)
field(:response, type: :map)
end
defimpl Poison.Decoder, for: GoogleApi.Composer.V1beta1.Model.Operation do
def decode(value, options) do
GoogleApi.Composer.V1beta1.Model.Operation.decode(value, options)
end
end
defimpl Poison.Encoder, for: GoogleApi.Composer.V1beta1.Model.Operation do
def encode(value, options) do
GoogleApi.Gax.ModelBase.encode(value, options)
end
end