Module pachyderm_sdk.api.snapshot

Classes

class CreateSnapshotRequest (metadata: Dict[str, str] = None)

CreateSnapshotRequest(metadata: Dict[str, str] = None)

Expand source code

@dataclass(eq=False, repr=False)
class CreateSnapshotRequest(betterproto.Message):
    metadata: Dict[str, str] = betterproto.map_field(
        1, betterproto.TYPE_STRING, betterproto.TYPE_STRING
    )

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var metadata : Dict[str, str]

class CreateSnapshotResponse (id: int = None)

CreateSnapshotResponse(id: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class CreateSnapshotResponse(betterproto.Message):
    id: int = betterproto.int64_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var id : int

class DeleteSnapshotRequest (id: int = None)

DeleteSnapshotRequest(id: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class DeleteSnapshotRequest(betterproto.Message):
    id: int = betterproto.int64_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var id : int

class DeleteSnapshotResponse

DeleteSnapshotResponse()

Expand source code

@dataclass(eq=False, repr=False)
class DeleteSnapshotResponse(betterproto.Message):
    pass

Ancestors

• betterproto.Message
• abc.ABC

class SnapshotInfo (id: int = None, metadata: Dict[str, str] = None, chunkset_id: int = None, sql_dump_fileset_id: str = None, pachyderm_version: str = None, created_at: datetime.datetime = None)

SnapshotInfo(id: int = None, metadata: Dict[str, str] = None, chunkset_id: int = None, sql_dump_fileset_id: str = None, pachyderm_version: str = None, created_at: datetime.datetime = None)

Expand source code

@dataclass(eq=False, repr=False)
class SnapshotInfo(betterproto.Message):
    id: int = betterproto.int64_field(1)
    metadata: Dict[str, str] = betterproto.map_field(
        2, betterproto.TYPE_STRING, betterproto.TYPE_STRING
    )
    chunkset_id: int = betterproto.int64_field(3)
    sql_dump_fileset_id: str = betterproto.string_field(4)
    pachyderm_version: str = betterproto.string_field(5)
    created_at: datetime = betterproto.message_field(6)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var id : int

var metadata : Dict[str, str]

var chunkset_id : int

var sql_dump_fileset_id : str

var pachyderm_version : str

var created_at : datetime.datetime

class InspectSnapshotRequest (id: int = None)

InspectSnapshotRequest(id: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class InspectSnapshotRequest(betterproto.Message):
    id: int = betterproto.int64_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var id : int

class InspectSnapshotResponse (info: SnapshotInfo = None)

InspectSnapshotResponse(info: 'SnapshotInfo' = None)

Expand source code

@dataclass(eq=False, repr=False)
class InspectSnapshotResponse(betterproto.Message):
    info: "SnapshotInfo" = betterproto.message_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var info : SnapshotInfo

class ListSnapshotRequest (since: datetime.datetime = None, limit: int = None)

ListSnapshotRequest(since: datetime.datetime = None, limit: int = None)

Expand source code

@dataclass(eq=False, repr=False)
class ListSnapshotRequest(betterproto.Message):
    since: datetime = betterproto.message_field(1)
    limit: int = betterproto.int32_field(2)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var since : datetime.datetime

var limit : int

class ListSnapshotResponse (info: SnapshotInfo = None)

ListSnapshotResponse(info: 'SnapshotInfo' = None)

Expand source code

@dataclass(eq=False, repr=False)
class ListSnapshotResponse(betterproto.Message):
    info: "SnapshotInfo" = betterproto.message_field(1)

Ancestors

• betterproto.Message
• abc.ABC

Class variables

var info : SnapshotInfo

class ApiStub (channel: grpc.Channel)

Expand source code

class ApiStub:

    def __init__(self, channel: "grpc.Channel"):
        self.__rpc_create_snapshot = channel.unary_unary(
            "/snapshot.API/CreateSnapshot",
            request_serializer=CreateSnapshotRequest.SerializeToString,
            response_deserializer=CreateSnapshotResponse.FromString,
        )
        self.__rpc_delete_snapshot = channel.unary_unary(
            "/snapshot.API/DeleteSnapshot",
            request_serializer=DeleteSnapshotRequest.SerializeToString,
            response_deserializer=DeleteSnapshotResponse.FromString,
        )
        self.__rpc_inspect_snapshot = channel.unary_unary(
            "/snapshot.API/InspectSnapshot",
            request_serializer=InspectSnapshotRequest.SerializeToString,
            response_deserializer=InspectSnapshotResponse.FromString,
        )
        self.__rpc_list_snapshot = channel.unary_stream(
            "/snapshot.API/ListSnapshot",
            request_serializer=ListSnapshotRequest.SerializeToString,
            response_deserializer=ListSnapshotResponse.FromString,
        )

    def create_snapshot(
        self, *, metadata: Dict[str, str] = None
    ) -> "CreateSnapshotResponse":

        request = CreateSnapshotRequest()
        request.metadata = metadata

        return self.__rpc_create_snapshot(request)

    def delete_snapshot(self, *, id: int = 0) -> "DeleteSnapshotResponse":

        request = DeleteSnapshotRequest()
        request.id = id

        return self.__rpc_delete_snapshot(request)

    def inspect_snapshot(self, *, id: int = 0) -> "InspectSnapshotResponse":

        request = InspectSnapshotRequest()
        request.id = id

        return self.__rpc_inspect_snapshot(request)

    def list_snapshot(
        self, *, since: datetime = None, limit: int = 0
    ) -> Iterator["ListSnapshotResponse"]:

        request = ListSnapshotRequest()
        if since is not None:
            request.since = since
        request.limit = limit

        for response in self.__rpc_list_snapshot(request):
            yield response

Methods

def create_snapshot(self, *, metadata: Dict[str, str] = None) ‑> CreateSnapshotResponse

Expand source code

def create_snapshot(
    self, *, metadata: Dict[str, str] = None
) -> "CreateSnapshotResponse":

    request = CreateSnapshotRequest()
    request.metadata = metadata

    return self.__rpc_create_snapshot(request)

def delete_snapshot(self, *, id: int = 0) ‑> DeleteSnapshotResponse

Expand source code

def delete_snapshot(self, *, id: int = 0) -> "DeleteSnapshotResponse":

    request = DeleteSnapshotRequest()
    request.id = id

    return self.__rpc_delete_snapshot(request)

def inspect_snapshot(self, *, id: int = 0) ‑> InspectSnapshotResponse

Expand source code

def inspect_snapshot(self, *, id: int = 0) -> "InspectSnapshotResponse":

    request = InspectSnapshotRequest()
    request.id = id

    return self.__rpc_inspect_snapshot(request)

def list_snapshot(self, *, since: datetime.datetime = None, limit: int = 0) ‑> Iterator[ListSnapshotResponse]

Expand source code

def list_snapshot(
    self, *, since: datetime = None, limit: int = 0
) -> Iterator["ListSnapshotResponse"]:

    request = ListSnapshotRequest()
    if since is not None:
        request.since = since
    request.limit = limit

    for response in self.__rpc_list_snapshot(request):
        yield response