Module: LookerSDK::Configurable

Included in:: LookerSDK, Client

Defined in:: lib/looker-sdk/configurable.rb

Overview

Configuration options for Client, defaulting to values in Default

Instance Attribute Summary collapse

#access_token ⇒ Object
#api_endpoint ⇒ String

Base URL for API requests.
#auto_paginate ⇒ Boolean

Auto fetch next page of results until rate limit reached.
#client_id ⇒ Object
#client_secret ⇒ Object
#connection_options ⇒ Hash

Configure connection options for Faraday.
#default_media_type ⇒ Object
#faraday ⇒ Object
#middleware ⇒ Faraday::Builder or Faraday::RackBuilder

Configure middleware for Faraday.
#netrc ⇒ Boolean

Instruct Looker to get credentials from .netrc file.
#netrc_file ⇒ String

Path to .netrc file.
#per_page ⇒ String

Configure page size for paginated results.
#proxy ⇒ String

URI for proxy server.
#raw_responses ⇒ Object
#shared_swagger ⇒ Object
#swagger ⇒ Object
#user_agent ⇒ String

Configure User-Agent header for requests.
#web_endpoint ⇒ String

Base URL for generated web URLs.

Class Method Summary collapse

.keys ⇒ Array

List of configurable keys for Client.

Instance Method Summary collapse

#configure {|_self| ... } ⇒ Object

Set configuration options using a block.
#netrc? ⇒ Boolean
#reset! ⇒ Object (also: #setup)

Reset configuration options to default values.

Instance Attribute Details

#access_token ⇒ `Object`

See Also:

TODO docs link @return [String] OAuth2 access token for authentication
TODO docs link @return [String] Configure OAuth app key
TODO docs link @return [String] Configure OAuth app secret
TODO docs link @return [String] Configure preferred media type (for API versioning, for example)



42
43
44

# File 'lib/looker-sdk/configurable.rb', line 42

def access_token
  @access_token
end

#api_endpoint ⇒ `String`

Returns Base URL for API requests. default: api.looker.com/ look TODO: this is the wrong url… what’s the right one? Also update all other references to “api.looker.com”.

Returns:

(String) —

Base URL for API requests. default: api.looker.com/ look TODO: this is the wrong url… what’s the right one? Also update all other references to “api.looker.com”

# File 'lib/looker-sdk/configurable.rb', line 42

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent, :faraday, :swagger, :shared_swagger, :raw_responses

#auto_paginate ⇒ `Boolean`

Returns Auto fetch next page of results until rate limit reached.

Returns:

(Boolean) —

Auto fetch next page of results until rate limit reached

# File 'lib/looker-sdk/configurable.rb', line 42

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent, :faraday, :swagger, :shared_swagger, :raw_responses

#client_id ⇒ `Object`

See Also:

TODO docs link @return [String] OAuth2 access token for authentication
TODO docs link @return [String] Configure OAuth app key
TODO docs link @return [String] Configure OAuth app secret
TODO docs link @return [String] Configure preferred media type (for API versioning, for example)

# File 'lib/looker-sdk/configurable.rb', line 42

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent, :faraday, :swagger, :shared_swagger, :raw_responses

#client_secret ⇒ `Object`

See Also:

TODO docs link @return [String] OAuth2 access token for authentication
TODO docs link @return [String] Configure OAuth app key
TODO docs link @return [String] Configure OAuth app secret
TODO docs link @return [String] Configure preferred media type (for API versioning, for example)



42
43
44

# File 'lib/looker-sdk/configurable.rb', line 42

def client_secret
  @client_secret
end

#connection_options ⇒ `Hash`

Returns Configure connection options for Faraday.

Returns:

(Hash) —

Configure connection options for Faraday

See Also:

https://github.com/lostisland/faraday

# File 'lib/looker-sdk/configurable.rb', line 42

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent, :faraday, :swagger, :shared_swagger, :raw_responses

#default_media_type ⇒ `Object`

See Also:

TODO docs link @return [String] OAuth2 access token for authentication
TODO docs link @return [String] Configure OAuth app key
TODO docs link @return [String] Configure OAuth app secret
TODO docs link @return [String] Configure preferred media type (for API versioning, for example)

# File 'lib/looker-sdk/configurable.rb', line 42

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent, :faraday, :swagger, :shared_swagger, :raw_responses

#faraday ⇒ `Object`

See Also:

TODO docs link @return [String] OAuth2 access token for authentication
TODO docs link @return [String] Configure OAuth app key
TODO docs link @return [String] Configure OAuth app secret
TODO docs link @return [String] Configure preferred media type (for API versioning, for example)



42
43
44

# File 'lib/looker-sdk/configurable.rb', line 42

def faraday
  @faraday
end

#middleware ⇒ `Faraday::Builder or Faraday::RackBuilder`

Returns Configure middleware for Faraday.

Returns:

(Faraday::Builder or Faraday::RackBuilder) —

Configure middleware for Faraday

See Also:

https://github.com/lostisland/faraday

# File 'lib/looker-sdk/configurable.rb', line 42

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent, :faraday, :swagger, :shared_swagger, :raw_responses

#netrc ⇒ `Boolean`

Returns Instruct Looker to get credentials from .netrc file.

Returns:

(Boolean) —

Instruct Looker to get credentials from .netrc file

# File 'lib/looker-sdk/configurable.rb', line 42

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent, :faraday, :swagger, :shared_swagger, :raw_responses

#netrc_file ⇒ `String`

Returns Path to .netrc file. default: ~/.netrc.

Returns:

(String) —

Path to .netrc file. default: ~/.netrc

# File 'lib/looker-sdk/configurable.rb', line 42

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent, :faraday, :swagger, :shared_swagger, :raw_responses

#per_page ⇒ `String`

