Class: MintPress::Aws::Glacier::Job

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb

Properties (Read/Write)

  • #vault_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The name of the vault.'
    Property Attributes
    • describe_job_prop ⇒ 'vault_name'
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • list_jobs_prop ⇒ 'vault_name'
    • disposition ⇒ :read_only_attribute
    • read_only ⇒ false
    • orig_name ⇒ 'vault_name'
    • default ⇒ Proc.new { self.name }
    

25
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 25

property :vault_name, describe_job_prop: 'vault_name', type: [String], source: "MintPress::Aws::Glacier::Job", description: 'The name of the vault.', list_jobs_prop: 'vault_name', disposition: :read_only_attribute, read_only: false, orig_name: 'vault_name', default: Proc.new { self.name }
  • #limit ⇒ [Integer]
    'The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.'
    Property Attributes
    • list_jobs_prop ⇒ 'limit'
    • read_only ⇒ false
    • source ⇒ "list_jobs"
    

26
27
28
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 26

property :limit, list_jobs_prop: 'limit', type: [Integer], read_only: false, source: "list_jobs", description: 'The maximum number of jobs to be returned. The default limit is 50.
The number of jobs returned might be fewer than the specified limit,
but the number of returned jobs never exceeds the limit.'
  • #statuscode ⇒ [String]
    'The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.'
    Property Attributes
    • list_jobs_prop ⇒ 'statuscode'
    • read_only ⇒ false
    • source ⇒ "list_jobs"
    

29
30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 29

property :statuscode, list_jobs_prop: 'statuscode', type: [String], read_only: false, source: "list_jobs", description: 'The type of job status to return. You can specify the following
values: InProgress, Succeeded, or Failed.'
  • #completed ⇒ [TrueClass,FalseClass]
    'The job status.'
    Property Attributes
    • list_jobs_prop ⇒ 'completed'
    • disposition ⇒ :read_only_attribute
    • read_only ⇒ false
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'completed'
    

31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 31

property :completed, list_jobs_prop: 'completed', type: [TrueClass,FalseClass], disposition: :read_only_attribute, read_only: false, source: "MintPress::Aws::Glacier::Job", description: 'The job status.', orig_name: 'completed'
  • #vault ⇒ [MintPress::Aws::Glacier::Vault] (Default Value: MintPress::Aws::Glacier::Vault.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'vault'
    • default ⇒ MintPress::Aws::Glacier::Vault.new
    

51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 51

property :vault, disposition: :association, source: "MintPress::Aws::Glacier::Job", orig_name: 'vault', type: [MintPress::Aws::Glacier::Vault], default: MintPress::Aws::Glacier::Vault.new
  • #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
    • describe_job_prop ⇒ 'account_id'
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • list_jobs_prop ⇒ 'account_id'
    • disposition ⇒ :read_only_attribute
    • read_only ⇒ false
    • orig_name ⇒ 'account_id'
    • from ⇒ String
    

52
53
54
55
56
57
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 52

property :account, describe_job_prop: 'account_id', type: [MintPress::Aws::Glacier::Account], source: "MintPress::Aws::Glacier::Job", 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.', list_jobs_prop: 'account_id', disposition: :read_only_attribute, read_only: false, orig_name: 'account_id', from: String
  • #name ⇒ [String]

    Property Attributes 
    

59
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 59

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 
    

63
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 63

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
    

66
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 66

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

  • #action ⇒ [String]
    'The job type.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'action'
    

32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 32

property :action, read_only: true, disposition: :read_only_attribute, description: 'The job type.', source: "MintPress::Aws::Glacier::Job", orig_name: 'action', type: [String]
  • #archive_sha256_tree_hash ⇒ [String]
    'The SHA256 tree hash of the entire archive for an archive retrieval.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'archive_sha256_tree_hash'
    

33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 33

