Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(core): Document send_timeout_sec and fix up some types #14907

Merged
merged 1 commit into from
Jul 20, 2023
Merged

docs(core): Document send_timeout_sec and fix up some types #14907

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions google-apis-core/lib/google/apis/options.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,11 @@ class ClientOptions
# @!attribute [rw] log_http_requests
# @return [Boolean] True if raw HTTP requests should be logged
# @!attribute [rw] open_timeout_sec
# @return [Fixnum] How long, in seconds, before failed connections time out
# @return [Integer] How long, in seconds, before failed connections time out
# @!attribute [rw] send_timeout_sec
# @return [Integer] How long, in seconds, before sending data times out
# @!attribute [rw] read_timeout_sec
# @return [Fixnum] How long, in seconds, before requests time out
# @return [Integer] How long, in seconds, before receiving data times out
# @!attribute [rw] transparent_gzip_decompression
# @return [Boolean] True if gzip compression needs to be enabled
# Get the default options
Expand All @@ -71,15 +73,15 @@ class RequestOptions
# @!attribute [rw] authorization
# @return [Signet::OAuth2::Client, #apply(Hash)] OAuth2 credentials.
# @!attribute [rw] retries
# @return [Fixnum] Number of times to retry requests on server error.
# @return [Integer] Number of times to retry requests on server error.
# @!attribute [rw] max_elapsed_time
# @return [Fixnum] Total time in seconds that requests are allowed to keep being retried.
# @return [Integer] Total time in seconds that requests are allowed to keep being retried.
# @!attribute [rw] base_interval
# @return [Float] The initial interval in seconds between tries.
# @!attribute [rw] max_interval
# @return [Fixnum] The maximum interval in seconds that any individual retry can reach.
# @return [Integer] The maximum interval in seconds that any individual retry can reach.
# @!attribute [rw] multiplier
# @return [rw] Each successive interval grows by this factor. A multipler of 1.5 means the next interval
# @return [Numeric] Each successive interval grows by this factor. A multipler of 1.5 means the next interval
# will be 1.5x the current interval.
# @!attribute [rw] header
# @return [Hash<String,String>] Additional HTTP headers to include in requests.
Expand All @@ -90,7 +92,7 @@ class RequestOptions
# @!attribute [rw] skip_deserialization
# @return [Boolean] True if response should be returned in raw form instead of deserialized.
# @!attribute [rw] api_format_version
# @return [Fixnum] Version of the error format to request/expect.
# @return [Integer] Version of the error format to request/expect.
# @!attribute [rw] use_opencensus
# @return [Boolean] Whether OpenCensus spans should be generated for requests. Default is true.
# @!attribute [rw] quota_project
Expand Down