gapic-common - Class Gapic::GRPC::DeadlineExceededError (v0.26.0)

Reference documentation and code samples for the gapic-common class Gapic::GRPC::DeadlineExceededError.

An error class that represents Deadline Exceeded error with an optional retry root cause.

The GRPC layer throws ::GRPC::DeadlineExceeded without any context. If the deadline was exceeded while retrying another exception (e.g. ::GRPC::Unavailable), that exception could be useful for understanding the readon for the timeout.

This exception rewraps ::GRPC::DeadlineExceeded, adding an exception that was being retried until the deadline was exceeded (if any) as a root_cause attribute.

Inherits

GRPC::DeadlineExceeded

Methods

#initialize

  def 
  
 initialize 
 ( 
 message 
 , 
  
 root_cause 
 : 
  
 nil 
 ) 
  
 - 
>  
 DeadlineExceededError

Parameters

message(String) — The error message.
root_cause(Object, nil) (defaults to: nil) — The exception that was being retried when the DeadlineExceeded error occured.

Returns

( DeadlineExceededError ) — a new instance of DeadlineExceededError

#root_cause

  def 
  
 root_cause 
 () 
  
 - 
>  
 Object 
 , 
  
 nil