Returns Configure page size for paginated results. API default: 30.

Returns:

(String) —

Configure page size for paginated results. API default: 30

# File 'lib/looker-sdk/configurable.rb', line 42

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent, :faraday, :swagger, :shared_swagger, :raw_responses

#proxy ⇒ `String`

Returns URI for proxy server.

Returns:

(String) —

URI for proxy server

See Also:

https://github.com/lostisland/faraday

# File 'lib/looker-sdk/configurable.rb', line 42

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent, :faraday, :swagger, :shared_swagger, :raw_responses

#raw_responses ⇒ `Object`

See Also:

TODO docs link @return [String] OAuth2 access token for authentication
TODO docs link @return [String] Configure OAuth app key
TODO docs link @return [String] Configure OAuth app secret
TODO docs link @return [String] Configure preferred media type (for API versioning, for example)



42
43
44

# File 'lib/looker-sdk/configurable.rb', line 42

def raw_responses
  @raw_responses
end

#shared_swagger ⇒ `Object`

See Also:

TODO docs link @return [String] OAuth2 access token for authentication
TODO docs link @return [String] Configure OAuth app key
TODO docs link @return [String] Configure OAuth app secret
TODO docs link @return [String] Configure preferred media type (for API versioning, for example)



42
43
44

# File 'lib/looker-sdk/configurable.rb', line 42

def shared_swagger
  @shared_swagger
end

#swagger ⇒ `Object`

See Also:

TODO docs link @return [String] OAuth2 access token for authentication
TODO docs link @return [String] Configure OAuth app key
TODO docs link @return [String] Configure OAuth app secret
TODO docs link @return [String] Configure preferred media type (for API versioning, for example)



42
43
44

# File 'lib/looker-sdk/configurable.rb', line 42

def swagger
  @swagger
end

#user_agent ⇒ `String`

Returns Configure User-Agent header for requests.

Returns:

(String) —

Configure User-Agent header for requests.

# File 'lib/looker-sdk/configurable.rb', line 42

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent, :faraday, :swagger, :shared_swagger, :raw_responses

#web_endpoint ⇒ `String`

Base URL for generated web URLs

Returns:

(String) —

Default: https://<client>.looker.com/ look TODO is this correct?

# File 'lib/looker-sdk/configurable.rb', line 42

attr_accessor :access_token, :auto_paginate, :client_id,
:client_secret, :default_media_type, :connection_options,
:middleware, :netrc, :netrc_file,
:per_page, :proxy, :user_agent, :faraday, :swagger, :shared_swagger, :raw_responses

Class Method Details

.keys ⇒ `Array`

List of configurable keys for LookerSDK::Client

Returns:

(Array) —

of option keys

# File 'lib/looker-sdk/configurable.rb', line 52

def keys
  @keys ||= [
    :access_token,
    :api_endpoint,
    :auto_paginate,
    :client_id,
    :client_secret,
    :connection_options,
    :default_media_type,
    :middleware,
    :netrc,
    :netrc_file,
    :per_page,
    :proxy,
    :user_agent,
    :faraday,
    :shared_swagger,
    :swagger,
    :raw_responses,
    :web_endpoint
  ]
end

Instance Method Details

#configure {|_self| ... } ⇒ `Object`

Set configuration options using a block

Yields:

(_self)

Yield Parameters:

_self (LookerSDK::Configurable) —

the object that the method was called on



77
78
79

# File 'lib/looker-sdk/configurable.rb', line 77

def configure
  yield self
end

#netrc? ⇒ `Boolean`

Returns:

(Boolean)



101
102
103

# File 'lib/looker-sdk/configurable.rb', line 101

def netrc?
  !!@netrc
end

#reset! ⇒ `Object` Also known as: setup

Reset configuration options to default values

# File 'lib/looker-sdk/configurable.rb', line 82

def reset!
  LookerSDK::Configurable.keys.each do |key|
    instance_variable_set(:"@#{key}", LookerSDK::Default.options[key])
  end
  self
end

Module: LookerSDK::Configurable

Overview

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#access_token ⇒ Object

#api_endpoint ⇒ String

#auto_paginate ⇒ Boolean

#client_id ⇒ Object

#client_secret ⇒ Object

#connection_options ⇒ Hash

#default_media_type ⇒ Object

#faraday ⇒ Object

#middleware ⇒ Faraday::Builder or Faraday::RackBuilder

#netrc ⇒ Boolean

#netrc_file ⇒ String

#per_page ⇒ String

#proxy ⇒ String

#raw_responses ⇒ Object

#shared_swagger ⇒ Object

#swagger ⇒ Object

#user_agent ⇒ String

#web_endpoint ⇒ String

Class Method Details

.keys ⇒ Array

Instance Method Details

#configure {|_self| ... } ⇒ Object

#netrc? ⇒ Boolean

#reset! ⇒ Object Also known as: setup

#access_token ⇒ `Object`

#api_endpoint ⇒ `String`

#auto_paginate ⇒ `Boolean`

#client_id ⇒ `Object`

#client_secret ⇒ `Object`

#connection_options ⇒ `Hash`

#default_media_type ⇒ `Object`

#faraday ⇒ `Object`

#middleware ⇒ `Faraday::Builder or Faraday::RackBuilder`

#netrc ⇒ `Boolean`

#netrc_file ⇒ `String`

#per_page ⇒ `String`

#proxy ⇒ `String`

#raw_responses ⇒ `Object`

#shared_swagger ⇒ `Object`

#swagger ⇒ `Object`

#user_agent ⇒ `String`

#web_endpoint ⇒ `String`

.keys ⇒ `Array`

#configure {|_self| ... } ⇒ `Object`

#netrc? ⇒ `Boolean`

#reset! ⇒ `Object` Also known as: setup