Class: MintPress::Aws::S3::Part

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

Properties (Read/Write)

  • #etag ⇒ [String]
    'Entity tag returned when the part was uploaded.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::S3::Part"
    • orig_name ⇒ 'etag'
    

17
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/part.rb', line 17

property :etag, disposition: :attribute, description: 'Entity tag returned when the part was uploaded.', source: "MintPress::Aws::S3::Part", orig_name: 'etag', type: [String]
  • #last_modified ⇒ [Time]
    'Date and time at which the part was uploaded.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::S3::Part"
    • orig_name ⇒ 'last_modified'
    

18
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/part.rb', line 18

property :last_modified, disposition: :attribute, description: 'Date and time at which the part was uploaded.', source: "MintPress::Aws::S3::Part", orig_name: 'last_modified', type: [Time]
  • #part_number ⇒ [Integer]
    'Part number identifying the part.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::S3::Part"
    • orig_name ⇒ 'part_number'
    

19
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/part.rb', line 19

property :part_number, disposition: :attribute, description: 'Part number identifying the part.', source: "MintPress::Aws::S3::Part", orig_name: 'part_number', type: [Integer]
  • #size ⇒ [Integer]
    'Size in bytes of the uploaded part data.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::S3::Part"
    • orig_name ⇒ 'size'
    

20
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/part.rb', line 20

property :size, disposition: :attribute, description: 'Size in bytes of the uploaded part data.', source: "MintPress::Aws::S3::Part", orig_name: 'size', type: [Integer]
  • #bucket ⇒ [String]
    'The name of the bucket to which the parts are being uploaded. When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide. When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.'
    Property Attributes
    • list_parts_prop ⇒ 'bucket'
    • read_only ⇒ false
    • source ⇒ "list_parts"
    

21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/part.rb', line 21

property :bucket, list_parts_prop: 'bucket', type: [String], read_only: false, source: "list_parts", description: 'The name of the bucket to which the parts are being uploaded.

When using this API with an access point, you must direct requests to
the access point hostname. The access point hostname takes the form
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
When using this operation with an access point through the AWS SDKs,
you provide the access point ARN in place of the bucket name. For more
information about access point ARNs, see Using Access Points in
the Amazon Simple Storage Service Developer Guide.

When using this API with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
When using this operation using S3 on Outposts through the AWS SDKs,
you provide the Outposts bucket ARN in place of the bucket name. For
more information about S3 on Outposts ARNs, see Using S3 on
Outposts in the Amazon Simple Storage Service Developer Guide.'
  • #key ⇒ [String] (Default Value: Proc.new { self.name })
    'Object key for which the multipart upload was initiated.'
    Property Attributes
    • list_parts_prop ⇒ 'key'
    • read_only ⇒ false
    • source ⇒ "list_parts"
    • default ⇒ Proc.new { self.name }
    

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

property :key, list_parts_prop: 'key', type: [String], read_only: false, source: "list_parts", description: 'Object key for which the multipart upload was initiated.', default: Proc.new { self.name }
  • #max_parts ⇒ [Integer]
    'Sets the maximum number of parts to return.'
    Property Attributes
    • list_parts_prop ⇒ 'max_parts'
    • read_only ⇒ false
    • source ⇒ "list_parts"
    

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

property :max_parts, list_parts_prop: 'max_parts', type: [Integer], read_only: false, source: "list_parts", description: 'Sets the maximum number of parts to return.'
  • #part_number_marker ⇒ [Integer]
    'Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.'
    Property Attributes
    • list_parts_prop ⇒ 'part_number_marker'
    • read_only ⇒ false
    • source ⇒ "list_parts"
    

41
42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/part.rb', line 41

property :part_number_marker, list_parts_prop: 'part_number_marker', type: [Integer], read_only: false, source: "list_parts", description: 'Specifies the part after which listing should begin. Only parts with
higher part numbers will be listed.'
  • #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
    • list_parts_prop ⇒ 'request_payer'
    • read_only ⇒ false
    • source ⇒ "list_parts"
    

43
44
45
46
47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/part.rb', line 43

property :request_payer, list_parts_prop: 'request_payer', type: [String], read_only: false, source: "list_parts", 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
    • list_parts_prop ⇒ 'expected_bucket_owner'
    • read_only ⇒ false
    • source ⇒ "list_parts"
    

48
49
50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/part.rb', line 48

property :expected_bucket_owner, list_parts_prop: 'expected_bucket_owner', type: [String], read_only: false, source: "list_parts", 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.'
  • #upload ⇒ [String]
    'Upload ID identifying the multipart upload whose parts are being listed.'
    Property Attributes
    • list_parts_prop ⇒ 'upload_id'
    • read_only ⇒ false
    • source ⇒ "list_parts"
    

51
52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/part.rb', line 51

property :upload, list_parts_prop: 'upload_id', type: [String], read_only: false, source: "list_parts", description: 'Upload ID identifying the multipart upload whose parts are being
listed.'
  • #name ⇒ String

    Property Attributes 
    

53
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/part.rb', line 53

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 
    

57
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/part.rb', line 57

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
    

60
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/part.rb', line 60

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

Returns a new instance of Part.

Instance Method Details

#list ⇒ Object