Current section

Files

Jump to
google_api_sheets lib google_api sheets v4 model value_range.ex
Raw

lib/google_api/sheets/v4/model/value_range.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 class is auto generated by the elixir code generator program.
# Do not edit the class manually.
defmodule GoogleApi.Sheets.V4.Model.ValueRange do
@moduledoc """
Data within a range of the spreadsheet.
## Attributes
* `majorDimension` (*type:* `String.t`, *default:* `nil`) - The major dimension of the values.
For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
then requesting `range=A1:B2,majorDimension=ROWS` will return
`[[1,2],[3,4]]`,
whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
`[[1,3],[2,4]]`.
For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`
will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`
then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.
When writing, if this field is not set, it defaults to ROWS.
* `range` (*type:* `String.t`, *default:* `nil`) - The range the values cover, in A1 notation.
For output, this range indicates the entire requested range,
even though the values will exclude trailing rows and columns.
When appending values, this field represents the range to search for a
table, after which values will be appended.
* `values` (*type:* `list(list(any()))`, *default:* `nil`) - The data that was read or to be written. This is an array of arrays,
the outer array representing all the data and each inner array
representing a major dimension. Each item in the inner array
corresponds with one cell.
For output, empty trailing rows and columns will not be included.
For input, supported value types are: bool, string, and double.
Null values will be skipped.
To set a cell to an empty value, set the string value to an empty string.
"""
use GoogleApi.Gax.ModelBase
@type t :: %__MODULE__{
:majorDimension => String.t(),
:range => String.t(),
:values => list(list(any()))
}
field(:majorDimension)
field(:range)
field(:values, type: :list)
end
defimpl Poison.Decoder, for: GoogleApi.Sheets.V4.Model.ValueRange do
def decode(value, options) do
GoogleApi.Sheets.V4.Model.ValueRange.decode(value, options)
end
end
defimpl Poison.Encoder, for: GoogleApi.Sheets.V4.Model.ValueRange do
def encode(value, options) do
GoogleApi.Gax.ModelBase.encode(value, options)
end
end