Exception: Gapic::Rest::ResumableUpload::RequestFailedError

Inherits:
Common::Error
  • Object
show all
Includes:
HasResumeHandle
Defined in:
lib/gapic/rest/resumable_upload/errors.rb

Overview

Raised when an HTTP request fails (e.g. transport connection failure, request timeout, or retries exhausted).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message = nil, cause: nil, resume_handle: nil, status_code: nil, status: nil, details: nil, headers: nil) ⇒ RequestFailedError

Initializes a new RequestFailedError.

Parameters:

  • message (String, nil) (defaults to: nil) —

    Error message

  • cause (StandardError, nil) (defaults to: nil) —

    Underlying cause exception

  • resume_handle (Gapic::Rest::ResumableUpload::ResumeHandle, nil) (defaults to: nil) —

    Associated resume handle

  • status_code (Integer, nil) (defaults to: nil) —

    HTTP status code

  • status (String, nil) (defaults to: nil) —

    Status description

  • details (Object, nil) (defaults to: nil) —

    Error details

  • headers (Object, nil) (defaults to: nil) —

    Response headers



531
532
533
534
535
536
537
538
539
540
541
# File 'lib/gapic/rest/resumable_upload/errors.rb', line 531

def initialize message = nil, cause: nil, resume_handle: nil,
               status_code: nil, status: nil, details: nil, headers: nil
  @cause = cause
  @resume_handle = resume_handle
  @status_code = status_code || (cause.respond_to?(:status_code) ? cause.status_code : nil)
  @status = status || (cause.respond_to?(:status) ? cause.status : nil)
  @details = details || (cause.respond_to?(:details) ? cause.details : nil)
  @headers = headers || (cause.respond_to?(:headers) ? cause.headers : nil)
  msg = message || cause&.message || "Request failed"
  super HasResumeHandle.append_suffix(msg, resume_handle)
end

Instance Attribute Details

#cause ⇒ StandardError? (readonly)

Returns the underlying cause exception.

Returns:

  • (StandardError, nil)


506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'lib/gapic/rest/resumable_upload/errors.rb', line 506

class RequestFailedError < Gapic::Common::Error
  include HasResumeHandle

  # @return [Integer, nil]
  attr_reader :status_code

  # @return [String, nil]
  attr_reader :status

  # @return [Object, nil]
  attr_reader :details

  # @return [Object, nil]
  attr_reader :headers

  ##
  # Initializes a new RequestFailedError.
  #
  # @param message [String, nil] Error message
  # @param cause [StandardError, nil] Underlying cause exception
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  # @param status_code [Integer, nil] HTTP status code
  # @param status [String, nil] Status description
  # @param details [Object, nil] Error details
  # @param headers [Object, nil] Response headers
  def initialize message = nil, cause: nil, resume_handle: nil,
                 status_code: nil, status: nil, details: nil, headers: nil
    @cause = cause
    @resume_handle = resume_handle
    @status_code = status_code || (cause.respond_to?(:status_code) ? cause.status_code : nil)
    @status = status || (cause.respond_to?(:status) ? cause.status : nil)
    @details = details || (cause.respond_to?(:details) ? cause.details : nil)
    @headers = headers || (cause.respond_to?(:headers) ? cause.headers : nil)
    msg = message || cause&.message || "Request failed"
    super HasResumeHandle.append_suffix(msg, resume_handle)
  end

  ##
  # Returns the underlying cause exception.
  #
  # @return [StandardError, nil]
  def cause
    @cause || super
  end

  ##
  # @private
  # Creates a RequestFailedError from a failure event or error.
  #
  # @param event_or_error [Event::RequestFailed, StandardError] Source event or error
  # @param message [String, nil] Optional message override
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  # @return [RequestFailedError]
  def self.from event_or_error, message: nil, resume_handle: nil
    if event_or_error.respond_to? :source_error
      cause = event_or_error.source_error
      msg = message || event_or_error.message || cause&.message || "Request failed"
      new msg, cause: cause, resume_handle: resume_handle
    elsif event_or_error.is_a? Exception
      msg = message || event_or_error.message || "Request failed"
      new msg, cause: event_or_error, resume_handle: resume_handle
    else
      new message || event_or_error.to_s, resume_handle: resume_handle
    end
  end
