Class: Google::Apis::QpxExpressV1::QPXExpressService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/qpx_express_v1/service.rb

Overview

QPX Express API

Finds the least expensive flights between an origin and a destination.

Examples:

require 'google/apis/qpx_express_v1'

QpxExpress = Google::Apis::QpxExpressV1 # Alias the module
service = QpxExpress::QPXExpressService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initializeQPXExpressService

Returns a new instance of QPXExpressService.


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

def initialize
  super('https://www.googleapis.com/', 'qpxExpress/v1/trips/')
end

Instance Attribute Details

#keyString

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.


38
39
40
# File 'generated/google/apis/qpx_express_v1/service.rb', line 38

def key
  @key
end

#quota_userString

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

Returns:

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


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

def quota_user
  @quota_user
end

#user_ipString

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

Returns:

  • (String)

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


49
50
51
# File 'generated/google/apis/qpx_express_v1/service.rb', line 49

def user_ip
  @user_ip
end

Instance Method Details

#search_trips(search_trips_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::QpxExpressV1::SearchTripsResponse

Returns a list of flights.

Parameters:

  • search_trips_request_object (Google::Apis::QpxExpressV1::SearchTripsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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 (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def search_trips(search_trips_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'search', options)
  command.request_representation = Google::Apis::QpxExpressV1::SearchTripsRequest::Representation
  command.request_object = search_trips_request_object
  command.response_representation = Google::Apis::QpxExpressV1::SearchTripsResponse::Representation
  command.response_class = Google::Apis::QpxExpressV1::SearchTripsResponse
  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