openstack.object_store.v1.container

openstack.object_store.v1.container

The Container Class

The Container class inherits from Resource.

class openstack.object_store.v1.container.Container(attrs=None, loaded=False)

Construct a Resource to interact with a service’s REST API.

The Resource class offers two class methods to construct resource objects, which are preferrable to entering through this initializer. See Resource.new() and Resource.existing().

Parameters:
  • attrs (dict) – The attributes to set when constructing this Resource.
  • loaded (bool) – True if this Resource exists on the server, False if it does not.
name = None

The name of the container.

count = None

The number of objects in the container.

bytes = None

The total number of bytes that are stored in Object Storage for the container.

object_count = None

The number of objects.

bytes_used = None

The count of bytes used in total.

timestamp = None

The timestamp of the transaction.

is_newest = None

If set to True, Object Storage queries all replicas to return the most recent one. If you omit this header, Object Storage responds faster after it finds one valid replica. Because setting this header to True is more expensive for the back end, use it only when it is absolutely needed. Type: bool

read_ACL = None

The ACL that grants read access. If not set, this header is not returned by this operation.

write_ACL = None

The ACL that grants write access. If not set, this header is not returned by this operation.

sync_to = None

The destination for container synchronization. If not set, this header is not returned by this operation.

sync_key = None

The secret key for container synchronization. If not set, this header is not returned by this operation.

versions_location = None

Enables versioning on this container. The value is the name of another container. You must UTF-8-encode and then URL-encode the name before you include it in the header. To disable versioning, set the header to an empty string.

content_type = None

The MIME type of the list of names.

is_content_type_detected = None

If set to true, Object Storage guesses the content type based on the file extension and ignores the value sent in the Content-Type header, if present. Type: bool

if_none_match = None

In combination with Expect: 100-Continue, specify an “If-None-Match: *” header to query whether the server already has a copy of the object before any data is sent.

classmethod create_by_id(session, attrs, resource_id=None)

Create a Resource from its attributes.

Parameters:
  • session (Session) – The session to use for making this request.
  • attrs (dict) – The attributes to be sent in the body of the request.
  • resource_id – This resource’s identifier, if needed by the request. The default is None.
Returns:

A dict representing the response headers.

create(session)

Create a Resource from this instance.

Parameters:session (Session) – The session to use for making this request.
Returns:This instance.
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.