Class: Google::Apis::ClientOptions

Inherits:
Struct
  • Object
show all
Defined in:
lib/google/apis/options.rb,
lib/google/apis/options.rb

Overview

General client options

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#application_name ⇒ String

Returns Name of the application, for identification in the User-Agent header.

Returns:

  • (String) —

    Name of the application, for identification in the User-Agent header



18
19
20
 
# File 'lib/google/apis/options.rb', line 18

def application_name
  @application_name
end

#application_version ⇒ String

Returns Version of the application, for identification in the User-Agent header.

Returns:

  • (String) —

    Version of the application, for identification in the User-Agent header



18
19
20
 
# File 'lib/google/apis/options.rb', line 18

def application_version
  @application_version
end

#log_http_requests ⇒ Boolean

Returns True if raw HTTP requests should be logged.

Returns:

  • (Boolean) —

    True if raw HTTP requests should be logged



18
19
20
 
# File 'lib/google/apis/options.rb', line 18

def log_http_requests
  @log_http_requests
end

#open_timeout_sec ⇒ Integer

Returns How long, in seconds, before failed connections time out.

Returns:

  • (Integer) —

    How long, in seconds, before failed connections time out



18
19
20
 
# File 'lib/google/apis/options.rb', line 18

def open_timeout_sec
  @open_timeout_sec
end

#proxy_url ⇒ String

Returns URL of a proxy server.

Returns:

  • (String) —

    URL of a proxy server



18
19
20
 
# File 'lib/google/apis/options.rb', line 18

def proxy_url
  @proxy_url
end

#read_timeout_sec ⇒ Integer

Returns How long, in seconds, before receiving data times out.

Returns:

  • (Integer) —

    How long, in seconds, before receiving data times out



18
19
20
 
# File 'lib/google/apis/options.rb', line 18

def read_timeout_sec
  @read_timeout_sec
end

#send_timeout_sec ⇒ Integer

Returns How long, in seconds, before sending data times out.

Returns:

  • (Integer) —

    How long, in seconds, before sending data times out



18
19
20
 
# File 'lib/google/apis/options.rb', line 18

def send_timeout_sec
  @send_timeout_sec
end

#transparent_gzip_decompression ⇒ Boolean, Google::Apis::ClientOptions

Get the default options

Returns:



18
19
20
 
# File 'lib/google/apis/options.rb', line 18

def transparent_gzip_decompression
  @transparent_gzip_decompression
end

Class Method Details

.default ⇒ Boolean, Google::Apis::ClientOptions

Get the default options

Returns:



66
67
68
 
# File 'lib/google/apis/options.rb', line 66

def self.default
  @options ||= ClientOptions.new
end