class Google::Apis::DiscoveryV1::DiscoveryService

APIs Discovery Service

Lets you discover information about other Google APIs, such as what APIs are

available, the resource and method details for each API.

@example

require 'google/apis/discovery_v1'

Discovery = Google::Apis::DiscoveryV1 # Alias the module
service = Discovery::DiscoveryService.new

@see developers.google.com/discovery/

Attributes

key[RW]

@return [String]

API key. Your API key identifies your project and provides you with API access,
quota, and reports. Required unless you provide an OAuth 2.0 token.
quota_user[RW]

@return [String]

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
Overrides userIp if both are provided.
user_ip[RW]

@return [String]

IP address of the site where the request originates. Use this if you want to
enforce per-user limits.

Public Class Methods

new() click to toggle source
Calls superclass method Google::Apis::Core::BaseService.new
# File generated/google/apis/discovery_v1/service.rb, line 52
def initialize
  super('https://www.googleapis.com/', 'discovery/v1/')
end

Public Instance Methods

get_rest_api(api, version, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) click to toggle source

Retrieve the description of a particular version of an api. @param [String] api

The name of the API.

@param [String] version

The version of the API.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] #quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
Overrides userIp if both are provided.

@param [String] #user_ip

IP address of the site where the request originates. Use this if you want to
enforce per-user limits.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DiscoveryV1::RestDescription] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DiscoveryV1::RestDescription]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File generated/google/apis/discovery_v1/service.rb, line 82
def get_rest_api(api, version, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'apis/{api}/{version}/rest', options)
  command.response_representation = Google::Apis::DiscoveryV1::RestDescription::Representation
  command.response_class = Google::Apis::DiscoveryV1::RestDescription
  command.params['api'] = api unless api.nil?
  command.params['version'] = version unless version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end
list_apis(name: nil, preferred: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) click to toggle source

Retrieve the list of APIs supported at this endpoint. @param [String] name

Only include APIs with the given name.

@param [Boolean] preferred

Return only the preferred version of an API.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] #quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.
Overrides userIp if both are provided.

@param [String] #user_ip

IP address of the site where the request originates. Use this if you want to
enforce per-user limits.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::DiscoveryV1::DirectoryList] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::DiscoveryV1::DirectoryList]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File generated/google/apis/discovery_v1/service.rb, line 120
def list_apis(name: nil, preferred: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'apis', options)
  command.response_representation = Google::Apis::DiscoveryV1::DirectoryList::Representation
  command.response_class = Google::Apis::DiscoveryV1::DirectoryList
  command.query['name'] = name unless name.nil?
  command.query['preferred'] = preferred unless preferred.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File generated/google/apis/discovery_v1/service.rb, line 134
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
end