221 lines
12 KiB
Python
221 lines
12 KiB
Python
# archive-control-proto commit: 03b6751d420e8e4e4cc9aeef4f76b13e28a7265f
|
|
import datetime
|
|
|
|
from archive_control.v1 import common_pb2 as _common_pb2
|
|
from archive_control.v1 import resource_pb2 as _resource_pb2
|
|
from google.protobuf import timestamp_pb2 as _timestamp_pb2
|
|
from google.protobuf.internal import containers as _containers
|
|
from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
|
|
from google.protobuf import descriptor as _descriptor
|
|
from google.protobuf import message as _message
|
|
from collections.abc import Iterable as _Iterable, Mapping as _Mapping
|
|
from typing import ClassVar as _ClassVar, Optional as _Optional, Union as _Union
|
|
|
|
DESCRIPTOR: _descriptor.FileDescriptor
|
|
|
|
class JobOperation(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
|
|
__slots__ = ()
|
|
JOB_OPERATION_UNSPECIFIED: _ClassVar[JobOperation]
|
|
JOB_OPERATION_ARCHIVE: _ClassVar[JobOperation]
|
|
JOB_OPERATION_UNARCHIVE: _ClassVar[JobOperation]
|
|
JOB_OPERATION_EVICT_CACHE: _ClassVar[JobOperation]
|
|
|
|
class JobState(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
|
|
__slots__ = ()
|
|
JOB_STATE_UNSPECIFIED: _ClassVar[JobState]
|
|
JOB_STATE_QUEUED: _ClassVar[JobState]
|
|
JOB_STATE_PREPARING: _ClassVar[JobState]
|
|
JOB_STATE_RUNNING: _ClassVar[JobState]
|
|
JOB_STATE_WAITING: _ClassVar[JobState]
|
|
JOB_STATE_STALLED: _ClassVar[JobState]
|
|
JOB_STATE_CANCELLING: _ClassVar[JobState]
|
|
JOB_STATE_ROLLING_BACK: _ClassVar[JobState]
|
|
JOB_STATE_CLEANUP_REQUIRED: _ClassVar[JobState]
|
|
JOB_STATE_SUCCEEDED: _ClassVar[JobState]
|
|
JOB_STATE_FAILED: _ClassVar[JobState]
|
|
JOB_STATE_CANCELLED: _ClassVar[JobState]
|
|
|
|
class JobStepKind(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
|
|
__slots__ = ()
|
|
JOB_STEP_KIND_UNSPECIFIED: _ClassVar[JobStepKind]
|
|
JOB_STEP_KIND_ROUTE_SETUP: _ClassVar[JobStepKind]
|
|
JOB_STEP_KIND_PREFLIGHT: _ClassVar[JobStepKind]
|
|
JOB_STEP_KIND_SOURCE_STAGE: _ClassVar[JobStepKind]
|
|
JOB_STEP_KIND_SYNCTHING_TRANSFER: _ClassVar[JobStepKind]
|
|
JOB_STEP_KIND_TARGET_MATERIALIZE: _ClassVar[JobStepKind]
|
|
JOB_STEP_KIND_QB_VERIFY: _ClassVar[JobStepKind]
|
|
JOB_STEP_KIND_STAGING_CLEANUP: _ClassVar[JobStepKind]
|
|
JOB_STEP_KIND_VERIFY_ARCHIVE_COVERAGE: _ClassVar[JobStepKind]
|
|
JOB_STEP_KIND_QB_REMOVE_ENTRY: _ClassVar[JobStepKind]
|
|
JOB_STEP_KIND_SAFE_FILE_UNLINK: _ClassVar[JobStepKind]
|
|
JOB_STEP_KIND_ROLLBACK: _ClassVar[JobStepKind]
|
|
|
|
class StepState(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
|
|
__slots__ = ()
|
|
STEP_STATE_UNSPECIFIED: _ClassVar[StepState]
|
|
STEP_STATE_NOT_STARTED: _ClassVar[StepState]
|
|
STEP_STATE_QUEUED: _ClassVar[StepState]
|
|
STEP_STATE_RUNNING: _ClassVar[StepState]
|
|
STEP_STATE_WAITING: _ClassVar[StepState]
|
|
STEP_STATE_STALLED: _ClassVar[StepState]
|
|
STEP_STATE_SUCCEEDED: _ClassVar[StepState]
|
|
STEP_STATE_FAILED: _ClassVar[StepState]
|
|
STEP_STATE_CANCELLED: _ClassVar[StepState]
|
|
JOB_OPERATION_UNSPECIFIED: JobOperation
|
|
JOB_OPERATION_ARCHIVE: JobOperation
|
|
JOB_OPERATION_UNARCHIVE: JobOperation
|
|
JOB_OPERATION_EVICT_CACHE: JobOperation
|
|
JOB_STATE_UNSPECIFIED: JobState
|
|
JOB_STATE_QUEUED: JobState
|
|
JOB_STATE_PREPARING: JobState
|
|
JOB_STATE_RUNNING: JobState
|
|
JOB_STATE_WAITING: JobState
|
|
JOB_STATE_STALLED: JobState
|
|
JOB_STATE_CANCELLING: JobState
|
|
JOB_STATE_ROLLING_BACK: JobState
|
|
JOB_STATE_CLEANUP_REQUIRED: JobState
|
|
JOB_STATE_SUCCEEDED: JobState
|
|
JOB_STATE_FAILED: JobState
|
|
JOB_STATE_CANCELLED: JobState
|
|
JOB_STEP_KIND_UNSPECIFIED: JobStepKind
|
|
JOB_STEP_KIND_ROUTE_SETUP: JobStepKind
|
|
JOB_STEP_KIND_PREFLIGHT: JobStepKind
|
|
JOB_STEP_KIND_SOURCE_STAGE: JobStepKind
|
|
JOB_STEP_KIND_SYNCTHING_TRANSFER: JobStepKind
|
|
JOB_STEP_KIND_TARGET_MATERIALIZE: JobStepKind
|
|
JOB_STEP_KIND_QB_VERIFY: JobStepKind
|
|
JOB_STEP_KIND_STAGING_CLEANUP: JobStepKind
|
|
JOB_STEP_KIND_VERIFY_ARCHIVE_COVERAGE: JobStepKind
|
|
JOB_STEP_KIND_QB_REMOVE_ENTRY: JobStepKind
|
|
JOB_STEP_KIND_SAFE_FILE_UNLINK: JobStepKind
|
|
JOB_STEP_KIND_ROLLBACK: JobStepKind
|
|
STEP_STATE_UNSPECIFIED: StepState
|
|
STEP_STATE_NOT_STARTED: StepState
|
|
STEP_STATE_QUEUED: StepState
|
|
STEP_STATE_RUNNING: StepState
|
|
STEP_STATE_WAITING: StepState
|
|
STEP_STATE_STALLED: StepState
|
|
STEP_STATE_SUCCEEDED: StepState
|
|
STEP_STATE_FAILED: StepState
|
|
STEP_STATE_CANCELLED: StepState
|
|
|
|
class TransferJobSpec(_message.Message):
|
|
__slots__ = ("source_client_id", "target_client_id", "route_id", "requested_files", "source_fingerprint", "target_baseline_fingerprint", "expected_target_placement_generation", "target_baseline_files", "transfer_delta_files", "requested_logical_bytes", "transfer_delta_logical_bytes")
|
|
SOURCE_CLIENT_ID_FIELD_NUMBER: _ClassVar[int]
|
|
TARGET_CLIENT_ID_FIELD_NUMBER: _ClassVar[int]
|
|
ROUTE_ID_FIELD_NUMBER: _ClassVar[int]
|
|
REQUESTED_FILES_FIELD_NUMBER: _ClassVar[int]
|
|
SOURCE_FINGERPRINT_FIELD_NUMBER: _ClassVar[int]
|
|
TARGET_BASELINE_FINGERPRINT_FIELD_NUMBER: _ClassVar[int]
|
|
EXPECTED_TARGET_PLACEMENT_GENERATION_FIELD_NUMBER: _ClassVar[int]
|
|
TARGET_BASELINE_FILES_FIELD_NUMBER: _ClassVar[int]
|
|
TRANSFER_DELTA_FILES_FIELD_NUMBER: _ClassVar[int]
|
|
REQUESTED_LOGICAL_BYTES_FIELD_NUMBER: _ClassVar[int]
|
|
TRANSFER_DELTA_LOGICAL_BYTES_FIELD_NUMBER: _ClassVar[int]
|
|
source_client_id: str
|
|
target_client_id: str
|
|
route_id: str
|
|
requested_files: _resource_pb2.SelectionSet
|
|
source_fingerprint: _resource_pb2.ResourceStateFingerprint
|
|
target_baseline_fingerprint: _resource_pb2.ResourceStateFingerprint
|
|
expected_target_placement_generation: int
|
|
target_baseline_files: _resource_pb2.SelectionSet
|
|
transfer_delta_files: _resource_pb2.SelectionSet
|
|
requested_logical_bytes: int
|
|
transfer_delta_logical_bytes: int
|
|
def __init__(self, source_client_id: _Optional[str] = ..., target_client_id: _Optional[str] = ..., route_id: _Optional[str] = ..., requested_files: _Optional[_Union[_resource_pb2.SelectionSet, _Mapping]] = ..., source_fingerprint: _Optional[_Union[_resource_pb2.ResourceStateFingerprint, _Mapping]] = ..., target_baseline_fingerprint: _Optional[_Union[_resource_pb2.ResourceStateFingerprint, _Mapping]] = ..., expected_target_placement_generation: _Optional[int] = ..., target_baseline_files: _Optional[_Union[_resource_pb2.SelectionSet, _Mapping]] = ..., transfer_delta_files: _Optional[_Union[_resource_pb2.SelectionSet, _Mapping]] = ..., requested_logical_bytes: _Optional[int] = ..., transfer_delta_logical_bytes: _Optional[int] = ...) -> None: ...
|
|
|
|
class ArchiveCoverage(_message.Message):
|
|
__slots__ = ("archive_client_id", "covered_files", "placement_generation", "fingerprint")
|
|
ARCHIVE_CLIENT_ID_FIELD_NUMBER: _ClassVar[int]
|
|
COVERED_FILES_FIELD_NUMBER: _ClassVar[int]
|
|
PLACEMENT_GENERATION_FIELD_NUMBER: _ClassVar[int]
|
|
FINGERPRINT_FIELD_NUMBER: _ClassVar[int]
|
|
archive_client_id: str
|
|
covered_files: _resource_pb2.SelectionSet
|
|
placement_generation: int
|
|
fingerprint: _resource_pb2.ResourceStateFingerprint
|
|
def __init__(self, archive_client_id: _Optional[str] = ..., covered_files: _Optional[_Union[_resource_pb2.SelectionSet, _Mapping]] = ..., placement_generation: _Optional[int] = ..., fingerprint: _Optional[_Union[_resource_pb2.ResourceStateFingerprint, _Mapping]] = ...) -> None: ...
|
|
|
|
class EvictionJobSpec(_message.Message):
|
|
__slots__ = ("cache_client_id", "files_to_evict", "cache_placement_generation", "cache_fingerprint", "archive_coverage")
|
|
CACHE_CLIENT_ID_FIELD_NUMBER: _ClassVar[int]
|
|
FILES_TO_EVICT_FIELD_NUMBER: _ClassVar[int]
|
|
CACHE_PLACEMENT_GENERATION_FIELD_NUMBER: _ClassVar[int]
|
|
CACHE_FINGERPRINT_FIELD_NUMBER: _ClassVar[int]
|
|
ARCHIVE_COVERAGE_FIELD_NUMBER: _ClassVar[int]
|
|
cache_client_id: str
|
|
files_to_evict: _resource_pb2.SelectionSet
|
|
cache_placement_generation: int
|
|
cache_fingerprint: _resource_pb2.ResourceStateFingerprint
|
|
archive_coverage: _containers.RepeatedCompositeFieldContainer[ArchiveCoverage]
|
|
def __init__(self, cache_client_id: _Optional[str] = ..., files_to_evict: _Optional[_Union[_resource_pb2.SelectionSet, _Mapping]] = ..., cache_placement_generation: _Optional[int] = ..., cache_fingerprint: _Optional[_Union[_resource_pb2.ResourceStateFingerprint, _Mapping]] = ..., archive_coverage: _Optional[_Iterable[_Union[ArchiveCoverage, _Mapping]]] = ...) -> None: ...
|
|
|
|
class JobDefinition(_message.Message):
|
|
__slots__ = ("job_id", "idempotency_key", "operation", "resource_id", "resource_display_name", "created_at", "transfer", "eviction")
|
|
JOB_ID_FIELD_NUMBER: _ClassVar[int]
|
|
IDEMPOTENCY_KEY_FIELD_NUMBER: _ClassVar[int]
|
|
OPERATION_FIELD_NUMBER: _ClassVar[int]
|
|
RESOURCE_ID_FIELD_NUMBER: _ClassVar[int]
|
|
RESOURCE_DISPLAY_NAME_FIELD_NUMBER: _ClassVar[int]
|
|
CREATED_AT_FIELD_NUMBER: _ClassVar[int]
|
|
TRANSFER_FIELD_NUMBER: _ClassVar[int]
|
|
EVICTION_FIELD_NUMBER: _ClassVar[int]
|
|
job_id: str
|
|
idempotency_key: str
|
|
operation: JobOperation
|
|
resource_id: _resource_pb2.ResourceId
|
|
resource_display_name: str
|
|
created_at: _timestamp_pb2.Timestamp
|
|
transfer: TransferJobSpec
|
|
eviction: EvictionJobSpec
|
|
def __init__(self, job_id: _Optional[str] = ..., idempotency_key: _Optional[str] = ..., operation: _Optional[_Union[JobOperation, str]] = ..., resource_id: _Optional[_Union[_resource_pb2.ResourceId, _Mapping]] = ..., resource_display_name: _Optional[str] = ..., created_at: _Optional[_Union[datetime.datetime, _timestamp_pb2.Timestamp, _Mapping]] = ..., transfer: _Optional[_Union[TransferJobSpec, _Mapping]] = ..., eviction: _Optional[_Union[EvictionJobSpec, _Mapping]] = ...) -> None: ...
|
|
|
|
class JobProgress(_message.Message):
|
|
__slots__ = ("step", "display_step_number", "display_step_total", "state", "fraction_complete", "bytes_complete", "bytes_total", "approximate_bytes_per_second", "detail", "last_progress_at", "overall_fraction_complete")
|
|
STEP_FIELD_NUMBER: _ClassVar[int]
|
|
DISPLAY_STEP_NUMBER_FIELD_NUMBER: _ClassVar[int]
|
|
DISPLAY_STEP_TOTAL_FIELD_NUMBER: _ClassVar[int]
|
|
STATE_FIELD_NUMBER: _ClassVar[int]
|
|
FRACTION_COMPLETE_FIELD_NUMBER: _ClassVar[int]
|
|
BYTES_COMPLETE_FIELD_NUMBER: _ClassVar[int]
|
|
BYTES_TOTAL_FIELD_NUMBER: _ClassVar[int]
|
|
APPROXIMATE_BYTES_PER_SECOND_FIELD_NUMBER: _ClassVar[int]
|
|
DETAIL_FIELD_NUMBER: _ClassVar[int]
|
|
LAST_PROGRESS_AT_FIELD_NUMBER: _ClassVar[int]
|
|
OVERALL_FRACTION_COMPLETE_FIELD_NUMBER: _ClassVar[int]
|
|
step: JobStepKind
|
|
display_step_number: int
|
|
display_step_total: int
|
|
state: StepState
|
|
fraction_complete: float
|
|
bytes_complete: int
|
|
bytes_total: int
|
|
approximate_bytes_per_second: float
|
|
detail: str
|
|
last_progress_at: _timestamp_pb2.Timestamp
|
|
overall_fraction_complete: float
|
|
def __init__(self, step: _Optional[_Union[JobStepKind, str]] = ..., display_step_number: _Optional[int] = ..., display_step_total: _Optional[int] = ..., state: _Optional[_Union[StepState, str]] = ..., fraction_complete: _Optional[float] = ..., bytes_complete: _Optional[int] = ..., bytes_total: _Optional[int] = ..., approximate_bytes_per_second: _Optional[float] = ..., detail: _Optional[str] = ..., last_progress_at: _Optional[_Union[datetime.datetime, _timestamp_pb2.Timestamp, _Mapping]] = ..., overall_fraction_complete: _Optional[float] = ...) -> None: ...
|
|
|
|
class JobRecord(_message.Message):
|
|
__slots__ = ("definition", "state", "committed", "revision", "progress", "error", "updated_at", "committed_at", "finished_at")
|
|
DEFINITION_FIELD_NUMBER: _ClassVar[int]
|
|
STATE_FIELD_NUMBER: _ClassVar[int]
|
|
COMMITTED_FIELD_NUMBER: _ClassVar[int]
|
|
REVISION_FIELD_NUMBER: _ClassVar[int]
|
|
PROGRESS_FIELD_NUMBER: _ClassVar[int]
|
|
ERROR_FIELD_NUMBER: _ClassVar[int]
|
|
UPDATED_AT_FIELD_NUMBER: _ClassVar[int]
|
|
COMMITTED_AT_FIELD_NUMBER: _ClassVar[int]
|
|
FINISHED_AT_FIELD_NUMBER: _ClassVar[int]
|
|
definition: JobDefinition
|
|
state: JobState
|
|
committed: bool
|
|
revision: int
|
|
progress: JobProgress
|
|
error: _common_pb2.Error
|
|
updated_at: _timestamp_pb2.Timestamp
|
|
committed_at: _timestamp_pb2.Timestamp
|
|
finished_at: _timestamp_pb2.Timestamp
|
|
def __init__(self, definition: _Optional[_Union[JobDefinition, _Mapping]] = ..., state: _Optional[_Union[JobState, str]] = ..., committed: _Optional[bool] = ..., revision: _Optional[int] = ..., progress: _Optional[_Union[JobProgress, _Mapping]] = ..., error: _Optional[_Union[_common_pb2.Error, _Mapping]] = ..., updated_at: _Optional[_Union[datetime.datetime, _timestamp_pb2.Timestamp, _Mapping]] = ..., committed_at: _Optional[_Union[datetime.datetime, _timestamp_pb2.Timestamp, _Mapping]] = ..., finished_at: _Optional[_Union[datetime.datetime, _timestamp_pb2.Timestamp, _Mapping]] = ...) -> None: ...
|