gravitino.api.fileset_change.FilesetChange¶
- class gravitino.api.fileset_change.FilesetChange¶
Bases:
ABC
A fileset change is a change to a fileset. It can be used to rename a fileset, update the comment of a fileset, set a property and value pair for a fileset, or remove a property from a fileset.
- __init__()¶
Methods
__init__
()Creates a new fileset change to remove comment from the fileset.
remove_property
(fileset_property)Creates a new fileset change to remove a property from the fileset.
rename
(new_name)Creates a new fileset change to rename the fileset.
set_property
(fileset_property, value)Creates a new fileset change to set the property and value for the fileset.
update_comment
(new_comment)Creates a new fileset change to update the fileset comment.
- class RemoveComment¶
Bases:
object
A fileset change to remove comment from the fileset.
- Deprecated:
Please use UpdateFilesetComment(str) with null value as the argument instead.
- class RemoveProperty(_property: str)¶
Bases:
object
A fileset change to remove a property from the fileset.
- property()¶
Retrieves the name of the property to be removed from the fileset.
- Returns:
The name of the property for removal.
- class RenameFileset(_new_name: str)¶
Bases:
object
A fileset change to rename the fileset.
- new_name()¶
Retrieves the new name set for the fileset.
- Returns:
The new name of the fileset.
- class SetProperty(_property: str, _value: str)¶
Bases:
object
A fileset change to set the property and value for the fileset.
- property()¶
Retrieves the name of the property being set in the fileset.
- Returns:
The name of the property.
- value()¶
Retrieves the value assigned to the property in the fileset.
- Returns:
The value of the property.
- class UpdateFilesetComment(_new_comment: str)¶
Bases:
object
A fileset change to update the fileset comment.
- new_comment()¶
Retrieves the new comment intended for the fileset.
- Returns:
The new comment that has been set for the fileset.
- static remove_comment()¶
Creates a new fileset change to remove comment from the fileset.
- Returns:
The fileset change.
- Deprecated:
Please use update_comment(str) with null value as the argument instead.
- static remove_property(fileset_property)¶
Creates a new fileset change to remove a property from the fileset.
- Args:
fileset_property: The property name to remove.
- Returns:
The fileset change.
- static rename(new_name)¶
Creates a new fileset change to rename the fileset.
- Args:
new_name: The new name of the fileset.
- Returns:
The fileset change.
- static set_property(fileset_property, value)¶
Creates a new fileset change to set the property and value for the fileset.
- Args:
fileset_property: The property name to set. value: The value to set the property to.
- Returns:
The fileset change.
- static update_comment(new_comment)¶
Creates a new fileset change to update the fileset comment.
- Args:
new_comment: The new comment for the fileset.
- Returns:
The fileset change.