end

#details ⇒ Object? (readonly)

Returns:

  • (Object, nil)


506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'lib/gapic/rest/resumable_upload/errors.rb', line 506

class RequestFailedError < Gapic::Common::Error
  include HasResumeHandle

  # @return [Integer, nil]
  attr_reader :status_code

  # @return [String, nil]
  attr_reader :status

  # @return [Object, nil]
  attr_reader :details

  # @return [Object, nil]
  attr_reader :headers

  ##
  # Initializes a new RequestFailedError.
  #
  # @param message [String, nil] Error message
  # @param cause [StandardError, nil] Underlying cause exception
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  # @param status_code [Integer, nil] HTTP status code
  # @param status [String, nil] Status description
  # @param details [Object, nil] Error details
  # @param headers [Object, nil] Response headers
  def initialize message = nil, cause: nil, resume_handle: nil,
                 status_code: nil, status: nil, details: nil, headers: nil
    @cause = cause
    @resume_handle = resume_handle
    @status_code = status_code || (cause.respond_to?(:status_code) ? cause.status_code : nil)
    @status = status || (cause.respond_to?(:status) ? cause.status : nil)
    @details = details || (cause.respond_to?(:details) ? cause.details : nil)
    @headers = headers || (cause.respond_to?(:headers) ? cause.headers : nil)
    msg = message || cause&.message || "Request failed"
    super HasResumeHandle.append_suffix(msg, resume_handle)
  end

  ##
  # Returns the underlying cause exception.
  #
  # @return [StandardError, nil]
  def cause
    @cause || super
  end

  ##
  # @private
  # Creates a RequestFailedError from a failure event or error.
  #
  # @param event_or_error [Event::RequestFailed, StandardError] Source event or error
  # @param message [String, nil] Optional message override
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  # @return [RequestFailedError]
  def self.from event_or_error, message: nil, resume_handle: nil
    if event_or_error.respond_to? :source_error
      cause = event_or_error.source_error
      msg = message || event_or_error.message || cause&.message || "Request failed"
      new msg, cause: cause, resume_handle: resume_handle
    elsif event_or_error.is_a? Exception
      msg = message || event_or_error.message || "Request failed"
      new msg, cause: event_or_error, resume_handle: resume_handle
    else
      new message || event_or_error.to_s, resume_handle: resume_handle
    end
  end
end

#headers ⇒ Object? (readonly)

Returns:

  • (Object, nil)


506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'lib/gapic/rest/resumable_upload/errors.rb', line 506

class RequestFailedError < Gapic::Common::Error
  include HasResumeHandle

  # @return [Integer, nil]
  attr_reader :status_code

  # @return [String, nil]
  attr_reader :status

  # @return [Object, nil]
  attr_reader :details

  # @return [Object, nil]
  attr_reader :headers

  ##
  # Initializes a new RequestFailedError.
  #
  # @param message [String, nil] Error message
  # @param cause [StandardError, nil] Underlying cause exception
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  # @param status_code [Integer, nil] HTTP status code
  # @param status [String, nil] Status description
  # @param details [Object, nil] Error details
  # @param headers [Object, nil] Response headers
  def initialize message = nil, cause: nil, resume_handle: nil,
                 status_code: nil, status: nil, details: nil, headers: nil
    @cause = cause
    @resume_handle = resume_handle
    @status_code = status_code || (cause.respond_to?(:status_code) ? cause.status_code : nil)
    @status = status || (cause.respond_to?(:status) ? cause.status : nil)
    @details = details || (cause.respond_to?(:details) ? cause.details : nil)
    @headers = headers || (cause.respond_to?(:headers) ? cause.headers : nil)
    msg = message || cause&.message || "Request failed"
    super HasResumeHandle.append_suffix(msg, resume_handle)
  end

  ##
  # Returns the underlying cause exception.
  #
  # @return [StandardError, nil]
  def cause
    @cause || super
  end

  ##
  # @private
  # Creates a RequestFailedError from a failure event or error.
  #
  # @param event_or_error [Event::RequestFailed, StandardError] Source event or error
  # @param message [String, nil] Optional message override
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  # @return [RequestFailedError]
  def self.from event_or_error, message: nil, resume_handle: nil
    if event_or_error.respond_to? :source_error
      cause = event_or_error.source_error
      msg = message || event_or_error.message || cause&.message || "Request failed"
      new msg, cause: cause, resume_handle: resume_handle
    elsif event_or_error.is_a? Exception
      msg = message || event_or_error.message || "Request failed"
      new msg, cause: event_or_error, resume_handle: resume_handle
    else
      new message || event_or_error.to_s, resume_handle: resume_handle
    end
  end
