Class: MintPress::Aws::S3::ObjectsV2

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

Properties (Read/Write)

  • #bucket ⇒ [String]
    'Bucket name to list. 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_objects_v2_prop ⇒ 'bucket'
    • read_only ⇒ false
    • source ⇒ "list_objects_v2"
    

17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/objects_v2.rb', line 17

property :bucket, list_objects_v2_prop: 'bucket', type: [String], read_only: false, source: "list_objects_v2", description: 'Bucket name to list.

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.'
  • #delimiter ⇒ [String]
    'A delimiter is a character you use to group keys.'
    Property Attributes
    • list_objects_v2_prop ⇒ 'delimiter'
    • read_only ⇒ false
    • source ⇒ "list_objects_v2"
    

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

property :delimiter, list_objects_v2_prop: 'delimiter', type: [String], read_only: false, source: "list_objects_v2", description: 'A delimiter is a character you use to group keys.'
  • #encoding_type ⇒ [String]
    'Encoding type used by Amazon S3 to encode object keys in the response.'
    Property Attributes
    • list_objects_v2_prop ⇒ 'encoding_type'
    • read_only ⇒ false
    • source ⇒ "list_objects_v2"
    

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

property :encoding_type, list_objects_v2_prop: 'encoding_type', type: [String], read_only: false, source: "list_objects_v2", description: 'Encoding type used by Amazon S3 to encode object keys in the response.'
  • #max_keys ⇒ [Integer]
    'Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.'
    Property Attributes
    • list_objects_v2_prop ⇒ 'max_keys'
    • read_only ⇒ false
    • source ⇒ "list_objects_v2"
    

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

property :max_keys, list_objects_v2_prop: 'max_keys', type: [Integer], read_only: false, source: "list_objects_v2", description: 'Sets the maximum number of keys returned in the response. By default
the API returns up to 1,000 key names. The response might contain
fewer keys but will never contain more.'
  • #prefix ⇒ [String]
    'Limits the response to keys that begin with the specified prefix.'
    Property Attributes
    • list_objects_v2_prop ⇒ 'prefix'
    • read_only ⇒ false
    • source ⇒ "list_objects_v2"
    

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

property :prefix, list_objects_v2_prop: 'prefix', type: [String], read_only: false, source: "list_objects_v2", description: 'Limits the response to keys that begin with the specified prefix.'
  • #continuation_token ⇒ [String]
    'ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.'
    Property Attributes
    • list_objects_v2_prop ⇒ 'continuation_token'
    • read_only ⇒ false
    • source ⇒ "list_objects_v2"
    

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

property :continuation_token, list_objects_v2_prop: 'continuation_token', type: [String], read_only: false, source: "list_objects_v2", description: 'ContinuationToken indicates Amazon S3 that the list is being continued
on this bucket with a token. ContinuationToken is obfuscated and is
not a real key.'
  • #fetch_owner ⇒ [TrueClass,FalseClass]
    'The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.'
    Property Attributes
    • list_objects_v2_prop ⇒ 'fetch_owner'
    • read_only ⇒ false
    • source ⇒ "list_objects_v2"
    

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

property :fetch_owner, list_objects_v2_prop: 'fetch_owner', type: [TrueClass,FalseClass], read_only: false, source: "list_objects_v2", description: 'The owner field is not present in listV2 by default, if you want to
return owner field with each key in the result then set the fetch
owner field to true.'
  • #start_after ⇒ [String]
    'StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.'
    Property Attributes
    • list_objects_v2_prop ⇒ 'start_after'
    • read_only ⇒ false
    • source ⇒ "list_objects_v2"
    

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

property :start_after, list_objects_v2_prop: 'start_after', type: [String], read_only: false, source: "list_objects_v2", description: 'StartAfter is where you want Amazon S3 to start listing from. Amazon
S3 starts listing after this specified key. StartAfter can be any key
in the bucket.'
  • #request_payer ⇒ [String]
    'Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.'
    Property Attributes
    • list_objects_v2_prop ⇒ 'request_payer'
    • read_only ⇒ false
    • source ⇒ "list_objects_v2"
    

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

property :request_payer, list_objects_v2_prop: 'request_payer', type: [String], read_only: false, source: "list_objects_v2", description: 'Confirms that the requester knows that she or he will be charged for
the list objects request in V2 style. Bucket owners need not specify
this parameter in their requests.'
  • #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_objects_v2_prop ⇒ 'expected_bucket_owner'
    • read_only ⇒ false
    • source ⇒ "list_objects_v2"
    

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

property :expected_bucket_owner, list_objects_v2_prop: 'expected_bucket_owner', type: [String], read_only: false, source: "list_objects_v2", 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.'
  • #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 
    

59
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/objects_v2.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
    

62
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/objects_v2.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 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 = {}) ⇒ ObjectsV2

Returns a new instance of ObjectsV2.

Instance Method Details

#list ⇒ Object