Exception: Gapic::Rest::ResumableUpload::DeadlineExceededError

Inherits:

Common::Error

• Object
• StandardError
• Common::Error
• Gapic::Rest::ResumableUpload::DeadlineExceededError

Includes:

HasResumeHandle

Defined in:

lib/gapic/rest/resumable_upload/errors.rb

Overview

Raised when an upload exceeds its global monotonic deadline.

Instance Attribute Summary

• #resume_handle ⇒ Gapic::Rest::ResumableUpload::ResumeHandle^? readonly

  Associated resume handle.

• #root_cause ⇒ Object^? readonly

  Root cause exception if deadline exceeded during a retry loop.

Instance Method Summary

• #initialize(message = "Upload deadline exceeded", root_cause: nil, resume_handle: nil) ⇒ DeadlineExceededError constructor

  Initializes a new DeadlineExceededError.

Constructor Details

#initialize(message = "Upload deadline exceeded", root_cause: nil, resume_handle: nil) ⇒ DeadlineExceededError

Initializes a new DeadlineExceededError.

Parameters:

• message (String) (defaults to: "Upload deadline exceeded") —

  Deadline exceeded message

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

  Root cause exception

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

  Associated resume handle

# File 'lib/gapic/rest/resumable_upload/errors.rb', line 471

def initialize message = "Upload deadline exceeded", root_cause: nil, resume_handle: nil
  super HasResumeHandle.append_suffix(message, resume_handle)
  @root_cause = root_cause
  @resume_handle = resume_handle
end

Instance Attribute Details

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

Returns Associated resume handle.

Returns:

• (Gapic::Rest::ResumableUpload::ResumeHandle, nil) —

  Associated resume handle

# File 'lib/gapic/rest/resumable_upload/errors.rb', line 459

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

  # @return [Object, nil] Root cause exception if deadline exceeded during a retry loop
  attr_reader :root_cause

  ##
  # Initializes a new DeadlineExceededError.
  #
  # @param message [String] Deadline exceeded message
  # @param root_cause [Object, nil] Root cause exception
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  def initialize message = "Upload deadline exceeded", root_cause: nil, resume_handle: nil
    super HasResumeHandle.append_suffix(message, resume_handle)
    @root_cause = root_cause
    @resume_handle = resume_handle
  end

  ##
  # @private
  # Creates a DeadlineExceededError with optional resume handle.
  #
  # @param message [String, nil] Deadline exceeded message
  # @param root_cause [Object, nil] Root cause exception
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  # @return [DeadlineExceededError]
  def self.from message = "Upload deadline exceeded", root_cause: nil, resume_handle: nil
    new message, root_cause: root_cause, resume_handle: resume_handle
  end
end

#root_cause ⇒ Object^? (readonly)

Returns Root cause exception if deadline exceeded during a retry loop.

Returns:

• (Object, nil) —

  Root cause exception if deadline exceeded during a retry loop

# File 'lib/gapic/rest/resumable_upload/errors.rb', line 459

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

  # @return [Object, nil] Root cause exception if deadline exceeded during a retry loop
  attr_reader :root_cause

  ##
  # Initializes a new DeadlineExceededError.
  #
  # @param message [String] Deadline exceeded message
  # @param root_cause [Object, nil] Root cause exception
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  def initialize message = "Upload deadline exceeded", root_cause: nil, resume_handle: nil
    super HasResumeHandle.append_suffix(message, resume_handle)
    @root_cause = root_cause
    @resume_handle = resume_handle
  end

  ##
  # @private
  # Creates a DeadlineExceededError with optional resume handle.
  #
  # @param message [String, nil] Deadline exceeded message
  # @param root_cause [Object, nil] Root cause exception
  # @param resume_handle [Gapic::Rest::ResumableUpload::ResumeHandle, nil] Associated resume handle
  # @return [DeadlineExceededError]
  def self.from message = "Upload deadline exceeded", root_cause: nil, resume_handle: nil
    new message, root_cause: root_cause, resume_handle: resume_handle
  end
end