google_api_spectrum v0.1.0 GoogleApi.Spectrum.V1explorer.Api.Paws View Source

API calls for all endpoints tagged Paws.

Link to this section Summary

Functions

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

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

Initializes the connection between a white space device and the database

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

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

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

Link to this section Functions

Link to this function spectrum_paws_get_spectrum(connection, opts \\ []) View Source
spectrum_paws_get_spectrum(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Spectrum.V1explorer.Model.PawsGetSpectrumResponse.t()}
  | {:error, Tesla.Env.t()}

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

  • connection (GoogleApi.Spectrum.V1explorer.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (PawsGetSpectrumRequest):

Returns

{:ok, %GoogleApi.Spectrum.V1explorer.Model.PawsGetSpectrumResponse{}} on success {:error, info} on failure

Link to this function spectrum_paws_get_spectrum_batch(connection, opts \\ []) View Source
spectrum_paws_get_spectrum_batch(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Spectrum.V1explorer.Model.PawsGetSpectrumBatchResponse.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (GoogleApi.Spectrum.V1explorer.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (PawsGetSpectrumBatchRequest):

Returns

{:ok, %GoogleApi.Spectrum.V1explorer.Model.PawsGetSpectrumBatchResponse{}} on success {:error, info} on failure

Link to this function spectrum_paws_init(connection, opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.Spectrum.V1explorer.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (PawsInitRequest):

Returns

{:ok, %GoogleApi.Spectrum.V1explorer.Model.PawsInitResponse{}} on success {:error, info} on failure

Link to this function spectrum_paws_notify_spectrum_use(connection, opts \\ []) View Source
spectrum_paws_notify_spectrum_use(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Spectrum.V1explorer.Model.PawsNotifySpectrumUseResponse.t()}
  | {:error, Tesla.Env.t()}

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

  • connection (GoogleApi.Spectrum.V1explorer.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (PawsNotifySpectrumUseRequest):

Returns

{:ok, %GoogleApi.Spectrum.V1explorer.Model.PawsNotifySpectrumUseResponse{}} on success {:error, info} on failure

Link to this function spectrum_paws_register(connection, opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.Spectrum.V1explorer.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (PawsRegisterRequest):

Returns

{:ok, %GoogleApi.Spectrum.V1explorer.Model.PawsRegisterResponse{}} on success {:error, info} on failure

Link to this function spectrum_paws_verify_device(connection, opts \\ []) View Source
spectrum_paws_verify_device(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Spectrum.V1explorer.Model.PawsVerifyDeviceResponse.t()}
  | {:error, Tesla.Env.t()}

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

  • connection (GoogleApi.Spectrum.V1explorer.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (PawsVerifyDeviceRequest):

Returns

{:ok, %GoogleApi.Spectrum.V1explorer.Model.PawsVerifyDeviceResponse{}} on success {:error, info} on failure