Class: MintPress::Aws::Glacier::JobOutput

Inherits:

Object

• Object
• MintPress::Aws::Glacier::JobOutput

Includes:

MintLogger, AwsCommon, Mixins::Properties

Defined in:

src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job_output.rb

Properties (Read/Write)

• #vault_name ⇒ [String] (Default Value: Proc.new { self.name })
  'The name of the vault.'
  Property Attributes
  • get_job_output_prop ⇒ 'vault_name'
  • read_only ⇒ false
  • source ⇒ "get_job_output"
  • default ⇒ Proc.new { self.name }

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job_output.rb', line 18
  
  property :vault_name, get_job_output_prop: 'vault_name', type: [String], read_only: false, source: "get_job_output", description: 'The name of the vault.', default: Proc.new { self.name }

• #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: Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received. 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. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range. 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 S3 Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.'
  Property Attributes
  • get_job_output_prop ⇒ 'range'
  • read_only ⇒ false
  • source ⇒ "get_job_output"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job_output.rb', line 19
  
  property :range, get_job_output_prop: 'range', type: [String], read_only: false, source: "get_job_output", description: '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:
  
  
  Download a 128 MB chunk of output by specifying the appropriate
  byte range. Verify that all 128 MB of data was received.
  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.
  Repeat steps 1 and 2 for all the eight 128 MB chunks of output
  data, each time specifying the appropriate byte range.
  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 S3 Glacier. You compare this value with the checksum you
  computed to ensure you have downloaded the entire archive content
  with no errors.'

• #account ⇒ [MintPress::Aws::Glacier::Account]
  'The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single "-" (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ("-") in the ID.'
  Property Attributes
  • get_job_output_prop ⇒ 'account_id'
  • read_only ⇒ false
  • source ⇒ "get_job_output"
  • from ⇒ String

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job_output.rb', line 48
  
  property :account, get_job_output_prop: 'account_id', type: [MintPress::Aws::Glacier::Account], read_only: false, source: "get_job_output", description: 'The AccountId value is the AWS account ID of the account that owns
  the vault. You can either specify an AWS account ID or optionally a
  single "-" (hyphen), in which case Amazon S3 Glacier uses the AWS
  account ID associated with the credentials used to sign the request.
  If you use an account ID, do not include any hyphens ("-") in the
  ID.', from: String

• #id ⇒ [String]
  'The job ID whose data is downloaded.'
  Property Attributes
  • get_job_output_prop ⇒ 'job_id'
  • read_only ⇒ false
  • source ⇒ "get_job_output"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job_output.rb', line 54
  
  property :id, get_job_output_prop: 'job_id', type: [String], read_only: false, source: "get_job_output", description: 'The job ID whose data is downloaded.', array: false, hash: false

• #name ⇒ [String]
  
  Property Attributes

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job_output.rb', line 55
  
  property :name, type: [String]

• #region ⇒ String
  Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
  Property Attributes

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job_output.rb', line 59
  
  property :region, type: String

• #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
  The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
  Property Attributes
  • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job_output.rb', line 62
  
  property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary

• #get ⇒ Object
• #initialize(opts = {}) ⇒ JobOutput constructor
  A new instance of JobOutput.

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ JobOutput

Returns a new instance of JobOutput.

Instance Method Details

#get ⇒ Object