ObjectNameFilter

class oci.object_storage.models.ObjectNameFilter(**kwargs)

Bases: object

A filter that compares object names to a set of prefixes or patterns to determine if a rule applies to a given object. The filter can contain include glob patterns, exclude glob patterns and inclusion prefixes. The inclusion prefixes property is kept for backward compatibility. It is recommended to use inclusion patterns instead of prefixes. Exclusions take precedence over inclusions.

__init__(**kwargs)

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

Parameters:
  • inclusion_prefixes (list[str]) -- The value to assign to the inclusion_prefixes property of this ObjectNameFilter.
  • inclusion_patterns (list[str]) -- The value to assign to the inclusion_patterns property of this ObjectNameFilter.
  • exclusion_patterns (list[str]) -- The value to assign to the exclusion_patterns property of this ObjectNameFilter.
exclusion_patterns

Gets the exclusion_patterns of this ObjectNameFilter. An array of glob patterns to match the object names to exclude. An empty array is ignored. Exclusion patterns take precedence over inclusion patterns. A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other than the special pattern characters described below, matches itself.

Glob patterns must be between 1 and 1024 characters.

The special pattern characters have the following meanings:

Escapes the following character * Matches any string of characters. ? Matches any single character . [...] Matches a group of characters. A group of characters can be:

A set of characters, for example: [Zafg9@]. This matches any character in the brackets. A range of characters, for example: [a-z]. This matches any character in the range.

[a-f] is equivalent to [abcdef]. For character ranges only the CHARACTER-CHARACTER pattern is supported.

[ab-yz] is not valid [a-mn-z] is not valid

Character ranges can not start with ^ or : To include a '-' in the range, make it the first or last character.

Returns:The exclusion_patterns of this ObjectNameFilter.
Return type:list[str]
inclusion_patterns

Gets the inclusion_patterns of this ObjectNameFilter. An array of glob patterns to match the object names to include. An empty array includes all objects in the bucket. Exclusion patterns take precedence over inclusion patterns. A Glob pattern is a sequence of characters to match text. Any character that appears in the pattern, other than the special pattern characters described below, matches itself.

Glob patterns must be between 1 and 1024 characters.

The special pattern characters have the following meanings:

Escapes the following character * Matches any string of characters. ? Matches any single character . [...] Matches a group of characters. A group of characters can be:

A set of characters, for example: [Zafg9@]. This matches any character in the brackets. A range of characters, for example: [a-z]. This matches any character in the range.

[a-f] is equivalent to [abcdef]. For character ranges only the CHARACTER-CHARACTER pattern is supported.

[ab-yz] is not valid [a-mn-z] is not valid

Character ranges can not start with ^ or : To include a '-' in the range, make it the first or last character.

Returns:The inclusion_patterns of this ObjectNameFilter.
Return type:list[str]
inclusion_prefixes

Gets the inclusion_prefixes of this ObjectNameFilter. An array of object name prefixes that the rule will apply to. An empty array means to include all objects.

Returns:The inclusion_prefixes of this ObjectNameFilter.
Return type:list[str]