end

#resume_handle ⇒ Gapic::Rest::ResumableUpload::ResumeHandle? (readonly)

Returns Associated resume handle.

Returns:



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'lib/gapic/rest/resumable_upload/errors.rb', line 506

class RequestFailedError < Gapic::Common::Error
  include HasResumeHandle

  # @return [Integer, nil]
  attr_reader :status_code

  # @return [String, nil]
  attr_reader :status

  # @return [Object, nil]
  attr_reader :details

  # @return [Object, nil]
  attr_reader :headers

  ##
  # Initializes a new RequestFailedError.
  #
  # @param message [String, nil] Error message
  # @param cause [StandardError, nil] Underlying cause exception
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  # @param status_code [Integer, nil] HTTP status code
  # @param status [String, nil] Status description
  # @param details [Object, nil] Error details
  # @param headers [Object, nil] Response headers
  def initialize message = nil, cause: nil, resume_handle: nil,
                 status_code: nil, status: nil, details: nil, headers: nil
    @cause = cause
    @resume_handle = resume_handle
    @status_code = status_code || (cause.respond_to?(:status_code) ? cause.status_code : nil)
    @status = status || (cause.respond_to?(:status) ? cause.status : nil)
    @details = details || (cause.respond_to?(:details) ? cause.details : nil)
    @headers = headers || (cause.respond_to?(:headers) ? cause.headers : nil)
    msg = message || cause&.message || "Request failed"
    super HasResumeHandle.append_suffix(msg, resume_handle)
  end

  ##
  # Returns the underlying cause exception.
  #
  # @return [StandardError, nil]
  def cause
    @cause || super
  end

  ##
  # @private
  # Creates a RequestFailedError from a failure event or error.
  #
  # @param event_or_error [Event::RequestFailed, StandardError] Source event or error
  # @param message [String, nil] Optional message override
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  # @return [RequestFailedError]
  def self.from event_or_error, message: nil, resume_handle: nil
    if event_or_error.respond_to? :source_error
      cause = event_or_error.source_error
      msg = message || event_or_error.message || cause&.message || "Request failed"
      new msg, cause: cause, resume_handle: resume_handle
    elsif event_or_error.is_a? Exception
      msg = message || event_or_error.message || "Request failed"
      new msg, cause: event_or_error, resume_handle: resume_handle
    else
      new message || event_or_error.to_s, resume_handle: resume_handle
    end
  end
end

#status ⇒ String? (readonly)

Returns:

  • (String, nil)


506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'lib/gapic/rest/resumable_upload/errors.rb', line 506

