Class: UU::UDS::Bucket::BucketCreate

Inherits:
OS::REST::DTO show all
Defined in:
uu_uds-0.26.16/lib/uu/uds/bucket/bucket_create.rb

Overview

DTO for creation of the new bucket.

Instance Attribute Summary (collapse)

Method Summary

Methods inherited from OS::REST::DTO

#initialize, #to_hash, #to_json

Constructor Details

This class inherits a constructor from UU::OS::REST::DTO

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class UU::OS::REST::DTO

Instance Attribute Details

- (Fixnum) blob_timeout

Time (in minutes) after which blobs in this bucket will be automatically deleted. Use -1 for unlimited blob timeout.

Parameters:

  • (Fixnum)

Returns:

  • (Fixnum)


37
38
39
# File 'uu_uds-0.26.16/lib/uu/uds/bucket/bucket_create.rb', line 37

def blob_timeout
  @blob_timeout
end

- (Fixnum) capacity

Capacity of the bucket (in megabytes). Use -1 for unlimited capacity (must be allowed by system configuration). If not set, then maximum capacity allowed by system configuration is used.

Parameters:

  • (Fixnum)

Returns:

  • (Fixnum)


31
32
33
# File 'uu_uds-0.26.16/lib/uu/uds/bucket/bucket_create.rb', line 31

def capacity
  @capacity
end

- (String) code

Code of the bucket (must be unique).

Parameters:

  • (String)

Returns:

  • (String)


14
15
16
# File 'uu_uds-0.26.16/lib/uu/uds/bucket/bucket_create.rb', line 14

def code
  @code
end

- (String) description

Description of the bucket.

Parameters:

  • (String)

Returns:

  • (String)


24
25
26
# File 'uu_uds-0.26.16/lib/uu/uds/bucket/bucket_create.rb', line 24

def description
  @description
end

- (Fixnum) max_blob_size

Maximum allowed size of single blob (in megabytes, must not be greater than capacity). If not set (or set to -1), then the maximum blob size is dynamic, based on bucket remaining capacity.

Parameters:

  • (Fixnum)

Returns:

  • (Fixnum)


44
45
46
# File 'uu_uds-0.26.16/lib/uu/uds/bucket/bucket_create.rb', line 44

def max_blob_size
  @max_blob_size
end

- (Fixnum) max_total_size_per_app

Maximum total size allowed to be stored by single application (in megabytes). If not set (or set to -1) no size limit per application is applied.

Parameters:

  • (Fixnum)

Returns:

  • (Fixnum)


56
57
58
# File 'uu_uds-0.26.16/lib/uu/uds/bucket/bucket_create.rb', line 56

def max_total_size_per_app
  @max_total_size_per_app
end

- (Fixnum) max_total_size_per_user

Maximum total size allowed to be stored by single user (in megabytes). If not set (or set to -1) no size limit per user is applied.

Parameters:

  • (Fixnum)

Returns:

  • (Fixnum)


50
51
52
# File 'uu_uds-0.26.16/lib/uu/uds/bucket/bucket_create.rb', line 50

def max_total_size_per_user
  @max_total_size_per_user
end

- (String) name

Name of the bucket.

Parameters:

  • (String)

Returns:

  • (String)


19
20
21
# File 'uu_uds-0.26.16/lib/uu/uds/bucket/bucket_create.rb', line 19

def name
  @name
end

- (TrueClass, FalseClass) restricted

If set to true (default) bucket is created only for specified AppBox (or App instance). In this case only this particular application can manipulate with blobs. If set to false bucket is public for any application, but blob manipulation is restricted to user which created particular blob.

Parameters:

  • (TrueClass, FalseClass)

Returns:

  • (TrueClass, FalseClass)


64
65
66
# File 'uu_uds-0.26.16/lib/uu/uds/bucket/bucket_create.rb', line 64

def restricted
  @restricted
end