Class: Google::Apis::SpectrumV1explorer::SpectrumService

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

Overview

Google Spectrum Database API

API for spectrum-management functions.

Examples:

require 'google/apis/spectrum_v1explorer'

Spectrum = Google::Apis::SpectrumV1explorer # Alias the module
service = Spectrum::SpectrumService.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

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ SpectrumService

Returns a new instance of SpectrumService



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

def initialize
  super('https://www.googleapis.com/', 'spectrum/v1explorer/paws/')
  @batch_path = 'batch/spectrum/v1explorer'
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.



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

def key
  @key
end

#quota_user ⇒ String

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/spectrum_v1explorer/service.rb', line 44

def quota_user
  @quota_user
end

#user_ip ⇒ String

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/spectrum_v1explorer/service.rb', line 49

def user_ip
  @user_ip
end

Instance Method Details

#get_paw_spectrum(paws_get_spectrum_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpectrumV1explorer::PawsGetSpectrumResponse

Requests information about the available spectrum for a device at a location. Requests from a fixed-mode device must include owner information so the device can be registered with the database.

Parameters:

  • paws_get_spectrum_request_object (Google::Apis::SpectrumV1explorer::PawsGetSpectrumRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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 (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



81
82
83
84
85
86
87
88
89
90
91
 
# File 'generated/google/apis/spectrum_v1explorer/service.rb', line 81

def get_paw_spectrum(paws_get_spectrum_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'getSpectrum', options)
  command.request_representation = Google::Apis::SpectrumV1explorer::PawsGetSpectrumRequest::Representation
  command.request_object = paws_get_spectrum_request_object
  command.response_representation = Google::Apis::SpectrumV1explorer::PawsGetSpectrumResponse::Representation
  command.response_class = Google::Apis::SpectrumV1explorer::PawsGetSpectrumResponse
  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

#get_paw_spectrum_batch(paws_get_spectrum_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpectrumV1explorer::PawsGetSpectrumBatchResponse

The Google Spectrum Database does not support batch requests, so this method always yields an UNIMPLEMENTED error.

Parameters:

  • paws_get_spectrum_batch_request_object (Google::Apis::SpectrumV1explorer::PawsGetSpectrumBatchRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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 (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



117
118
119
120
121
122
123
124
125
126
127
 
# File 'generated/google/apis/spectrum_v1explorer/service.rb', line 117

def get_paw_spectrum_batch(paws_get_spectrum_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'getSpectrumBatch', options)
  command.request_representation = Google::Apis::SpectrumV1explorer::PawsGetSpectrumBatchRequest::Representation
  command.request_object = paws_get_spectrum_batch_request_object
  command.response_representation = Google::Apis::SpectrumV1explorer::PawsGetSpectrumBatchResponse::Representation
  command.response_class = Google::Apis::SpectrumV1explorer::PawsGetSpectrumBatchResponse
  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

#init_paw(paws_init_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpectrumV1explorer::PawsInitResponse

Initializes the connection between a white space device and the database.

Parameters:

  • paws_init_request_object (Google::Apis::SpectrumV1explorer::PawsInitRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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 (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



152
153
154
155
156
157
158
159
160
161
162
 
# File 'generated/google/apis/spectrum_v1explorer/service.rb', line 152

def init_paw(paws_init_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'init', options)
  command.request_representation = Google::Apis::SpectrumV1explorer::PawsInitRequest::Representation
  command.request_object = paws_init_request_object
  command.response_representation = Google::Apis::SpectrumV1explorer::PawsInitResponse::Representation
  command.response_class = Google::Apis::SpectrumV1explorer::PawsInitResponse
  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

#notify_paw_spectrum_use(paws_notify_spectrum_use_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpectrumV1explorer::PawsNotifySpectrumUseResponse

Notifies the database that the device has selected certain frequency ranges for transmission. Only to be invoked when required by the regulator. The Google Spectrum Database does not operate in domains that require notification, so this always yields an UNIMPLEMENTED error.

Parameters:

  • paws_notify_spectrum_use_request_object (Google::Apis::SpectrumV1explorer::PawsNotifySpectrumUseRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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 (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



190
191
192
193
194
195
196
197
198
199
200
 
# File 'generated/google/apis/spectrum_v1explorer/service.rb', line 190

def notify_paw_spectrum_use(paws_notify_spectrum_use_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'notifySpectrumUse', options)
  command.request_representation = Google::Apis::SpectrumV1explorer::PawsNotifySpectrumUseRequest::Representation
  command.request_object = paws_notify_spectrum_use_request_object
  command.response_representation = Google::Apis::SpectrumV1explorer::PawsNotifySpectrumUseResponse::Representation
  command.response_class = Google::Apis::SpectrumV1explorer::PawsNotifySpectrumUseResponse
  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

#register_paw(paws_register_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpectrumV1explorer::PawsRegisterResponse

The Google Spectrum Database implements registration in the getSpectrum method. As such this always returns an UNIMPLEMENTED error.

Parameters:

  • paws_register_request_object (Google::Apis::SpectrumV1explorer::PawsRegisterRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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 (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



226
227
228
229
230
231
232
233
234
235
236
 
# File 'generated/google/apis/spectrum_v1explorer/service.rb', line 226

def register_paw(paws_register_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'register', options)
  command.request_representation = Google::Apis::SpectrumV1explorer::PawsRegisterRequest::Representation
  command.request_object = paws_register_request_object
  command.response_representation = Google::Apis::SpectrumV1explorer::PawsRegisterResponse::Representation
  command.response_class = Google::Apis::SpectrumV1explorer::PawsRegisterResponse
  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

#verify_paw_device(paws_verify_device_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpectrumV1explorer::PawsVerifyDeviceResponse

Validates a device for white space use in accordance with regulatory rules. The Google Spectrum Database does not support master/slave configurations, so this always yields an UNIMPLEMENTED error.

Parameters:

  • paws_verify_device_request_object (Google::Apis::SpectrumV1explorer::PawsVerifyDeviceRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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 (String) —

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



263
264
265
266
267
268
269
270
271
272
273
 
# File 'generated/google/apis/spectrum_v1explorer/service.rb', line 263

def verify_paw_device(paws_verify_device_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'verifyDevice', options)
  command.request_representation = Google::Apis::SpectrumV1explorer::PawsVerifyDeviceRequest::Representation
  command.request_object = paws_verify_device_request_object
  command.response_representation = Google::Apis::SpectrumV1explorer::PawsVerifyDeviceResponse::Representation
  command.response_class = Google::Apis::SpectrumV1explorer::PawsVerifyDeviceResponse
  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