property :archive_sha256_tree_hash, read_only: true, disposition: :read_only_attribute, description: 'The SHA256 tree hash of the entire archive for an archive retrieval.', source: "MintPress::Aws::Glacier::Job", orig_name: 'archive_sha256_tree_hash', type: [String]
  • #archive_size_in_bytes ⇒ [Integer]
    'For an archive retrieval job, this value is the size in bytes of the archive being requested for download.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'archive_size_in_bytes'
    

34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 34

property :archive_size_in_bytes, read_only: true, disposition: :read_only_attribute, description: 'For an archive retrieval job, this value is the size in bytes of the archive being requested for download.', source: "MintPress::Aws::Glacier::Job", orig_name: 'archive_size_in_bytes', type: [Integer]
  • #completion_date ⇒ [Time]
    'The UTC time that the job request completed.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'completion_date'
    

35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 35

property :completion_date, read_only: true, disposition: :read_only_attribute, description: 'The UTC time that the job request completed.', source: "MintPress::Aws::Glacier::Job", orig_name: 'completion_date', type: [Time]
  • #creation_date ⇒ [Time]
    'The UTC date when the job was created.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'creation_date'
    

36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 36

property :creation_date, read_only: true, disposition: :read_only_attribute, description: 'The UTC date when the job was created.', source: "MintPress::Aws::Glacier::Job", orig_name: 'creation_date', type: [Time]
  • #id ⇒ [String]
    'The ID of the job to describe.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "describe_job"
    • orig_name ⇒ 'id'
    • describe_job_prop ⇒ 'job_id'
    

37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 37

property :id, read_only: true, disposition: :read_only_attribute, description: 'The ID of the job to describe.', source: "describe_job", orig_name: 'id', type: [String], describe_job_prop: 'job_id', array: false, hash: false
  • #inventory_retrieval_parameters ⇒ [MintPress::Aws::Glacier::InventoryRetrievalJobDescription] (Default Value: MintPress::Aws::Glacier::InventoryRetrievalJobDescription.new)
    'Parameters used for range inventory retrieval.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'inventory_retrieval_parameters'
    • default ⇒ MintPress::Aws::Glacier::InventoryRetrievalJobDescription.new
    

38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 38

property :inventory_retrieval_parameters, read_only: true, disposition: :read_only_attribute, description: 'Parameters used for range inventory retrieval.', source: "MintPress::Aws::Glacier::Job", orig_name: 'inventory_retrieval_parameters', type: [MintPress::Aws::Glacier::InventoryRetrievalJobDescription], default: MintPress::Aws::Glacier::InventoryRetrievalJobDescription.new
  • #inventory_size_in_bytes ⇒ [Integer]
    'For an inventory retrieval job, this value is the size in bytes of the inventory requested for download.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'inventory_size_in_bytes'
    

39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 39

property :inventory_size_in_bytes, read_only: true, disposition: :read_only_attribute, description: 'For an inventory retrieval job, this value is the size in bytes of the inventory requested for download.', source: "MintPress::Aws::Glacier::Job", orig_name: 'inventory_size_in_bytes', type: [Integer]
  • #job_description ⇒ [String]
    'The job description provided when initiating the job.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'job_description'
    

40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 40

property :job_description, read_only: true, disposition: :read_only_attribute, description: 'The job description provided when initiating the job.', source: "MintPress::Aws::Glacier::Job", orig_name: 'job_description', type: [String]
  • #job_output_path ⇒ [String]
    'Contains the job output location.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'job_output_path'
    

41
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 41

property :job_output_path, read_only: true, disposition: :read_only_attribute, description: 'Contains the job output location.', source: "MintPress::Aws::Glacier::Job", orig_name: 'job_output_path', type: [String]
  • #output_location ⇒ [MintPress::Aws::Glacier::OutputLocation] (Default Value: MintPress::Aws::Glacier::OutputLocation.new)
    'Contains the location where the data from the select job is stored.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'output_location'
    • default ⇒ MintPress::Aws::Glacier::OutputLocation.new
    