class RequestFailedError < Gapic::Common::Error
  include HasResumeHandle

  # @return [Integer, nil]
  attr_reader :status_code

  # @return [String, nil]
  attr_reader :status

  # @return [Object, nil]
  attr_reader :details

  # @return [Object, nil]
  attr_reader :headers

  ##
  # Initializes a new RequestFailedError.
  #
  # @param message [String, nil] Error message
  # @param cause [StandardError, nil] Underlying cause exception
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  # @param status_code [Integer, nil] HTTP status code
  # @param status [String, nil] Status description
  # @param details [Object, nil] Error details
  # @param headers [Object, nil] Response headers
  def initialize message = nil, cause: nil, resume_handle: nil,
                 status_code: nil, status: nil, details: nil, headers: nil
    @cause = cause
    @resume_handle = resume_handle
    @status_code = status_code || (cause.respond_to?(:status_code) ? cause.status_code : nil)
    @status = status || (cause.respond_to?(:status) ? cause.status : nil)
    @details = details || (cause.respond_to?(:details) ? cause.details : nil)
    @headers = headers || (cause.respond_to?(:headers) ? cause.headers : nil)
    msg = message || cause&.message || "Request failed"
    super HasResumeHandle.append_suffix(msg, resume_handle)
  end

  ##
  # Returns the underlying cause exception.
  #
  # @return [StandardError, nil]
  def cause
    @cause || super
  end

  ##
  # @private
  # Creates a RequestFailedError from a failure event or error.
  #
  # @param event_or_error [Event::RequestFailed, StandardError] Source event or error
  # @param message [String, nil] Optional message override
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  # @return [RequestFailedError]
  def self.from event_or_error, message: nil, resume_handle: nil
    if event_or_error.respond_to? :source_error
      cause = event_or_error.source_error
      msg = message || event_or_error.message || cause&.message || "Request failed"
      new msg, cause: cause, resume_handle: resume_handle
    elsif event_or_error.is_a? Exception
      msg = message || event_or_error.message || "Request failed"
      new msg, cause: event_or_error, resume_handle: resume_handle
    else
      new message || event_or_error.to_s, resume_handle: resume_handle
    end
  end
end

#status_code ⇒ Integer? (readonly)

Returns:

  • (Integer, nil)


506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'lib/gapic/rest/resumable_upload/errors.rb', line 506

class RequestFailedError < Gapic::Common::Error
  include HasResumeHandle

  # @return [Integer, nil]
  attr_reader :status_code

  # @return [String, nil]
  attr_reader :status

  # @return [Object, nil]
  attr_reader :details

  # @return [Object, nil]
  attr_reader :headers

  ##
  # Initializes a new RequestFailedError.
  #
  # @param message [String, nil] Error message
  # @param cause [StandardError, nil] Underlying cause exception
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  # @param status_code [Integer, nil] HTTP status code
  # @param status [String, nil] Status description
  # @param details [Object, nil] Error details
  # @param headers [Object, nil] Response headers
  def initialize message = nil, cause: nil, resume_handle: nil,
                 status_code: nil, status: nil, details: nil, headers: nil
    @cause = cause
    @resume_handle = resume_handle
    @status_code = status_code || (cause.respond_to?(:status_code) ? cause.status_code : nil)
    @status = status || (cause.respond_to?(:status) ? cause.status : nil)
    @details = details || (cause.respond_to?(:details) ? cause.details : nil)
    @headers = headers || (cause.respond_to?(:headers) ? cause.headers : nil)
    msg = message || cause&.message || "Request failed"
    super HasResumeHandle.append_suffix(msg, resume_handle)
  end

  ##
  # Returns the underlying cause exception.
  #
  # @return [StandardError, nil]
  def cause
    @cause || super
  end

  ##
  # @private
  # Creates a RequestFailedError from a failure event or error.
  #
  # @param event_or_error [Event::RequestFailed, StandardError] Source event or error
  # @param message [String, nil] Optional message override
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  # @return [RequestFailedError]
  def self.from event_or_error, message: nil, resume_handle: nil
    if event_or_error.respond_to? :source_error
      cause = event_or_error.source_error
      msg = message || event_or_error.message || cause&.message || "Request failed"
      new msg, cause: cause, resume_handle: resume_handle
    elsif event_or_error.is_a? Exception
      msg = message || event_or_error.message || "Request failed"
      new msg, cause: event_or_error, resume_handle: resume_handle
    else
      new message || event_or_error.to_s, resume_handle: resume_handle
    end
  end
end