lib/google_api/drive/v3/model/drive.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.Drive.V3.Model.Drive do
  @moduledoc """
  Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.

  ## Attributes

  *   `backgroundImageFile` (*type:* `GoogleApi.Drive.V3.Model.DriveBackgroundImageFile.t`, *default:* `nil`) - An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on `drive.drives.update` requests that don't set `themeId`. When specified, all fields of the `backgroundImageFile` must be set.
  *   `backgroundImageLink` (*type:* `String.t`, *default:* `nil`) - Output only. A short-lived link to this shared drive's background image.
  *   `capabilities` (*type:* `GoogleApi.Drive.V3.Model.DriveCapabilities.t`, *default:* `nil`) - Output only. Capabilities the current user has on this shared drive.
  *   `colorRgb` (*type:* `String.t`, *default:* `nil`) - The color of this shared drive as an RGB hex string. It can only be set on a `drive.drives.update` request that does not set `themeId`.
  *   `createdTime` (*type:* `DateTime.t`, *default:* `nil`) - The time at which the shared drive was created (RFC 3339 date-time).
  *   `hidden` (*type:* `boolean()`, *default:* `nil`) - Whether the shared drive is hidden from default view.
  *   `id` (*type:* `String.t`, *default:* `nil`) - Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.
  *   `kind` (*type:* `String.t`, *default:* `drive#drive`) - Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#drive"`.
  *   `name` (*type:* `String.t`, *default:* `nil`) - The name of this shared drive.
  *   `orgUnitId` (*type:* `String.t`, *default:* `nil`) - Output only. The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
  *   `restrictions` (*type:* `GoogleApi.Drive.V3.Model.DriveRestrictions.t`, *default:* `nil`) - A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use `drives.update` to add restrictions.
  *   `themeId` (*type:* `String.t`, *default:* `nil`) - The ID of the theme from which the background image and color will be set. The set of possible `driveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.drives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :backgroundImageFile => GoogleApi.Drive.V3.Model.DriveBackgroundImageFile.t() | nil,
          :backgroundImageLink => String.t() | nil,
          :capabilities => GoogleApi.Drive.V3.Model.DriveCapabilities.t() | nil,
          :colorRgb => String.t() | nil,
          :createdTime => DateTime.t() | nil,
          :hidden => boolean() | nil,
          :id => String.t() | nil,
          :kind => String.t() | nil,
          :name => String.t() | nil,
          :orgUnitId => String.t() | nil,
          :restrictions => GoogleApi.Drive.V3.Model.DriveRestrictions.t() | nil,
          :themeId => String.t() | nil
        }

  field(:backgroundImageFile, as: GoogleApi.Drive.V3.Model.DriveBackgroundImageFile)
  field(:backgroundImageLink)
  field(:capabilities, as: GoogleApi.Drive.V3.Model.DriveCapabilities)
  field(:colorRgb)
  field(:createdTime, as: DateTime)
  field(:hidden)
  field(:id)
  field(:kind)
  field(:name)
  field(:orgUnitId)
  field(:restrictions, as: GoogleApi.Drive.V3.Model.DriveRestrictions)
  field(:themeId)
end

defimpl Poison.Decoder, for: GoogleApi.Drive.V3.Model.Drive do
  def decode(value, options) do
    GoogleApi.Drive.V3.Model.Drive.decode(value, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.Drive.V3.Model.Drive do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end