Skip to content

Immutable

get_project_immutable_tag_rules(project_name_or_id, query=None, sort=None, page=1, page_size=10, limit=None) async

Get the immutable tag rules for a project.

Parameters:

Name Type Description Default
project_name_or_id Union[str, int]

The name or ID of the project. String arguments are treated as project names. Integer arguments are treated as project IDs.

required
query Optional[str]

A query string to filter the immutable tag rules

None
sort Optional[str]

The sort order of the rules

None
page int

The page of results to return

1
page_size int

The number of results to return per page

10
limit Optional[int]

The maximum number of results to return

None

Returns:

Type Description
List[ImmutableRule]

The immutable tag rules for the project.

create_project_immutable_tag_rule(project_name_or_id, rule) async

Create an immutable tag rule for a project.

Parameters:

Name Type Description Default
project_name_or_id Union[str, int]

The name or ID of the project. String arguments are treated as project names. Integer arguments are treated as project IDs.

required
rule ImmutableRule

The immutable tag rule to create.

required

Returns:

Type Description
str

The location of the created immutable tag rule.

update_project_immutable_tag_rule(project_name_or_id, immutable_rule_id, rule) async

Update an immutable tag rule for a project.

Parameters:

Name Type Description Default
project_name_or_id Union[str, int]

The name or ID of the project. String arguments are treated as project names. Integer arguments are treated as project IDs.

required
immutable_rule_id int

The ID of the immutable tag rule.

required
rule ImmutableRule

The updated immutable tag rule.

required

enable_project_immutable_tagrule(project_name_or_id, immutable_rule_id, enabled=True) async

Enable or disable an immutable tag rule for a project.

Parameters:

Name Type Description Default
project_name_or_id Union[str, int]

The name or ID of the project. String arguments are treated as project names. Integer arguments are treated as project IDs.

required
immutable_rule_id int

The ID of the immutable tag rule.

required
enabled bool

Whether to enable or disable the rule.

True

delete_project_immutable_tag_rule(project_name_or_id, immutable_rule_id) async

Delete an immutable tag rule for a project.

Parameters:

Name Type Description Default
project_name_or_id Union[str, int]

The name or ID of the project. String arguments are treated as project names. Integer arguments are treated as project IDs.

required
immutable_rule_id int

The ID of the immutable tag rule.

required