Packages

google_api_sheets

0.33.1
0.35.0 0.34.0 0.33.5 0.33.4 0.33.3 0.33.2 0.33.1 0.33.0 0.32.0 0.31.0 0.30.0 0.29.4 0.29.3 0.29.2 0.29.1 0.29.0 0.28.2 0.28.1 0.28.0 0.27.0 0.26.0 0.25.2 0.25.1 0.25.0 0.24.1 0.24.0 0.23.0 0.22.1 0.22.0 0.21.2 0.21.1 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0 0.0.2 0.0.1

Google Sheets API client library. Reads and writes Google Sheets.

HexDocs

Current section

Files

Jump to
Readme
54 Versions
1 Dependency
Dependants
Files
Activity
google_api_sheets lib google_api sheets v4 model pivot_table.ex
Raw

lib/google_api/sheets/v4/model/pivot_table.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.Sheets.V4.Model.PivotTable do

  @moduledoc """

  A pivot table.



  ## Attributes



  *   `columns` (*type:* `list(GoogleApi.Sheets.V4.Model.PivotGroup.t)`, *default:* `nil`) - Each column grouping in the pivot table.

  *   `criteria` (*type:* `%{optional(String.t) => GoogleApi.Sheets.V4.Model.PivotFilterCriteria.t}`, *default:* `nil`) - An optional mapping of filters per source column offset. The filters are applied before aggregating data into the pivot table. The map's key is the column offset of the source range that you want to filter, and the value is the criteria for that column. For example, if the source was `C10:E15`, a key of `0` will have the filter for column `C`, whereas the key `1` is for column `D`. This field is deprecated in favor of filter_specs.

  *   `dataExecutionStatus` (*type:* `GoogleApi.Sheets.V4.Model.DataExecutionStatus.t`, *default:* `nil`) - Output only. The data execution status for data source pivot tables.

  *   `dataSourceId` (*type:* `String.t`, *default:* `nil`) - The ID of the data source the pivot table is reading data from.

  *   `filterSpecs` (*type:* `list(GoogleApi.Sheets.V4.Model.PivotFilterSpec.t)`, *default:* `nil`) - The filters applied to the source columns before aggregating data for the pivot table. Both criteria and filter_specs are populated in responses. If both fields are specified in an update request, this field takes precedence.

  *   `rows` (*type:* `list(GoogleApi.Sheets.V4.Model.PivotGroup.t)`, *default:* `nil`) - Each row grouping in the pivot table.

  *   `source` (*type:* `GoogleApi.Sheets.V4.Model.GridRange.t`, *default:* `nil`) - The range the pivot table is reading data from.

  *   `valueLayout` (*type:* `String.t`, *default:* `nil`) - Whether values should be listed horizontally (as columns) or vertically (as rows).

  *   `values` (*type:* `list(GoogleApi.Sheets.V4.Model.PivotValue.t)`, *default:* `nil`) - A list of values to include in the pivot table.

  """



  use GoogleApi.Gax.ModelBase



  @type t :: %__MODULE__{

          :columns => list(GoogleApi.Sheets.V4.Model.PivotGroup.t()) | nil,

          :criteria =>

            %{optional(String.t()) => GoogleApi.Sheets.V4.Model.PivotFilterCriteria.t()} | nil,

          :dataExecutionStatus => GoogleApi.Sheets.V4.Model.DataExecutionStatus.t() | nil,

          :dataSourceId => String.t() | nil,

          :filterSpecs => list(GoogleApi.Sheets.V4.Model.PivotFilterSpec.t()) | nil,

          :rows => list(GoogleApi.Sheets.V4.Model.PivotGroup.t()) | nil,

          :source => GoogleApi.Sheets.V4.Model.GridRange.t() | nil,

          :valueLayout => String.t() | nil,

          :values => list(GoogleApi.Sheets.V4.Model.PivotValue.t()) | nil

        }



  field(:columns, as: GoogleApi.Sheets.V4.Model.PivotGroup, type: :list)

  field(:criteria, as: GoogleApi.Sheets.V4.Model.PivotFilterCriteria, type: :map)

  field(:dataExecutionStatus, as: GoogleApi.Sheets.V4.Model.DataExecutionStatus)

  field(:dataSourceId)

  field(:filterSpecs, as: GoogleApi.Sheets.V4.Model.PivotFilterSpec, type: :list)

  field(:rows, as: GoogleApi.Sheets.V4.Model.PivotGroup, type: :list)

  field(:source, as: GoogleApi.Sheets.V4.Model.GridRange)

  field(:valueLayout)

  field(:values, as: GoogleApi.Sheets.V4.Model.PivotValue, type: :list)

end



defimpl Poison.Decoder, for: GoogleApi.Sheets.V4.Model.PivotTable do

  def decode(value, options) do

    GoogleApi.Sheets.V4.Model.PivotTable.decode(value, options)

  end

end



defimpl Poison.Encoder, for: GoogleApi.Sheets.V4.Model.PivotTable do

  def encode(value, options) do

    GoogleApi.Gax.ModelBase.encode(value, options)

  end

end