nebius.api.nebius.storage.v1.BucketPolicy.Rule

class documentation

class Rule(pb_classes.Message): (source)

Constructor: BucketPolicy.Rule(initial_message, paths, roles, group_id, ...)

View In Hierarchy

Undocumented

Class __OneOfClass_subject__ Undocumented
Class __OneOfClass_subject_anonymous__ Undocumented
Class __OneOfClass_subject_group_id__ Undocumented
Class AnonymousAccess Undocumented
Method __dir__ Undocumented
Method __init__ Create a wrapper around a protobuf message instance.
Method anonymous.setter Undocumented
Method group_id.setter Undocumented
Method paths.setter Undocumented
Method roles.setter Undocumented
Constant __PB2_DESCRIPTOR__ Undocumented
Constant __PY_TO_PB2__ Undocumented
Class Variable __mask_functions__ Undocumented
Property anonymous Enable anonymous access. Only read-only roles are allowed in anonymous mode.
Property group_id Group ID to grant access to.
Property paths A list of paths each of which is either a full object key or a prefix ending with a single "" wildcard character. A rule is only applied to objects matching any of paths. If there is a path equal to "", a rule applies to a whole bucket.
Property roles A set of roles which a subject will have. All storage.* roles are supported.
Property subject A subject of a rule.

Inherited from Message:

Class Method get_descriptor Return the protobuf descriptor for this message class.
Class Method is_credentials Return True if the field contains credentials.
Class Method is_sensitive Return True if the field is marked as sensitive.
Method __repr__ Return a human-readable representation of the message, sanitizing sensitive fields.
Method check_presence Check explicit presence for a field in the protobuf message.
Method get_full_update_reset_mask Build a reset mask for a full update of this message.
Method get_mask Return the tracked reset mask.
Method is_default Return True if a field equals its default value.
Method set_mask Replace the tracked reset mask.
Method which_field_in_oneof Return the set field name for a given oneof.
Instance Variable __PB2_CLASS__ Protobuf message class associated with this wrapper.
Instance Variable __pb2_message__ Underlying protobuf message instance.
Method _clear_field Clear a field and record it in the reset mask.
Method _get_field Return a field value with optional wrapping and presence handling.
Method _set_field Set a field value and update the reset mask.
Class Variable __credentials_fields Undocumented
Class Variable __default Undocumented
Class Variable __sensitive_fields Undocumented
Instance Variable __recorded_reset_mask Mask tracking fields cleared or set to default.
def __dir__(self) -> abc.Iterable[builtins.str]: (source)

Undocumented

def __init__(self, initial_message: message_1.Message | None = None, *, paths: abc.Iterable[builtins.str] | None | unset.UnsetType = unset.Unset, roles: abc.Iterable[builtins.str] | None | unset.UnsetType = unset.Unset, group_id: builtins.str | None | unset.UnsetType = unset.Unset, anonymous: BucketPolicy.Rule.AnonymousAccess | bucket_policy_pb2.BucketPolicy.Rule.AnonymousAccess | None | unset.UnsetType = unset.Unset): (source)
overrides nebius.base.protos.pb_classes.Message.__init__

Create a wrapper around a protobuf message instance.

Raises
AttributeErrorIf the wrapper is missing required class metadata.
@anonymous.setter
def anonymous(self, value: BucketPolicy.Rule.AnonymousAccess | bucket_policy_pb2.BucketPolicy.Rule.AnonymousAccess | None): (source)

Undocumented

@group_id.setter
def group_id(self, value: builtins.str | None): (source)

Undocumented

@paths.setter
def paths(self, value: abc.Iterable[builtins.str] | None): (source)

Undocumented

@roles.setter
def roles(self, value: abc.Iterable[builtins.str] | None): (source)

Undocumented

__PB2_DESCRIPTOR__ = (source)
overrides nebius.base.protos.pb_classes.Message.__PB2_DESCRIPTOR__

Undocumented

Value
descriptor.DescriptorWrap[descriptor_1.Descriptor]('.nebius.storage.v1.BucketPol↵
icy.Rule',
                                                   bucket_policy_pb2.DESCRIPTOR,
                                                   descriptor_1.Descriptor)
__PY_TO_PB2__: builtins.dict[builtins.str, builtins.str] = (source)
overrides nebius.base.protos.pb_classes.Message.__PY_TO_PB2__

Undocumented

Value
{'paths': 'paths',
 'roles': 'roles',
 'group_id': 'group_id',
 'anonymous': 'anonymous',
 'AnonymousAccess': 'AnonymousAccess',
 'subject': 'subject'}
__mask_functions__: dict = (source)
overrides nebius.base.protos.pb_classes.Message.__mask_functions__

Undocumented

@builtins.property
anonymous: BucketPolicy.Rule.AnonymousAccess | None = (source)

Enable anonymous access. Only read-only roles are allowed in anonymous mode.

@builtins.property
group_id: builtins.str | None = (source)

Group ID to grant access to.

@builtins.property
paths: abc.MutableSequence[builtins.str] = (source)

A list of paths each of which is either a full object key or a prefix ending with a single "" wildcard character. A rule is only applied to objects matching any of paths. If there is a path equal to "", a rule applies to a whole bucket.

@builtins.property
roles: abc.MutableSequence[builtins.str] = (source)

A set of roles which a subject will have. All storage.* roles are supported.

@builtins.property
subject: __OneOfClass_subject_group_id__ | __OneOfClass_subject_anonymous__ | None = (source)

A subject of a rule.