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

Class: Aws::Glacier::Archive

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.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 = {}) ⇒ Archive #initialize(options = {}) ⇒ Archive

Returns a new instance of Archive

Overloads:

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

    Parameters:

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

    Options Hash (options):

  • #initialize(options = {}) ⇒ Archive

    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/archive.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 = Aws::EmptyStructure.new
  @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/archive.rb', line 35

def 
  @account_id
end

#clientClient

Returns:



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

def client
  @client
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.



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

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


archive.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


84
85
86
87
88
89
90
91
92
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 84

def delete(options = {})
  options = options.merge(
    account_id: @account_id,
    vault_name: @vault_name,
    archive_id: @id
  )
  resp = @client.delete_archive(options)
  resp.data
end

#idString

Returns:

  • (String)


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

def id
  @id
end

#initiate_archive_retrieval(options = {}) ⇒ Job

Examples:

Request syntax with placeholder values


archive.initiate_archive_retrieval()

Parameters:

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

    ({})

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 99

def initiate_archive_retrieval(options = {})
  options = Aws::Util.deep_merge(options,
    vault_name: @vault_name,
    account_id: @account_id,
    job_parameters: {
      type: "archive-retrieval",
      archive_id: @id
    }
  )
  resp = @client.initiate_job(options)
  Job.new(
    id: resp.data.job_id,
    account_id: @account_id,
    vault_name: @vault_name,
    client: @client
  )
end

#vaultVault

Returns:



120
121
122
123
124
125
126
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/archive.rb', line 120

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

#vault_nameString

Returns:

  • (String)


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

def vault_name
  @vault_name
end