lib/google_api/logging/v2/model/log_bucket.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.Logging.V2.Model.LogBucket do
  @moduledoc """
  Describes a repository in which log entries are stored.

  ## Attributes

  *   `cmekSettings` (*type:* `GoogleApi.Logging.V2.Model.CmekSettings.t`, *default:* `nil`) - The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
  *   `createTime` (*type:* `DateTime.t`, *default:* `nil`) - Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
  *   `description` (*type:* `String.t`, *default:* `nil`) - Describes this bucket.
  *   `lifecycleState` (*type:* `String.t`, *default:* `nil`) - Output only. The bucket lifecycle state.
  *   `locked` (*type:* `boolean()`, *default:* `nil`) - Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.
  *   `name` (*type:* `String.t`, *default:* `nil`) - Output only. The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed.
  *   `restrictedFields` (*type:* `list(String.t)`, *default:* `nil`) - Log entry field paths that are denied access in this bucket.The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation.Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. foo.bar will block foo.bar.baz)
  *   `retentionDays` (*type:* `integer()`, *default:* `nil`) - Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.
  *   `updateTime` (*type:* `DateTime.t`, *default:* `nil`) - Output only. The last update timestamp of the bucket.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :cmekSettings => GoogleApi.Logging.V2.Model.CmekSettings.t() | nil,
          :createTime => DateTime.t() | nil,
          :description => String.t() | nil,
          :lifecycleState => String.t() | nil,
          :locked => boolean() | nil,
          :name => String.t() | nil,
          :restrictedFields => list(String.t()) | nil,
          :retentionDays => integer() | nil,
          :updateTime => DateTime.t() | nil
        }

  field(:cmekSettings, as: GoogleApi.Logging.V2.Model.CmekSettings)
  field(:createTime, as: DateTime)
  field(:description)
  field(:lifecycleState)
  field(:locked)
  field(:name)
  field(:restrictedFields, type: :list)
  field(:retentionDays)
  field(:updateTime, as: DateTime)
end

defimpl Poison.Decoder, for: GoogleApi.Logging.V2.Model.LogBucket do
  def decode(value, options) do
    GoogleApi.Logging.V2.Model.LogBucket.decode(value, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.Logging.V2.Model.LogBucket do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end