Class: MintPress::Aws::S3::ObjectTorrent

Inherits:

Object

• Object
• MintPress::Aws::S3::ObjectTorrent

Includes:

MintLogger, AwsCommon, Mixins::Properties

Defined in:

src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_torrent.rb

Properties (Read/Write)

• #response_target ⇒ []
  'Where to write response data, file path, or IO object.'
  Property Attributes
  • get_object_torrent_prop ⇒ 'response_target'
  • read_only ⇒ false
  • source ⇒ "get_object_torrent"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_torrent.rb', line 17
  
  property :response_target, get_object_torrent_prop: 'response_target', type: [], read_only: false, source: "get_object_torrent", description: 'Where to write response data, file path, or IO object.'

• #bucket ⇒ [String]
  'The name of the bucket containing the object for which to get the torrent files.'
  Property Attributes
  • get_object_torrent_prop ⇒ 'bucket'
  • read_only ⇒ false
  • source ⇒ "get_object_torrent"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_torrent.rb', line 18
  
  property :bucket, get_object_torrent_prop: 'bucket', type: [String], read_only: false, source: "get_object_torrent", description: 'The name of the bucket containing the object for which to get the
  torrent files.'

• #key ⇒ [String] (Default Value: Proc.new { self.name })
  'The object key for which to get the information.'
  Property Attributes
  • get_object_torrent_prop ⇒ 'key'
  • read_only ⇒ false
  • source ⇒ "get_object_torrent"
  • default ⇒ Proc.new { self.name }

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_torrent.rb', line 20
  
  property :key, get_object_torrent_prop: 'key', type: [String], read_only: false, source: "get_object_torrent", description: 'The object key for which to get the information.', default: Proc.new { self.name }

• #request_payer ⇒ [String]
  'Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.'
  Property Attributes
  • get_object_torrent_prop ⇒ 'request_payer'
  • read_only ⇒ false
  • source ⇒ "get_object_torrent"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_torrent.rb', line 21
  
  property :request_payer, get_object_torrent_prop: 'request_payer', type: [String], read_only: false, source: "get_object_torrent", description: 'Confirms that the requester knows that they will be charged for the
  request. Bucket owners need not specify this parameter in their
  requests. For information about downloading objects from requester
  pays buckets, see Downloading Objects in Requestor Pays Buckets
  in the Amazon S3 Developer Guide.'

• #expected_bucket_owner ⇒ [String]
  'The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.'
  Property Attributes
  • get_object_torrent_prop ⇒ 'expected_bucket_owner'
  • read_only ⇒ false
  • source ⇒ "get_object_torrent"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_torrent.rb', line 26
  
  property :expected_bucket_owner, get_object_torrent_prop: 'expected_bucket_owner', type: [String], read_only: false, source: "get_object_torrent", description: 'The account id of the expected bucket owner. If the bucket is owned by
  a different account, the request will fail with an HTTP 403 (Access
  Denied) error.'

• #name ⇒ String
  
  Property Attributes

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_torrent.rb', line 29
  
  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/s3/object_torrent.rb', line 33
  
  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/s3/object_torrent.rb', line 36
  
  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 = {}) ⇒ ObjectTorrent constructor
  A new instance of ObjectTorrent.

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

Returns a new instance of ObjectTorrent.

Instance Method Details

#get ⇒ Object