# Copyright 2019 Google LLC
#
# 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 file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.ServiceUser.V1.Model.Mixin do
  @moduledoc """
  Declares an API Interface to be included in this interface. The including
  interface must redeclare all the methods from the included interface, but
  documentation and options are inherited as follows:

  - If after comment and whitespace stripping, the documentation
    string of the redeclared method is empty, it will be inherited
    from the original method.

  - Each annotation belonging to the service config (http,
    visibility) which is not set in the redeclared method will be
    inherited.

  - If an http annotation is inherited, the path pattern will be
    modified as follows. Any version prefix will be replaced by the
    version of the including interface plus the root path if
    specified.

  Example of a simple mixin:

      package google.acl.v1;
      service AccessControl {
        // Get the underlying ACL object.
        rpc GetAcl(GetAclRequest) returns (Acl) {
          option (google.api.http).get = "/v1/{resource=**}:getAcl";
        }
      }

      package google.storage.v2;
      service Storage {
        //       rpc GetAcl(GetAclRequest) returns (Acl);

        // Get a data record.
        rpc GetData(GetDataRequest) returns (Data) {
          option (google.api.http).get = "/v2/{resource=**}";
        }
      }

  Example of a mixin configuration:

      apis:
      - name: google.storage.v2.Storage
        mixins:
        - name: google.acl.v1.AccessControl

  The mixin construct implies that all methods in `AccessControl` are
  also declared with same name and request/response types in
  `Storage`. A documentation generator or annotation processor will
  see the effective `Storage.GetAcl` method after inherting
  documentation and annotations as follows:

      service Storage {
        // Get the underlying ACL object.
        rpc GetAcl(GetAclRequest) returns (Acl) {
          option (google.api.http).get = "/v2/{resource=**}:getAcl";
        }
        ...
      }

  Note how the version in the path pattern changed from `v1` to `v2`.

  If the `root` field in the mixin is specified, it should be a
  relative path under which inherited HTTP paths are placed. Example:

      apis:
      - name: google.storage.v2.Storage
        mixins:
        - name: google.acl.v1.AccessControl
          root: acls

  This implies the following inherited HTTP annotation:

      service Storage {
        // Get the underlying ACL object.
        rpc GetAcl(GetAclRequest) returns (Acl) {
          option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
        }
        ...
      }

  ## Attributes

  *   `name` (*type:* `String.t`, *default:* `nil`) - The fully qualified name of the interface which is included.
  *   `root` (*type:* `String.t`, *default:* `nil`) - If non-empty specifies a path under which inherited HTTP paths
      are rooted.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :name => String.t(),
          :root => String.t()
        }

  field(:name)
  field(:root)
end

defimpl Poison.Decoder, for: GoogleApi.ServiceUser.V1.Model.Mixin do
  def decode(value, options) do
    GoogleApi.ServiceUser.V1.Model.Mixin.decode(value, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.ServiceUser.V1.Model.Mixin do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end
