Class: RunApi::Core::RequestOptions

Inherits:
Struct
  • Object
show all
Defined in:
lib/runapi/core/types.rb

Overview

Per-request options that override client-level defaults.

Examples:

client.text_to_image.run(
  prompt: "A sunset",
  model: "z-image",
  aspect_ratio: "1:1",
  options: RequestOptions.new(timeout: 30, headers: { "X-Custom" => "value" })
)

Instance Attribute Summary collapse

Instance Attribute Details

#allow_not_modified ⇒ Object

Returns the value of attribute allow_not_modified

Returns:

  • (Object) —

    the current value of allow_not_modified



77
78
79
 
# File 'lib/runapi/core/types.rb', line 77

def allow_not_modified
  @allow_not_modified
end

#headers ⇒ Hash<String, String>?

Returns Additional HTTP headers. Merged with client-level headers.

Returns:

  • (Hash<String, String>, nil) —

    Additional HTTP headers. Merged with client-level headers.



77
78
79
80
81
82
83
 
# File 'lib/runapi/core/types.rb', line 77

RequestOptions = Struct.new(
  :headers,
  :timeout,
  :max_retries,
  :allow_not_modified,
  keyword_init: true
)

#max_retries ⇒ Integer?

Returns Maximum retry attempts. Overrides client-level max_retries.

Returns:

  • (Integer, nil) —

    Maximum retry attempts. Overrides client-level max_retries.



77
78
79
80
81
82
83
 
# File 'lib/runapi/core/types.rb', line 77

RequestOptions = Struct.new(
  :headers,
  :timeout,
  :max_retries,
  :allow_not_modified,
  keyword_init: true
)

#timeout ⇒ Integer?

Returns Request timeout in seconds. Overrides client-level timeout.

Returns:

  • (Integer, nil) —

    Request timeout in seconds. Overrides client-level timeout.



77
78
79
80
81
82
83
 
# File 'lib/runapi/core/types.rb', line 77

RequestOptions = Struct.new(
  :headers,
  :timeout,
  :max_retries,
  :allow_not_modified,
  keyword_init: true
)