Class: Google::Apis::RequestOptions

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

Overview

Request options

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#api_format_versionFixnum

Returns Version of the error format to request/expect.

Returns:

  • (Fixnum)

    Version of the error format to request/expect.


64
65
66
# File 'lib/google/apis/options.rb', line 64

def api_format_version
  @api_format_version
end

#authorizationSignet::OAuth2::Client, #apply(Hash)

Returns OAuth2 credentials.

Returns:

  • (Signet::OAuth2::Client, #apply(Hash))

    OAuth2 credentials


64
65
66
# File 'lib/google/apis/options.rb', line 64

def authorization
  @authorization
end

#headerHash<String,String] Additional HTTP headers to include in requests

Returns Hash<String,String] Additional HTTP headers to include in requests.

Returns:

  • (Hash<String,String] Additional HTTP headers to include in requests)

    Hash<String,String] Additional HTTP headers to include in requests


64
65
66
# File 'lib/google/apis/options.rb', line 64

def header
  @header
end

#normalize_unicodeBoolean

Returns True if unicode strings should be normalized in path parameters.

Returns:

  • (Boolean)

    True if unicode strings should be normalized in path parameters


64
65
66
# File 'lib/google/apis/options.rb', line 64

def normalize_unicode
  @normalize_unicode
end

#quota_projectString

Returns Project ID to charge quota, or nil to default to the credentials-specified project.

Returns:

  • (String)

    Project ID to charge quota, or nil to default to the credentials-specified project.


64
65
66
# File 'lib/google/apis/options.rb', line 64

def quota_project
  @quota_project
end

#retriesFixnum

Returns Number of times to retry requests on server error.

Returns:

  • (Fixnum)

    Number of times to retry requests on server error


64
65
66
# File 'lib/google/apis/options.rb', line 64

def retries
  @retries
end

#skip_deserializationBoolean

Returns True if response should be returned in raw form instead of deserialized.

Returns:

  • (Boolean)

    True if response should be returned in raw form instead of deserialized.


64
65
66
# File 'lib/google/apis/options.rb', line 64

def skip_deserialization
  @skip_deserialization
end

#skip_serializationBoolean

Returns True if body object should be treated as raw text instead of an object.

Returns:

  • (Boolean)

    True if body object should be treated as raw text instead of an object.


64
65
66
# File 'lib/google/apis/options.rb', line 64

def skip_serialization
  @skip_serialization
end

#use_opencensusBoolean

Returns Whether OpenCensus spans should be generated for requests. Default is true.

Returns:

  • (Boolean)

    Whether OpenCensus spans should be generated for requests. Default is true.


64
65
66
# File 'lib/google/apis/options.rb', line 64

def use_opencensus
  @use_opencensus
end

Class Method Details

.defaultGoogle::Apis::RequestOptions

Get the default options


85
86
87
# File 'lib/google/apis/options.rb', line 85

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

Instance Method Details

#merge(options) ⇒ Object


89
90
91
92
93
94
95
96
97
98
# File 'lib/google/apis/options.rb', line 89

def merge(options)
  return self if options.nil?

  new_options = dup
  members.each do |opt|
    opt = opt.to_sym
    new_options[opt] = options[opt] unless options[opt].nil?
  end
  new_options
end