Packages
API Discovery Service client library. Provides information about other Google APIs, such as what APIs are available, the resource, and method details for each API.
Current section
Files
Jump to
Current section
Files
lib/google_api/discovery/v1/model/rest_description.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.Discovery.V1.Model.RestDescription do
@moduledoc """
## Attributes
- auth (GoogleApi.Discovery.V1.Model.RestDescriptionAuth.t): Authentication information. Defaults to `nil`.
- basePath (String.t): [DEPRECATED] The base path for REST requests. Defaults to `nil`.
- baseUrl (String.t): [DEPRECATED] The base URL for REST requests. Defaults to `nil`.
- batchPath (String.t): The path for REST batch requests. Defaults to `nil`.
- canonicalName (String.t): Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names. Defaults to `nil`.
- description (String.t): The description of this API. Defaults to `nil`.
- discoveryVersion (String.t): Indicate the version of the Discovery API used to generate this doc. Defaults to `v1`.
- documentationLink (String.t): A link to human readable documentation for the API. Defaults to `nil`.
- etag (String.t): The ETag for this response. Defaults to `nil`.
- exponentialBackoffDefault (boolean()): Enable exponential backoff for suitable methods in the generated clients. Defaults to `nil`.
- features (list(String.t)): A list of supported features for this API. Defaults to `nil`.
- icons (GoogleApi.Discovery.V1.Model.RestDescriptionIcons.t): Links to 16x16 and 32x32 icons representing the API. Defaults to `nil`.
- id (String.t): The ID of this API. Defaults to `nil`.
- kind (String.t): The kind for this response. Defaults to `discovery#restDescription`.
- labels (list(String.t)): Labels for the status of this API, such as labs or deprecated. Defaults to `nil`.
- methods (%{optional(String.t) => GoogleApi.Discovery.V1.Model.RestMethod.t}): API-level methods for this API. Defaults to `nil`.
- name (String.t): The name of this API. Defaults to `nil`.
- ownerDomain (String.t): The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name. Defaults to `nil`.
- ownerName (String.t): The name of the owner of this API. See ownerDomain. Defaults to `nil`.
- packagePath (String.t): The package of the owner of this API. See ownerDomain. Defaults to `nil`.
- parameters (%{optional(String.t) => GoogleApi.Discovery.V1.Model.JsonSchema.t}): Common parameters that apply across all apis. Defaults to `nil`.
- protocol (String.t): The protocol described by this document. Defaults to `rest`.
- resources (%{optional(String.t) => GoogleApi.Discovery.V1.Model.RestResource.t}): The resources in this API. Defaults to `nil`.
- revision (String.t): The version of this API. Defaults to `nil`.
- rootUrl (String.t): The root URL under which all API services live. Defaults to `nil`.
- schemas (%{optional(String.t) => GoogleApi.Discovery.V1.Model.JsonSchema.t}): The schemas for this API. Defaults to `nil`.
- servicePath (String.t): The base path for all REST requests. Defaults to `nil`.
- title (String.t): The title of this API. Defaults to `nil`.
- version (String.t): The version of this API. Defaults to `nil`.
- version_module (boolean()): Defaults to `nil`.
"""
use GoogleApi.Gax.ModelBase
@type t :: %__MODULE__{
:auth => GoogleApi.Discovery.V1.Model.RestDescriptionAuth.t(),
:basePath => String.t(),
:baseUrl => String.t(),
:batchPath => String.t(),
:canonicalName => String.t(),
:description => String.t(),
:discoveryVersion => String.t(),
:documentationLink => String.t(),
:etag => String.t(),
:exponentialBackoffDefault => boolean(),
:features => list(String.t()),
:icons => GoogleApi.Discovery.V1.Model.RestDescriptionIcons.t(),
:id => String.t(),
:kind => String.t(),
:labels => list(String.t()),
:methods => %{optional(String.t()) => GoogleApi.Discovery.V1.Model.RestMethod.t()},
:name => String.t(),
:ownerDomain => String.t(),
:ownerName => String.t(),
:packagePath => String.t(),
:parameters => %{optional(String.t()) => GoogleApi.Discovery.V1.Model.JsonSchema.t()},
:protocol => String.t(),
:resources => %{optional(String.t()) => GoogleApi.Discovery.V1.Model.RestResource.t()},
:revision => String.t(),
:rootUrl => String.t(),
:schemas => %{optional(String.t()) => GoogleApi.Discovery.V1.Model.JsonSchema.t()},
:servicePath => String.t(),
:title => String.t(),
:version => String.t(),
:version_module => boolean()
}
field(:auth, as: GoogleApi.Discovery.V1.Model.RestDescriptionAuth)
field(:basePath)
field(:baseUrl)
field(:batchPath)
field(:canonicalName)
field(:description)
field(:discoveryVersion)
field(:documentationLink)
field(:etag)
field(:exponentialBackoffDefault)
field(:features, type: :list)
field(:icons, as: GoogleApi.Discovery.V1.Model.RestDescriptionIcons)
field(:id)
field(:kind)
field(:labels, type: :list)
field(:methods, as: GoogleApi.Discovery.V1.Model.RestMethod, type: :map)
field(:name)
field(:ownerDomain)
field(:ownerName)
field(:packagePath)
field(:parameters, as: GoogleApi.Discovery.V1.Model.JsonSchema, type: :map)
field(:protocol)
field(:resources, as: GoogleApi.Discovery.V1.Model.RestResource, type: :map)
field(:revision)
field(:rootUrl)
field(:schemas, as: GoogleApi.Discovery.V1.Model.JsonSchema, type: :map)
field(:servicePath)
field(:title)
field(:version)
field(:version_module)
end
defimpl Poison.Decoder, for: GoogleApi.Discovery.V1.Model.RestDescription do
def decode(value, options) do
GoogleApi.Discovery.V1.Model.RestDescription.decode(value, options)
end
end
defimpl Poison.Encoder, for: GoogleApi.Discovery.V1.Model.RestDescription do
def encode(value, options) do
GoogleApi.Gax.ModelBase.encode(value, options)
end
end