You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Glacier::Job

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(account_id, vault_name, id, options = {}) ⇒ Job #initialize(options = {}) ⇒ Job

Returns a new instance of Job

Overloads:

  • #initialize(account_id, vault_name, id, options = {}) ⇒ Job

    Parameters:

    • account_id (String)
    • vault_name (String)
    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Job

    Options Hash (options):

    • :account_id (required, String)
    • :vault_name (required, String)
    • :id (required, String)
    • :client (Client)


23
24
25
26
27
28
29
30
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 23

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @account_id = (args, options)
  @vault_name = extract_vault_name(args, options)
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#account_idString

Returns:

  • (String)


35
36
37
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 35

def 
  @account_id
end

#actionString

The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

Returns:

  • (String)


59
60
61
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 59

def action
  data[:action]
end

#archive_idString

The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

Returns:

  • (String)


66
67
68
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 66

def archive_id
  data[:archive_id]
end

#archive_sha256_tree_hashString

The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.

Returns:

  • (String)


169
170
171
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 169

def archive_sha256_tree_hash
  data[:archive_sha256_tree_hash]
end

#archive_size_in_bytesInteger

For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.

Returns:

  • (Integer)


109
110
111
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 109

def archive_size_in_bytes
  data[:archive_size_in_bytes]
end

#clientClient

Returns:



218
219
220
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 218

def client
  @client
end

#completedBoolean

The job status. When a job is completed, you get the job's output using Get Job Output (GET output).

Returns:

  • (Boolean)


88
89
90
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 88

def completed
  data[:completed]
end

#completion_dateTime

The UTC time that the job request completed. While the job is in progress, the value is null.

Returns:

  • (Time)


130
131
132
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 130

def completion_date
  data[:completion_date]
end

#creation_dateTime

The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example "2012-03-20T17:03:43.221Z".

Returns:

  • (Time)


81
82
83
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 81

def creation_date
  data[:creation_date]
end

#dataTypes::GlacierJobDescription

Returns the data for this Aws::Glacier::Job. Calls Client#describe_job if #data_loaded? is false.

Returns:



242
243
244
245
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 242

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



250
251
252
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 250

def data_loaded?
  !!@data
end

#get_output(options = {}, &block) ⇒ Types::GetJobOutputOutput

Examples:

Request syntax with placeholder values


job.get_output({
  range: "string",
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :range (String)

    The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output.

    If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

    1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.

    2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

    3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

    4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

Returns:



390
391
392
393
394
395
396
397
398
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 390

def get_output(options = {}, &block)
  options = options.merge(
    account_id: @account_id,
    vault_name: @vault_name,
    job_id: @id
  )
  resp = @client.get_job_output(options, &block)
  resp.data
end

#idString Also known as: job_id

Returns:

  • (String)


45
46
47
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 45

def id
  @id
end

#inventory_retrieval_parametersTypes::InventoryRetrievalJobDescription

Parameters used for range inventory retrieval.



193
194
195
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 193

def inventory_retrieval_parameters
  data[:inventory_retrieval_parameters]
end

#inventory_size_in_bytesInteger

For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.

Returns:

  • (Integer)


117
118
119
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 117

def inventory_size_in_bytes
  data[:inventory_size_in_bytes]
end

#job_descriptionString

The job description provided when initiating the job.

Returns:

  • (String)


52
53
54
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 52

def job_description
  data[:job_description]
end

#job_output_pathString

Contains the job output location.

Returns:

  • (String)


199
200
201
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 199

def job_output_path
  data[:job_output_path]
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::Glacier::Job. Returns self making it possible to chain methods.

job.reload.data

Returns:

  • (self)


228
229
230
231
232
233
234
235
236
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 228

def load
  resp = @client.describe_job(
    account_id: @account_id,
    vault_name: @vault_name,
    job_id: @id
  )
  @data = resp.data
  self
end

#output_locationTypes::OutputLocation

Contains the location where the data from the select job is stored.



211
212
213
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 211

def output_location
  data[:output_location]
end

#retrieval_byte_rangeString

The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no range was specified in the archive retrieval, then the whole archive is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.

Returns:

  • (String)


180
181
182
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 180

def retrieval_byte_range
  data[:retrieval_byte_range]
end

#select_parametersTypes::SelectParameters

Contains the parameters that define a select job.



205
206
207
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 205

def select_parameters
  data[:select_parameters]
end

#sha256_tree_hashString

For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.

If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

This field is null for the following:

  • Archive retrieval jobs that specify a range that is not tree-hash aligned

^ ^

  • Archival jobs that specify a range that is equal to the whole archive, when the job status is InProgress

^ ^

  • Inventory jobs

  • Select jobs

Returns:

  • (String)


162
163
164
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 162

def sha256_tree_hash
  data[:sha256_tree_hash]
end

#sns_topicString

An Amazon SNS topic that receives notification.

Returns:

  • (String)


123
124
125
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 123

def sns_topic
  data[:sns_topic]
end

#status_codeString

The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

Returns:

  • (String)


95
96
97
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 95

def status_code
  data[:status_code]
end

#status_messageString

A friendly message that describes the job status.

Returns:

  • (String)


101
102
103
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 101

def status_message
  data[:status_message]
end

#tierString

The retrieval option to use for the archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

Returns:

  • (String)


187
188
189
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 187

def tier
  data[:tier]
end

#vaultVault

Returns:



403
404
405
406
407
408
409
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 403

def vault
  Vault.new(
    account_id: @account_id,
    name: @vault_name,
    client: @client
  )
end

#vault_arnString

The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

Returns:

  • (String)


73
74
75
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 73

def vault_arn
  data[:vault_arn]
end

#vault_nameString

Returns:

  • (String)


40
41
42
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 40

def vault_name
  @vault_name
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::Glacier::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/job.rb', line 332

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end