BucketSummary¶

class oci.object_storage.models.BucketSummary(**kwargs)¶

Bases: object

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.

Methods:

__init__(**kwargs)

Initializes a new BucketSummary object with values from keyword arguments.

Attributes:

`bucket_scope`	Gets the bucket_scope of this BucketSummary.
`compartment_id`	[Required] Gets the compartment_id of this BucketSummary.
`created_by`	[Required] Gets the created_by of this BucketSummary.
`defined_tags`	Gets the defined_tags of this BucketSummary.
`etag`	[Required] Gets the etag of this BucketSummary.
`freeform_tags`	Gets the freeform_tags of this BucketSummary.
`name`	[Required] Gets the name of this BucketSummary.
`namespace`	[Required] Gets the namespace of this BucketSummary.
`time_created`	[Required] Gets the time_created of this BucketSummary.

__init__(**kwargs)¶

Initializes a new BucketSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

namespace (str) – The value to assign to the namespace property of this BucketSummary.
name (str) – The value to assign to the name property of this BucketSummary.
compartment_id (str) – The value to assign to the compartment_id property of this BucketSummary.
created_by (str) – The value to assign to the created_by property of this BucketSummary.
time_created (datetime) – The value to assign to the time_created property of this BucketSummary.
etag (str) – The value to assign to the etag property of this BucketSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this BucketSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this BucketSummary.
bucket_scope (str) – The value to assign to the bucket_scope property of this BucketSummary.

property bucket_scope¶

Gets the bucket_scope of this BucketSummary. The bucket scope determines weather the bucket name must be unique within the tenancy and region (essentially the namespace) or across all tenancies in the region. The bucket scope also determines if the bucket supports S3 virtual-hosted style URL’s or not.

Allowed values: NAMESPACE: Only supports path-style bucket access, bucket name only needs to be unique within the tenancy and region. REGION: Supports both path-style and virtual-hosted URL style access, bucket name needs to be unique across all tenancies in the region.

Returns: The bucket_scope of this BucketSummary.
Return type: str

property compartment_id¶

[Required] Gets the compartment_id of this BucketSummary. The compartment ID in which the bucket is authorized.

Returns: The compartment_id of this BucketSummary.
Return type: str

property created_by¶

[Required] Gets the created_by of this BucketSummary. The OCID of the user who created the bucket.

Returns: The created_by of this BucketSummary.
Return type: str

property defined_tags¶

Gets the defined_tags of this BucketSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns: The defined_tags of this BucketSummary.
Return type: dict(str, dict(str, object))

property etag¶

[Required] Gets the etag of this BucketSummary. The entity tag (ETag) for the bucket.

Returns: The etag of this BucketSummary.
Return type: str

property freeform_tags¶

Gets the freeform_tags of this BucketSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

Returns: The freeform_tags of this BucketSummary.
Return type: dict(str, str)

property name¶

[Required] Gets the name of this BucketSummary. The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

Returns: The name of this BucketSummary.
Return type: str

property namespace¶

[Required] Gets the namespace of this BucketSummary. The Object Storage namespace in which the bucket lives.

Returns: The namespace of this BucketSummary.
Return type: str

property time_created¶

[Required] Gets the time_created of this BucketSummary. The date and time the bucket was created, as described in RFC 2616.

Returns: The time_created of this BucketSummary.
Return type: datetime