module LookerSDK::Configurable
Configuration options for {Client}, defaulting to values in {Default}
Attributes
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
@!attribute [w] access_token
@see look TODO docs link
@return [String] OAuth2 access token for authentication
@!attribute api_endpoint
@return [String] Base URL for API requests. default: https://api.looker.com/ look TODO: this is the wrong url... what's the right one? Also update all other references to "api.looker.com"
@!attribute auto_paginate
@return [Boolean] Auto fetch next page of results until rate limit reached
@!attribute client_id
@see look TODO docs link
@return [String] Configure OAuth app key
@!attribute [w] client_secret
@see look TODO docs link
@return [String] Configure OAuth app secret
@!attribute default_media_type
@see look TODO docs link
@return [String] Configure preferred media type (for API versioning, for example)
@!attribute connection_options
@see https://github.com/lostisland/faraday @return [Hash] Configure connection options for Faraday
@!attribute middleware
@see https://github.com/lostisland/faraday @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
@!attribute netrc
@return [Boolean] Instruct Looker to get credentials from .netrc file
@!attribute netrc_file
@return [String] Path to .netrc file. default: ~/.netrc
@!attribute per_page
@return [String] Configure page size for paginated results. API default: 30
@!attribute proxy
@see https://github.com/lostisland/faraday @return [String] URI for proxy server
@!attribute user_agent
@return [String] Configure User-Agent header for requests.
@!attribute web_endpoint
@return [String] Base URL for web URLs. default: https://<client>.looker.com/ look TODO is this correct?
Public Class Methods
List of configurable keys for {LookerSDK::Client} @return [Array] of option keys
# File lib/looker-sdk/configurable.rb, line 77 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, :lazy_swagger, ] end
Public Instance Methods
# File lib/looker-sdk/configurable.rb, line 116 def api_endpoint File.join(@api_endpoint, "") end
Set configuration options using a block
# File lib/looker-sdk/configurable.rb, line 103 def configure yield self end
# File lib/looker-sdk/configurable.rb, line 127 def netrc? !!@netrc end
Reset configuration options to default values
# File lib/looker-sdk/configurable.rb, line 108 def reset! LookerSDK::Configurable.keys.each do |key| instance_variable_set(:"@#{key}", LookerSDK::Default.options[key]) end self end
Base URL for generated web URLs
@return [String] Default:
# File lib/looker-sdk/configurable.rb, line 123
def web_endpoint
File.join(@web_endpoint, "")
end
Private Instance Methods
# File lib/looker-sdk/configurable.rb, line 137 def fetch_client_id_and_secret(overrides = {}) opts = options.merge(overrides) opts.values_at :client_id, :client_secret end
# File lib/looker-sdk/configurable.rb, line 133 def options Hash[LookerSDK::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}] end