class Google::Apis::DiscoveryV1::RestDescription

Attributes

api_methods[RW]

API-level methods for this API. Corresponds to the JSON property `methods` @return [Hash<String,Google::Apis::DiscoveryV1::RestMethod>]

auth[RW]

Authentication information. Corresponds to the JSON property `auth` @return [Google::Apis::DiscoveryV1::RestDescription::Auth]

base_path[RW]
DEPRECATED

The base path for REST requests.

Corresponds to the JSON property `basePath` @return [String]

base_url[RW]
DEPRECATED

The base URL for REST requests.

Corresponds to the JSON property `baseUrl` @return [String]

batch_path[RW]

The path for REST batch requests. Corresponds to the JSON property `batchPath` @return [String]

canonical_name[RW]

Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names. Corresponds to the JSON property `canonicalName` @return [String]

description[RW]

The description of this API. Corresponds to the JSON property `description` @return [String]

discovery_version[RW]

Indicate the version of the Discovery API used to generate this doc. Corresponds to the JSON property `discoveryVersion` @return [String]

etag[RW]

The ETag for this response. Corresponds to the JSON property `etag` @return [String]

exponential_backoff_default[RW]

Enable exponential backoff for suitable methods in the generated clients. Corresponds to the JSON property `exponentialBackoffDefault` @return [Boolean]

exponential_backoff_default?[RW]

Enable exponential backoff for suitable methods in the generated clients. Corresponds to the JSON property `exponentialBackoffDefault` @return [Boolean]

features[RW]

A list of supported features for this API. Corresponds to the JSON property `features` @return [Array<String>]

force_alt_json[RW]
force_alt_json?[RW]
icons[RW]

Links to 16x16 and 32x32 icons representing the API. Corresponds to the JSON property `icons` @return [Google::Apis::DiscoveryV1::RestDescription::Icons]

id[RW]

The ID of this API. Corresponds to the JSON property `id` @return [String]

kind[RW]

The kind for this response. Corresponds to the JSON property `kind` @return [String]

labels[RW]

Labels for the status of this API, such as labs or deprecated. Corresponds to the JSON property `labels` @return [Array<String>]

name[RW]

The name of this API. Corresponds to the JSON property `name` @return [String]

owner_domain[RW]

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. Corresponds to the JSON property `ownerDomain` @return [String]

owner_name[RW]

The name of the owner of this API. See ownerDomain. Corresponds to the JSON property `ownerName` @return [String]

package_path[RW]

The package of the owner of this API. See ownerDomain. Corresponds to the JSON property `packagePath` @return [String]

parameters[RW]

Common parameters that apply across all apis. Corresponds to the JSON property `parameters` @return [Hash<String,Google::Apis::DiscoveryV1::JsonSchema>]

protocol[RW]

The protocol described by this document. Corresponds to the JSON property `protocol` @return [String]

resources[RW]

The resources in this API. Corresponds to the JSON property `resources` @return [Hash<String,Google::Apis::DiscoveryV1::RestResource>]

revision[RW]

The version of this API. Corresponds to the JSON property `revision` @return [String]

root_url[RW]

The root URL under which all API services live. Corresponds to the JSON property `rootUrl` @return [String]

schemas[RW]

The schemas for this API. Corresponds to the JSON property `schemas` @return [Hash<String,Google::Apis::DiscoveryV1::JsonSchema>]

service_path[RW]

The base path for all REST requests. Corresponds to the JSON property `servicePath` @return [String]

title[RW]

The title of this API. Corresponds to the JSON property `title` @return [String]

version[RW]

The version of this API. Corresponds to the JSON property `version` @return [String]

version_module[RW]

Corresponds to the JSON property `version_module` @return [Boolean]

version_module?[RW]

Corresponds to the JSON property `version_module` @return [Boolean]

Public Class Methods

new(**args) click to toggle source
# File generated/google/apis/discovery_v1/classes.rb, line 546
def initialize(**args)
   update!(**args)
end

Public Instance Methods

all_methods() click to toggle source
# File lib/google/apis/generator/model.rb, line 126
def all_methods
  m = []
  m << api_methods.values unless api_methods.nil?
  m << resources.map { |_k, r| r.all_methods } unless resources.nil?
  m.flatten
end
module_name() click to toggle source
# File lib/google/apis/generator/model.rb, line 113
def module_name
  name + version
end
qualified_name() click to toggle source
# File lib/google/apis/generator/model.rb, line 117
def qualified_name
  sprintf('Google::Apis::%s', module_name)
end
service_name() click to toggle source
# File lib/google/apis/generator/model.rb, line 121
def service_name
  class_name = (canonical_name || name).gsub(/\W/, '')
  ActiveSupport::Inflector.camelize(sprintf('%sService', class_name))
end
update!(**args) click to toggle source

Update properties of this object

# File generated/google/apis/discovery_v1/classes.rb, line 551
def update!(**args)
  @auth = args[:auth] if args.key?(:auth)
  @base_path = args[:base_path] if args.key?(:base_path)
  @base_url = args[:base_url] if args.key?(:base_url)
  @batch_path = args[:batch_path] if args.key?(:batch_path)
  @canonical_name = args[:canonical_name] if args.key?(:canonical_name)
  @description = args[:description] if args.key?(:description)
  @discovery_version = args[:discovery_version] if args.key?(:discovery_version)
  @documentation_link = args[:documentation_link] if args.key?(:documentation_link)
  @etag = args[:etag] if args.key?(:etag)
  @exponential_backoff_default = args[:exponential_backoff_default] if args.key?(:exponential_backoff_default)
  @features = args[:features] if args.key?(:features)
  @icons = args[:icons] if args.key?(:icons)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @labels = args[:labels] if args.key?(:labels)
  @api_methods = args[:api_methods] if args.key?(:api_methods)
  @name = args[:name] if args.key?(:name)
  @owner_domain = args[:owner_domain] if args.key?(:owner_domain)
  @owner_name = args[:owner_name] if args.key?(:owner_name)
  @package_path = args[:package_path] if args.key?(:package_path)
  @parameters = args[:parameters] if args.key?(:parameters)
  @protocol = args[:protocol] if args.key?(:protocol)
  @resources = args[:resources] if args.key?(:resources)
  @revision = args[:revision] if args.key?(:revision)
  @root_url = args[:root_url] if args.key?(:root_url)
  @schemas = args[:schemas] if args.key?(:schemas)
  @service_path = args[:service_path] if args.key?(:service_path)
  @title = args[:title] if args.key?(:title)
  @version = args[:version] if args.key?(:version)
  @version_module = args[:version_module] if args.key?(:version_module)
end