google_api_genomics

# Copyright 2017 Google Inc.
#
# 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 swagger code generator program.
# https://github.com/swagger-api/swagger-codegen.git
# Do not edit the class manually.

defmodule GoogleApi.Genomics.V1.Model.Annotation do
  @moduledoc """
  An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are `GENE` and `VARIANT`.

  ## Attributes

  - info (%{optional(String.t) => [ErrorUnknown]}): A map of additional read alignment information. This must be of the form map<string, string[]> (string key mapping to a list of string values). Defaults to: `null`.
  - annotationSetId (String.t): The annotation set to which this annotation belongs. Defaults to: `null`.
  - end (String.t): The end position of the range on the reference, 0-based exclusive. Defaults to: `null`.
  - id (String.t): The server-generated annotation ID, unique across all annotations. Defaults to: `null`.
  - name (String.t): The display name of this annotation. Defaults to: `null`.
  - referenceId (String.t): The ID of the Google Genomics reference associated with this range. Defaults to: `null`.
  - referenceName (String.t): The display name corresponding to the reference specified by `referenceId`, for example `chr1`, `1`, or `chrX`. Defaults to: `null`.
  - reverseStrand (boolean()): Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand. Defaults to: `null`.
  - start (String.t): The start position of the range on the reference, 0-based inclusive. Defaults to: `null`.
  - transcript (Transcript): A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type `TRANSCRIPT`. Defaults to: `null`.
  - type (String.t): The data type for this annotation. Must match the containing annotation set's type. Defaults to: `null`.
    - Enum - one of [ANNOTATION_TYPE_UNSPECIFIED, GENERIC, VARIANT, GENE, TRANSCRIPT]
  - variant (VariantAnnotation): A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type `VARIANT`. Defaults to: `null`.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :info => map(),
          :annotationSetId => any(),
          :end => any(),
          :id => any(),
          :name => any(),
          :referenceId => any(),
          :referenceName => any(),
          :reverseStrand => any(),
          :start => any(),
          :transcript => GoogleApi.Genomics.V1.Model.Transcript.t(),
          :type => any(),
          :variant => GoogleApi.Genomics.V1.Model.VariantAnnotation.t()
        }

  field(:info, type: :map)
  field(:annotationSetId)
  field(:end)
  field(:id)
  field(:name)
  field(:referenceId)
  field(:referenceName)
  field(:reverseStrand)
  field(:start)
  field(:transcript, as: GoogleApi.Genomics.V1.Model.Transcript)
  field(:type)
  field(:variant, as: GoogleApi.Genomics.V1.Model.VariantAnnotation)
end

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

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