Module pachyderm_sdk.api.metadata

Classes

class ClusterPicker

ClusterPicker selects a cluster. Since clusters will never "cascade", there is only one cluster that can be selected, the one running this API server.

Expand source code

@dataclass(eq=False, repr=False)
class ClusterPicker(betterproto.Message):
    """
    ClusterPicker selects a cluster.  Since clusters will never "cascade",
    there is only one cluster that can be selected, the one running this API
    server.
    """

    pass

Ancestors

• betterproto.Message
• abc.ABC

class Edit (project: _pfs__.ProjectPicker = None, commit: _pfs__.CommitPicker = None, branch: _pfs__.BranchPicker = None, repo: _pfs__.RepoPicker = None, cluster: ClusterPicker = None, pipeline: _pps__.PipelinePicker = None, replace: EditReplace = None, add_key: EditAddKey = None, edit_key: EditEditKey = None, delete_key: EditDeleteKey = None)

Edit represents editing one piece of metadata.

Expand source code

@dataclass(eq=False, repr=False)
class Edit(betterproto.Message):
    """Edit represents editing one piece of metadata."""

    project: "_pfs__.ProjectPicker" = betterproto.message_field(1, group="target")
    """project targets a named project's metadata."""

    commit: "_pfs__.CommitPicker" = betterproto.message_field(2, group="target")
    """commit targets a commit's metadata."""

    branch: "_pfs__.BranchPicker" = betterproto.message_field(3, group="target")
    """branch targets a branch's metadata."""

    repo: "_pfs__.RepoPicker" = betterproto.message_field(4, group="target")
    """repo targets a repo's metadata."""

    cluster: "ClusterPicker" = betterproto.message_field(5, group="target")
    """cluster targets the cluster's metadata."""

    pipeline: "_pps__.PipelinePicker" = betterproto.message_field(6, group="target")
    """pipeline targets a pipeline."""

    replace: "EditReplace" = betterproto.message_field(10, group="op")
    """replace replaces a target's metadata with a new metadata mapping."""

    add_key: "EditAddKey" = betterproto.message_field(11, group="op")
    """add_key adds a new key to the target object's metadata."""

    edit_key: "EditEditKey" = betterproto.message_field(12, group="op")
    """edit_key adds or changes a key in the target object's metadata."""

    delete_key: "EditDeleteKey" = betterproto.message_field(13, group="op")
    """delete_key removes a key from the target object's metadata."""

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var project : ProjectPicker

project targets a named project's metadata.

var commit : CommitPicker

commit targets a commit's metadata.

var branch : BranchPicker

branch targets a branch's metadata.

var repo : RepoPicker

repo targets a repo's metadata.

var cluster : ClusterPicker

cluster targets the cluster's metadata.

var pipeline : PipelinePicker

pipeline targets a pipeline.

var replace : EditReplace

replace replaces a target's metadata with a new metadata mapping.

var add_key : EditAddKey

add_key adds a new key to the target object's metadata.

var edit_key : EditEditKey

edit_key adds or changes a key in the target object's metadata.

var delete_key : EditDeleteKey

delete_key removes a key from the target object's metadata.

class EditReplace (replacement: Dict[str, str] = None)

Replace is an operation that replaces metadata.

Expand source code

@dataclass(eq=False, repr=False)
class EditReplace(betterproto.Message):
    """Replace is an operation that replaces metadata."""

    replacement: Dict[str, str] = betterproto.map_field(
        1, betterproto.TYPE_STRING, betterproto.TYPE_STRING
    )
    """replacement is the map to replace the object's metadata with."""

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var replacement : Dict[str, str]

replacement is the map to replace the object's metadata with.

class EditAddKey (key: str = None, value: str = None)

AddKey is an operation that adds a new metadata key.

Expand source code

@dataclass(eq=False, repr=False)
class EditAddKey(betterproto.Message):
    """AddKey is an operation that adds a new metadata key."""

    key: str = betterproto.string_field(1)
    """key is the metadata key to add.  It may not be the empty string."""

    value: str = betterproto.string_field(2)
    """value is the value to assign to the metadata key."""

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var key : str

key is the metadata key to add. It may not be the empty string.

var value : str

value is the value to assign to the metadata key.

class EditEditKey (key: str = None, value: str = None)

EditKey is an operation that changes or adds a metadata key.

Expand source code

@dataclass(eq=False, repr=False)
class EditEditKey(betterproto.Message):
    """EditKey is an operation that changes or adds a metadata key."""

    key: str = betterproto.string_field(1)
    """
    key is the metadata key to change or add.  It may not be the empty string.
    """

    value: str = betterproto.string_field(2)
    """value is the value to assign to the metadata key."""

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var key : str

key is the metadata key to change or add. It may not be the empty string.

var value : str

value is the value to assign to the metadata key.

class EditDeleteKey (key: str = None)

DeleteKey is an operation that removes a metadata key.

Expand source code

@dataclass(eq=False, repr=False)
class EditDeleteKey(betterproto.Message):
    """DeleteKey is an operation that removes a metadata key."""

    key: str = betterproto.string_field(1)
    """key is the metadata key to remove.  It may not be the empty string."""

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var key : str

key is the metadata key to remove. It may not be the empty string.

class EditMetadataRequest (edits: List[ForwardRef('Edit')] = None)

EditMetadataRequest is a sequence of edits to apply to metadata.

Expand source code

@dataclass(eq=False, repr=False)
class EditMetadataRequest(betterproto.Message):
    """EditMetadataRequest is a sequence of edits to apply to metadata."""

    edits: List["Edit"] = betterproto.message_field(1)
    """edits is the ordered list of metadata edits to perform."""

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var edits : List[Edit]

edits is the ordered list of metadata edits to perform.

class EditMetadataResponse

EditMetadataResponse is the result of editing metadata.

Expand source code

@dataclass(eq=False, repr=False)
class EditMetadataResponse(betterproto.Message):
    """EditMetadataResponse is the result of editing metadata."""

    pass

Ancestors

• betterproto.Message
• abc.ABC

class ApiStub (channel: grpc.Channel)

Expand source code

class ApiStub:

    def __init__(self, channel: "grpc.Channel"):
        self.__rpc_edit_metadata = channel.unary_unary(
            "/metadata.API/EditMetadata",
            request_serializer=EditMetadataRequest.SerializeToString,
            response_deserializer=EditMetadataResponse.FromString,
        )

    def edit_metadata(
        self, *, edits: Optional[List["Edit"]] = None
    ) -> "EditMetadataResponse":
        edits = edits or []

        request = EditMetadataRequest()
        if edits is not None:
            request.edits = edits

        return self.__rpc_edit_metadata(request)

Methods

def edit_metadata(self, *, edits: Optional[List[ForwardRef('Edit')]] = None) ‑> EditMetadataResponse

Expand source code

def edit_metadata(
    self, *, edits: Optional[List["Edit"]] = None
) -> "EditMetadataResponse":
    edits = edits or []

    request = EditMetadataRequest()
    if edits is not None:
        request.edits = edits

    return self.__rpc_edit_metadata(request)