Skip to content

Commit 0d2aa0e

Browse files
authored
docs(core): Document send_timeout_sec and fix up some types (#14907)
1 parent 4ef07ed commit 0d2aa0e

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

google-apis-core/lib/google/apis/options.rb

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,11 @@ class ClientOptions
5454
# @!attribute [rw] log_http_requests
5555
# @return [Boolean] True if raw HTTP requests should be logged
5656
# @!attribute [rw] open_timeout_sec
57-
# @return [Fixnum] How long, in seconds, before failed connections time out
57+
# @return [Integer] How long, in seconds, before failed connections time out
58+
# @!attribute [rw] send_timeout_sec
59+
# @return [Integer] How long, in seconds, before sending data times out
5860
# @!attribute [rw] read_timeout_sec
59-
# @return [Fixnum] How long, in seconds, before requests time out
61+
# @return [Integer] How long, in seconds, before receiving data times out
6062
# @!attribute [rw] transparent_gzip_decompression
6163
# @return [Boolean] True if gzip compression needs to be enabled
6264
# Get the default options
@@ -71,15 +73,15 @@ class RequestOptions
7173
# @!attribute [rw] authorization
7274
# @return [Signet::OAuth2::Client, #apply(Hash)] OAuth2 credentials.
7375
# @!attribute [rw] retries
74-
# @return [Fixnum] Number of times to retry requests on server error.
76+
# @return [Integer] Number of times to retry requests on server error.
7577
# @!attribute [rw] max_elapsed_time
76-
# @return [Fixnum] Total time in seconds that requests are allowed to keep being retried.
78+
# @return [Integer] Total time in seconds that requests are allowed to keep being retried.
7779
# @!attribute [rw] base_interval
7880
# @return [Float] The initial interval in seconds between tries.
7981
# @!attribute [rw] max_interval
80-
# @return [Fixnum] The maximum interval in seconds that any individual retry can reach.
82+
# @return [Integer] The maximum interval in seconds that any individual retry can reach.
8183
# @!attribute [rw] multiplier
82-
# @return [rw] Each successive interval grows by this factor. A multipler of 1.5 means the next interval
84+
# @return [Numeric] Each successive interval grows by this factor. A multipler of 1.5 means the next interval
8385
# will be 1.5x the current interval.
8486
# @!attribute [rw] header
8587
# @return [Hash<String,String>] Additional HTTP headers to include in requests.
@@ -90,7 +92,7 @@ class RequestOptions
9092
# @!attribute [rw] skip_deserialization
9193
# @return [Boolean] True if response should be returned in raw form instead of deserialized.
9294
# @!attribute [rw] api_format_version
93-
# @return [Fixnum] Version of the error format to request/expect.
95+
# @return [Integer] Version of the error format to request/expect.
9496
# @!attribute [rw] use_opencensus
9597
# @return [Boolean] Whether OpenCensus spans should be generated for requests. Default is true.
9698
# @!attribute [rw] quota_project

0 commit comments

Comments
 (0)