42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 42

property :output_location, read_only: true, disposition: :read_only_attribute, description: 'Contains the location where the data from the select job is stored.', source: "MintPress::Aws::Glacier::Job", orig_name: 'output_location', type: [MintPress::Aws::Glacier::OutputLocation], default: MintPress::Aws::Glacier::OutputLocation.new
  • #retrieval_byte_range ⇒ [String]
    'The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'retrieval_byte_range'
    

43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 43

property :retrieval_byte_range, read_only: true, disposition: :read_only_attribute, description: 'The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue.', source: "MintPress::Aws::Glacier::Job", orig_name: 'retrieval_byte_range', type: [String]
  • #select_parameters ⇒ [MintPress::Aws::Glacier::SelectParameter] (Default Value: MintPress::Aws::Glacier::SelectParameter.new)
    'Contains the parameters used for a select.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'select_parameters'
    • default ⇒ MintPress::Aws::Glacier::SelectParameter.new
    

44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 44

property :select_parameters, read_only: true, disposition: :read_only_attribute, description: 'Contains the parameters used for a select.', source: "MintPress::Aws::Glacier::Job", orig_name: 'select_parameters', type: [MintPress::Aws::Glacier::SelectParameter], default: MintPress::Aws::Glacier::SelectParameter.new
  • #sha256_tree_hash ⇒ [String]
    'For an archive retrieval job, this value is the checksum of the archive.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'sha256_tree_hash'
    

45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 45

property :sha256_tree_hash, read_only: true, disposition: :read_only_attribute, description: 'For an archive retrieval job, this value is the checksum of the archive.', source: "MintPress::Aws::Glacier::Job", orig_name: 'sha256_tree_hash', type: [String]
  • #sns_topic ⇒ [String]
    'An Amazon SNS topic that receives notification.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'sns_topic'
    

46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 46

property :sns_topic, read_only: true, disposition: :read_only_attribute, description: 'An Amazon SNS topic that receives notification.', source: "MintPress::Aws::Glacier::Job", orig_name: 'sns_topic', type: [String]
  • #status_code ⇒ [String]
    'The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'status_code'
    

47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 47

property :status_code, read_only: true, disposition: :read_only_attribute, description: 'The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.', source: "MintPress::Aws::Glacier::Job", orig_name: 'status_code', type: [String]
  • #status_message ⇒ [String]
    'A friendly message that describes the job status.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'status_message'
    

48
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 48

property :status_message, read_only: true, disposition: :read_only_attribute, description: 'A friendly message that describes the job status.', source: "MintPress::Aws::Glacier::Job", orig_name: 'status_message', type: [String]
  • #tier ⇒ [String]
    'The tier to use for a select or an archive retrieval.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'tier'
    

49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 49

property :tier, read_only: true, disposition: :read_only_attribute, description: 'The tier to use for a select or an archive retrieval.', source: "MintPress::Aws::Glacier::Job", orig_name: 'tier', type: [String]
  • #vault_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'vault_arn'
    

50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 50

property :vault_arn, read_only: true, disposition: :read_only_attribute, description: 'The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.', source: "MintPress::Aws::Glacier::Job", orig_name: 'vault_arn', type: [String]
  • #archive ⇒ [MintPress::Aws::Glacier::Archive]
    'The archive ID requested for a select job or archive retrieval.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::Glacier::Job"
    • orig_name ⇒ 'archive_id'
    • from ⇒ String
    

58
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/glacier/job.rb', line 58

property :archive, read_only: true, disposition: :read_only_attribute, description: 'The archive ID requested for a select job or archive retrieval.', source: "MintPress::Aws::Glacier::Job", orig_name: 'archive_id', type: [MintPress::Aws::Glacier::Archive], from: String

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 collapse

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 = {}) ⇒ Job

Returns a new instance of Job.

Instance Method Details

#describe ⇒ Object

#list ⇒ Object