lib/google_api/iam/v1/model/role.ex

# 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.IAM.V1.Model.Role do
  @moduledoc """
  A role in the Identity and Access Management API.

  ## Attributes

  *   `deleted` (*type:* `boolean()`, *default:* `nil`) - The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
  *   `description` (*type:* `String.t`, *default:* `nil`) - Optional. A human-readable description for the role.
  *   `etag` (*type:* `String.t`, *default:* `nil`) - Used to perform a consistent read-modify-write.
  *   `includedPermissions` (*type:* `list(String.t)`, *default:* `nil`) - The names of the permissions this role grants when bound in an IAM policy.
  *   `name` (*type:* `String.t`, *default:* `nil`) - The name of the role. When `Role` is used in `CreateRole`, the role name must not be set. When `Role` is used in output and other input such as `UpdateRole`, the role name is the complete path. For example, `roles/logging.viewer` for predefined roles, `organizations/{ORGANIZATION_ID}/roles/myRole` for organization-level custom roles, and `projects/{PROJECT_ID}/roles/myRole` for project-level custom roles.
  *   `stage` (*type:* `String.t`, *default:* `nil`) - The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
  *   `title` (*type:* `String.t`, *default:* `nil`) - Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :deleted => boolean() | nil,
          :description => String.t() | nil,
          :etag => String.t() | nil,
          :includedPermissions => list(String.t()) | nil,
          :name => String.t() | nil,
          :stage => String.t() | nil,
          :title => String.t() | nil
        }

  field(:deleted)
  field(:description)
  field(:etag)
  field(:includedPermissions, type: :list)
  field(:name)
  field(:stage)
  field(:title)
end

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

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