google-api-ruby-client/generated/google/apis/discovery_v1/service.rb

145 lines
6.7 KiB
Ruby

# Copyright 2015 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.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module DiscoveryV1
# 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 https://developers.google.com/discovery/
class DiscoveryService < Google::Apis::Core::BaseService
# @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.
attr_accessor :key
# @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.
attr_accessor :quota_user
# @return [String]
# IP address of the site where the request originates. Use this if you want to
# enforce per-user limits.
attr_accessor :user_ip
def initialize
super('https://www.googleapis.com/', 'discovery/v1/')
end
# 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
def get_rest_api(api, version, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
path = 'apis/{api}/{version}/rest'
command = make_simple_command(:get, path, 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
# 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
def list_apis(name: nil, preferred: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
path = 'apis'
command = make_simple_command(:get, path, 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
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
end
end
end
end