google_api_spanner

# 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.Spanner.V1.Model.CrontabSpec do
  @moduledoc """
  CrontabSpec can be used to specify the version time and frequency at which the backup is created.

  ## Attributes

  *   `creationWindow` (*type:* `String.t`, *default:* `nil`) - Output only. Scheduled backups contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner might not initiate the creation of the scheduled backups at that version time. Spanner initiates the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
  *   `text` (*type:* `String.t`, *default:* `nil`) - Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC.
  *   `timeZone` (*type:* `String.t`, *default:* `nil`) - Output only. The time zone of the times in `CrontabSpec.text`. Currently, only UTC is supported.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :creationWindow => String.t() | nil,
          :text => String.t() | nil,
          :timeZone => String.t() | nil
        }

  field(:creationWindow)
  field(:text)
  field(:timeZone)
end

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

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