Class: ApolloDeploySignalSdkRails::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/apollo_deploy_signal_sdk_rails/client.rb

Overview

Configuration for the Apollo Signal API SDK client.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url: "https://api.signal.apollodeploy.com", timeout: 15, retries: { attempts: 3, backoff: 0.4, jitter: true, max_backoff: 30.0 }, default_headers: {}, retry_unsafe_requests: false, **_) ⇒ Config

Returns a new instance of Config.

Parameters:

  • base_url (String) (defaults to: "https://api.signal.apollodeploy.com") —

    the base URL for API requests

  • timeout (Integer) (defaults to: 15) —

    request timeout in seconds (default: 15)

  • retries (Hash) (defaults to: { attempts: 3, backoff: 0.4, jitter: true, max_backoff: 30.0 }) —

    retry configuration

  • default_headers (Hash) (defaults to: {}) —

    headers sent with every request



34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/apollo_deploy_signal_sdk_rails/client.rb', line 34

def initialize(
  base_url: "https://api.signal.apollodeploy.com",
  timeout: 15,
  retries: { attempts: 3, backoff: 0.4, jitter: true, max_backoff: 30.0 },
  default_headers: {},
  retry_unsafe_requests: false,
  **_
)
  @base_url = base_url
  @timeout = timeout
  @retries = retries
  @default_headers = default_headers
  @retry_unsafe_requests = retry_unsafe_requests
end

Instance Attribute Details

#base_url ⇒ String

Returns the base URL for API requests.

Returns:

  • (String) —

    the base URL for API requests



20
21
22
 
# File 'lib/apollo_deploy_signal_sdk_rails/client.rb', line 20

def base_url
  @base_url
end

#default_headers ⇒ Hash

Returns default headers sent with every request.

Returns:

  • (Hash) —

    default headers sent with every request



26
27
28
 
# File 'lib/apollo_deploy_signal_sdk_rails/client.rb', line 26

def default_headers
  @default_headers
end

#retries ⇒ Hash

Returns retry configuration.

Returns:

  • (Hash) —

    retry configuration



24
25
26
 
# File 'lib/apollo_deploy_signal_sdk_rails/client.rb', line 24

def retries
  @retries
end

#retry_unsafe_requests ⇒ Boolean

Returns whether POST/PATCH requests may be retried without an idempotency key.

Returns:

  • (Boolean) —

    whether POST/PATCH requests may be retried without an idempotency key



28
29
30
 
# File 'lib/apollo_deploy_signal_sdk_rails/client.rb', line 28

def retry_unsafe_requests
  @retry_unsafe_requests
end

#timeout ⇒ Integer

Returns request timeout in seconds.

Returns:

  • (Integer) —

    request timeout in seconds



22
23
24
 
# File 'lib/apollo_deploy_signal_sdk_rails/client.rb', line 22

def timeout
  @timeout
end