Current section

Files

Jump to
google_api_spanner lib google_api spanner v1 model backup.ex
Raw

lib/google_api/spanner/v1/model/backup.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.Spanner.V1.Model.Backup do
@moduledoc """
A backup of a Cloud Spanner database.
## Attributes
* `createTime` (*type:* `DateTime.t`, *default:* `nil`) - Output only. The backup will contain an externally consistent
copy of the database at the timestamp specified by
`create_time`. `create_time` is approximately the time the
CreateBackup request is received.
* `database` (*type:* `String.t`, *default:* `nil`) - Required for the CreateBackup operation.
Name of the database from which this backup was
created. This needs to be in the same instance as the backup.
Values are of the form
`projects/<project>/instances/<instance>/databases/<database>`.
* `expireTime` (*type:* `DateTime.t`, *default:* `nil`) - Required for the CreateBackup
operation. The expiration time of the backup, with microseconds
granularity that must be at least 6 hours and at most 366 days
from the time the CreateBackup request is processed. Once the `expire_time`
has passed, the backup is eligible to be automatically deleted by Cloud
Spanner to free the resources used by the backup.
* `name` (*type:* `String.t`, *default:* `nil`) - Output only for the CreateBackup][DatabaseAdmin.CreateBackup] operation.
Required for the UpdateBackup operation.
A globally unique identifier for the backup which cannot be
changed. Values are of the form
`projects/<project>/instances/<instance>/backups/a-z*[a-z0-9]`
The final segment of the name must be between 2 and 60 characters
in length.
The backup is stored in the location(s) specified in the instance
configuration of the instance containing the backup, identified
by the prefix of the backup name of the form
`projects/<project>/instances/<instance>`.
* `referencingDatabases` (*type:* `list(String.t)`, *default:* `nil`) - Output only. The names of the restored databases that reference the backup.
The database names are of
the form `projects/<project>/instances/<instance>/databases/<database>`.
Referencing databases may exist in different instances. The existence of
any referencing database prevents the backup from being deleted. When a
restored database from the backup enters the `READY` state, the reference
to the backup is removed.
* `sizeBytes` (*type:* `String.t`, *default:* `nil`) - Output only. Size of the backup in bytes.
* `state` (*type:* `String.t`, *default:* `nil`) - Output only. The current state of the backup.
"""
use GoogleApi.Gax.ModelBase
@type t :: %__MODULE__{
:createTime => DateTime.t(),
:database => String.t(),
:expireTime => DateTime.t(),
:name => String.t(),
:referencingDatabases => list(String.t()),
:sizeBytes => String.t(),
:state => String.t()
}
field(:createTime, as: DateTime)
field(:database)
field(:expireTime, as: DateTime)
field(:name)
field(:referencingDatabases, type: :list)
field(:sizeBytes)
field(:state)
end
defimpl Poison.Decoder, for: GoogleApi.Spanner.V1.Model.Backup do
def decode(value, options) do
GoogleApi.Spanner.V1.Model.Backup.decode(value, options)
end
end
defimpl Poison.Encoder, for: GoogleApi.Spanner.V1.Model.Backup do
def encode(value, options) do
GoogleApi.Gax.ModelBase.encode(value, options)
end
end