Class: Google::Apis::DiscoveryV1::DiscoveryService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/discovery_v1/service.rb

Overview

API Discovery Service

Provides information about other Google APIs, such as what APIs are available, the resource, and method details for each API.

Examples:

require 'google/apis/discovery_v1'

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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DiscoveryService

Returns a new instance of DiscoveryService.



50
51
52
53
 
# File 'generated/google/apis/discovery_v1/service.rb', line 50

def initialize
  super('https://www.googleapis.com/', 'discovery/v1/')
  @batch_path = 'batch/discovery/v1'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (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.



39
40
41
 
# File 'generated/google/apis/discovery_v1/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



44
45
46
 
# File 'generated/google/apis/discovery_v1/service.rb', line 44

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String) —

    Deprecated. Please use quotaUser instead.



48
49
50
 
# File 'generated/google/apis/discovery_v1/service.rb', line 48

def user_ip
  @user_ip
end

Instance Method Details

#get_rest_api(api, version, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DiscoveryV1::RestDescription

Retrieve the description of a particular version of an api.

Parameters:

  • api (String) —

    The name of the API.

  • version (String) —

    The version of the API.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



79
80
81
82
83
84
85
86
87
88
89
 
# File 'generated/google/apis/discovery_v1/service.rb', line 79

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) {|result, err| ... } ⇒ Google::Apis::DiscoveryV1::DirectoryList

Retrieve the list of APIs supported at this endpoint.

Parameters:

  • name (String) (defaults to: nil) —

    Only include APIs with the given name.

  • preferred (Boolean) (defaults to: nil) —

    Return only the preferred version of an API.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



115
116
117
118
119
120
121
122
123
124
125
 
# File 'generated/google/apis/discovery_v1/service.rb', line 115

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