python_pachyderm.experimental.proto.v2.pps_v2 package

Module contents

class ActivateAuthRequest[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class ActivateAuthResponse[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

class Aggregate(count: int = <object object at 0x7f2cabcb78b0>, mean: float = <object object at 0x7f2cabcb78b0>, stddev: float = <object object at 0x7f2cabcb78b0>, fifth_percentile: float = <object object at 0x7f2cabcb78b0>, ninety_fifth_percentile: float = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

count = <object object>

fifth_percentile = <object object>

mean = <object object>

ninety_fifth_percentile = <object object>

stddev = <object object>

class AggregateProcessStats(download_time: 'Aggregate' = <object object at 0x7f2cabcb78b0>, process_time: 'Aggregate' = <object object at 0x7f2cabcb78b0>, upload_time: 'Aggregate' = <object object at 0x7f2cabcb78b0>, download_bytes: 'Aggregate' = <object object at 0x7f2cabcb78b0>, upload_bytes: 'Aggregate' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

download_bytes = <object object>

download_time = <object object>

process_time = <object object>

upload_bytes = <object object>

upload_time = <object object>

class ApiBase[source]

Bases: betterproto.grpc.grpclib_server.ServiceBase

Methods

activate_auth
create_pipeline
create_secret
delete_all
delete_job
delete_pipeline
delete_secret
get_logs
inspect_datum
inspect_job
inspect_job_set
inspect_pipeline
inspect_secret
list_datum
list_job
list_job_set
list_pipeline
list_secret
restart_datum
run_cron
run_load_test
run_load_test_default
run_pipeline
start_pipeline
stop_job
stop_pipeline
subscribe_job
update_job_state

async activate_auth()[source]

async create_pipeline(pipeline, tf_job, transform, parallelism_spec, egress, update, output_branch, s3_out, resource_requests, resource_limits, sidecar_resource_limits, input, description, reprocess, service, spout, datum_set_spec, datum_timeout, job_timeout, salt, datum_tries, scheduling_spec, pod_spec, pod_patch, spec_commit, metadata, reprocess_spec, autoscaling)[source]

async create_secret(file)[source]

async delete_all()[source]

async delete_job(job)[source]

async delete_pipeline(pipeline, all, force, keep_repo)[source]

async delete_secret(secret)[source]

async get_logs(pipeline, job, data_filters, datum, master, follow, tail, use_loki_backend, since)[source]

async inspect_datum(datum)[source]

async inspect_job(job, wait, details)[source]

async inspect_job_set(job_set, wait, details)[source]

async inspect_pipeline(pipeline, details)[source]

async inspect_secret(secret)[source]

async list_datum(job, input)[source]

async list_job(pipeline, input_commit, history, details, jq_filter)[source]

async list_job_set(details)[source]

async list_pipeline(pipeline, history, details, jq_filter)[source]

async list_secret()[source]

async restart_datum(job, data_filters)[source]

async run_cron(pipeline)[source]

async run_load_test(spec, branch, seed)[source]

async run_load_test_default()[source]

async run_pipeline(pipeline, provenance, job_id)[source]

async start_pipeline(pipeline)[source]

async stop_job(job, reason)[source]

async stop_pipeline(pipeline)[source]

async subscribe_job(pipeline, details)[source]

async update_job_state(job, state, reason, restart, data_processed, data_skipped, data_failed, data_recovered, data_total, stats)[source]

class ApiStub(channel, *, timeout=None, deadline=None, metadata=None)[source]

Bases: betterproto.grpc.grpclib_client.ServiceStub

Methods

activate_auth
create_pipeline
create_secret
delete_all
delete_job
delete_pipeline
delete_secret
get_logs
inspect_datum
inspect_job
inspect_job_set
inspect_pipeline
inspect_secret
list_datum
list_job
list_job_set
list_pipeline
list_secret
restart_datum
run_cron
run_load_test
run_load_test_default
run_pipeline
start_pipeline
stop_job
stop_pipeline
subscribe_job
update_job_state

async activate_auth()[source]

async create_pipeline(*, pipeline=None, tf_job=None, transform=None, parallelism_spec=None, egress=None, update=False, output_branch='', s3_out=False, resource_requests=None, resource_limits=None, sidecar_resource_limits=None, input=None, description='', reprocess=False, service=None, spout=None, datum_set_spec=None, datum_timeout=None, job_timeout=None, salt='', datum_tries=0, scheduling_spec=None, pod_spec='', pod_patch='', spec_commit=None, metadata=None, reprocess_spec='', autoscaling=False)[source]

async create_secret(*, file=b'')[source]

async delete_all()[source]

async delete_job(*, job=None)[source]

async delete_pipeline(*, pipeline=None, all=False, force=False, keep_repo=False)[source]

async delete_secret(*, secret=None)[source]

async get_logs(*, pipeline=None, job=None, data_filters=None, datum=None, master=False, follow=False, tail=0, use_loki_backend=False, since=None)[source]

async inspect_datum(*, datum=None)[source]

async inspect_job(*, job=None, wait=False, details=False)[source]

async inspect_job_set(*, job_set=None, wait=False, details=False)[source]

async inspect_pipeline(*, pipeline=None, details=False)[source]

async inspect_secret(*, secret=None)[source]

async list_datum(*, job=None, input=None)[source]

async list_job(*, pipeline=None, input_commit=None, history=0, details=False, jq_filter='')[source]

async list_job_set(*, details=False)[source]

async list_pipeline(*, pipeline=None, history=0, details=False, jq_filter='')[source]

async list_secret()[source]

async restart_datum(*, job=None, data_filters=None)[source]

async run_cron(*, pipeline=None)[source]

async run_load_test(*, spec='', branch=None, seed=0)[source]

async run_load_test_default()[source]

async run_pipeline(*, pipeline=None, provenance=None, job_id='')[source]

async start_pipeline(*, pipeline=None)[source]

async stop_job(*, job=None, reason='')[source]

async stop_pipeline(*, pipeline=None)[source]

async subscribe_job(*, pipeline=None, details=False)[source]

async update_job_state(*, job=None, state=None, reason='', restart=0, data_processed=0, data_skipped=0, data_failed=0, data_recovered=0, data_total=0, stats=None)[source]

class CreatePipelineRequest(pipeline: 'Pipeline' = <object object at 0x7f2cabcb78b0>, tf_job: 'TfJob' = <object object at 0x7f2cabcb78b0>, transform: 'Transform' = <object object at 0x7f2cabcb78b0>, parallelism_spec: 'ParallelismSpec' = <object object at 0x7f2cabcb78b0>, egress: 'Egress' = <object object at 0x7f2cabcb78b0>, update: bool = <object object at 0x7f2cabcb78b0>, output_branch: str = <object object at 0x7f2cabcb78b0>, s3_out: bool = <object object at 0x7f2cabcb78b0>, resource_requests: 'ResourceSpec' = <object object at 0x7f2cabcb78b0>, resource_limits: 'ResourceSpec' = <object object at 0x7f2cabcb78b0>, sidecar_resource_limits: 'ResourceSpec' = <object object at 0x7f2cabcb78b0>, input: 'Input' = <object object at 0x7f2cabcb78b0>, description: str = <object object at 0x7f2cabcb78b0>, reprocess: bool = <object object at 0x7f2cabcb78b0>, service: 'Service' = <object object at 0x7f2cabcb78b0>, spout: 'Spout' = <object object at 0x7f2cabcb78b0>, datum_set_spec: 'DatumSetSpec' = <object object at 0x7f2cabcb78b0>, datum_timeout: datetime.timedelta = <object object at 0x7f2cabcb78b0>, job_timeout: datetime.timedelta = <object object at 0x7f2cabcb78b0>, salt: str = <object object at 0x7f2cabcb78b0>, datum_tries: int = <object object at 0x7f2cabcb78b0>, scheduling_spec: 'SchedulingSpec' = <object object at 0x7f2cabcb78b0>, pod_spec: str = <object object at 0x7f2cabcb78b0>, pod_patch: str = <object object at 0x7f2cabcb78b0>, spec_commit: '_pfs_v2__.Commit' = <object object at 0x7f2cabcb78b0>, metadata: 'Metadata' = <object object at 0x7f2cabcb78b0>, reprocess_spec: str = <object object at 0x7f2cabcb78b0>, autoscaling: bool = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

autoscaling = <object object>

datum_set_spec = <object object>

datum_timeout = <object object>

datum_tries = <object object>

description = <object object>

egress = <object object>

input = <object object>

job_timeout = <object object>

metadata = <object object>

output_branch = <object object>

parallelism_spec = <object object>

pipeline = <object object>

pod_patch = <object object>

pod_spec = <object object>

reprocess = <object object>

reprocess_spec = <object object>

resource_limits = <object object>

resource_requests = <object object>

s3_out = <object object>

salt = <object object>

scheduling_spec = <object object>

service = <object object>

sidecar_resource_limits = <object object>

spec_commit = <object object>

spout = <object object>

tf_job = <object object>

transform = <object object>

update = <object object>

class CreateSecretRequest(file: bytes = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

file = <object object>

class CronInput(name: str = <object object at 0x7f2cabcb78b0>, repo: str = <object object at 0x7f2cabcb78b0>, commit: str = <object object at 0x7f2cabcb78b0>, spec: str = <object object at 0x7f2cabcb78b0>, overwrite: bool = <object object at 0x7f2cabcb78b0>, start: datetime.datetime = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

commit = <object object>

name = <object object>

overwrite = <object object>

repo = <object object>

spec = <object object>

start = <object object>

class Datum(job: 'Job' = <object object at 0x7f2cabcb78b0>, id: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

id = <object object>

job = <object object>

class DatumInfo(datum: 'Datum' = <object object at 0x7f2cabcb78b0>, state: 'DatumState' = <object object at 0x7f2cabcb78b0>, stats: 'ProcessStats' = <object object at 0x7f2cabcb78b0>, pfs_state: '_pfs_v2__.File' = <object object at 0x7f2cabcb78b0>, data: List[ForwardRef('_pfs_v2__.FileInfo')] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

data = <object object>

datum = <object object>

pfs_state = <object object>

state = <object object>

stats = <object object>

class DatumSetSpec(number=<object object>, size_bytes=<object object>, per_worker=<object object>)[source]

Bases: betterproto.Message

DatumSetSpec specifies how a pipeline should split its datums into datum sets.

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

number = <object object>

per_worker = <object object>

size_bytes = <object object>

class DatumState(value)[source]

Bases: betterproto.Enum

An enumeration.

FAILED = 1

RECOVERED = 5

SKIPPED = 3

STARTING = 4

SUCCESS = 2

UNKNOWN = 0

class DatumStatus(started: datetime.datetime = <object object at 0x7f2cabcb78b0>, data: List[ForwardRef('InputFile')] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

data = <object object>

started = <object object>

class DeleteJobRequest(job: 'Job' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

job = <object object>

class DeletePipelineRequest(pipeline: 'Pipeline' = <object object at 0x7f2cabcb78b0>, all: bool = <object object at 0x7f2cabcb78b0>, force: bool = <object object at 0x7f2cabcb78b0>, keep_repo: bool = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

all = <object object>

force = <object object>

keep_repo = <object object>

pipeline = <object object>

class DeleteSecretRequest(secret: 'Secret' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

secret = <object object>

class Egress(url: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

url = <object object>

class GetLogsRequest(pipeline: 'Pipeline' = <object object at 0x7f2cabcb78b0>, job: 'Job' = <object object at 0x7f2cabcb78b0>, data_filters: List[str] = <object object at 0x7f2cabcb78b0>, datum: 'Datum' = <object object at 0x7f2cabcb78b0>, master: bool = <object object at 0x7f2cabcb78b0>, follow: bool = <object object at 0x7f2cabcb78b0>, tail: int = <object object at 0x7f2cabcb78b0>, use_loki_backend: bool = <object object at 0x7f2cabcb78b0>, since: datetime.timedelta = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

data_filters = <object object>

datum = <object object>

follow = <object object>

job = <object object>

master = <object object>

pipeline = <object object>

since = <object object>

tail = <object object>

use_loki_backend = <object object>

class GpuSpec(type: str = <object object at 0x7f2cabcb78b0>, number: int = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

number = <object object>

type = <object object>

class Input(pfs: 'PfsInput' = <object object at 0x7f2cabcb78b0>, join: List[ForwardRef('Input')] = <object object at 0x7f2cabcb78b0>, group: List[ForwardRef('Input')] = <object object at 0x7f2cabcb78b0>, cross: List[ForwardRef('Input')] = <object object at 0x7f2cabcb78b0>, union: List[ForwardRef('Input')] = <object object at 0x7f2cabcb78b0>, cron: 'CronInput' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

cron = <object object>

cross = <object object>

group = <object object>

join = <object object>

pfs = <object object>

union = <object object>

class InputFile(path: str = <object object at 0x7f2cabcb78b0>, hash: bytes = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

hash = <object object>

path = <object object>

class InspectDatumRequest(datum: 'Datum' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

datum = <object object>

class InspectJobRequest(job: 'Job' = <object object at 0x7f2cabcb78b0>, wait: bool = <object object at 0x7f2cabcb78b0>, details: bool = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

details = <object object>

job = <object object>

wait = <object object>

class InspectJobSetRequest(job_set: 'JobSet' = <object object at 0x7f2cabcb78b0>, wait: bool = <object object at 0x7f2cabcb78b0>, details: bool = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

details = <object object>

job_set = <object object>

wait = <object object>

class InspectPipelineRequest(pipeline: 'Pipeline' = <object object at 0x7f2cabcb78b0>, details: bool = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

details = <object object>

pipeline = <object object>

class InspectSecretRequest(secret: 'Secret' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

secret = <object object>

class Job(pipeline: 'Pipeline' = <object object at 0x7f2cabcb78b0>, id: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

id = <object object>

pipeline = <object object>

class JobInfo(job=<object object>, pipeline_version=<object object>, output_commit=<object object>, restart=<object object>, data_processed=<object object>, data_skipped=<object object>, data_total=<object object>, data_failed=<object object>, data_recovered=<object object>, stats=<object object>, state=<object object>, reason=<object object>, created=<object object>, started=<object object>, finished=<object object>, details=<object object>)[source]

Bases: betterproto.Message

JobInfo is the data stored in the database regarding a given job. The ‘details’ field contains more information about the job which is expensive to fetch, requiring querying workers or loading the pipeline spec from object storage.

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

created = <object object>

data_failed = <object object>

data_processed = <object object>

data_recovered = <object object>

data_skipped = <object object>

data_total = <object object>

details = <object object>

finished = <object object>

job = <object object>

output_commit = <object object>

pipeline_version = <object object>

reason = <object object>

restart = <object object>

started = <object object>

state = <object object>

stats = <object object>

class JobInfoDetails(transform: 'Transform' = <object object at 0x7f2cabcb78b0>, parallelism_spec: 'ParallelismSpec' = <object object at 0x7f2cabcb78b0>, egress: 'Egress' = <object object at 0x7f2cabcb78b0>, service: 'Service' = <object object at 0x7f2cabcb78b0>, spout: 'Spout' = <object object at 0x7f2cabcb78b0>, worker_status: List[ForwardRef('WorkerStatus')] = <object object at 0x7f2cabcb78b0>, resource_requests: 'ResourceSpec' = <object object at 0x7f2cabcb78b0>, resource_limits: 'ResourceSpec' = <object object at 0x7f2cabcb78b0>, sidecar_resource_limits: 'ResourceSpec' = <object object at 0x7f2cabcb78b0>, input: 'Input' = <object object at 0x7f2cabcb78b0>, salt: str = <object object at 0x7f2cabcb78b0>, datum_set_spec: 'DatumSetSpec' = <object object at 0x7f2cabcb78b0>, datum_timeout: datetime.timedelta = <object object at 0x7f2cabcb78b0>, job_timeout: datetime.timedelta = <object object at 0x7f2cabcb78b0>, datum_tries: int = <object object at 0x7f2cabcb78b0>, scheduling_spec: 'SchedulingSpec' = <object object at 0x7f2cabcb78b0>, pod_spec: str = <object object at 0x7f2cabcb78b0>, pod_patch: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

datum_set_spec = <object object>

datum_timeout = <object object>

datum_tries = <object object>

egress = <object object>

input = <object object>

job_timeout = <object object>

parallelism_spec = <object object>

pod_patch = <object object>

pod_spec = <object object>

resource_limits = <object object>

resource_requests = <object object>

salt = <object object>

scheduling_spec = <object object>

service = <object object>

sidecar_resource_limits = <object object>

spout = <object object>

transform = <object object>

worker_status = <object object>

class JobInput(name: str = <object object at 0x7f2cabcb78b0>, commit: '_pfs_v2__.Commit' = <object object at 0x7f2cabcb78b0>, glob: str = <object object at 0x7f2cabcb78b0>, lazy: bool = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

commit = <object object>

glob = <object object>

lazy = <object object>

name = <object object>

class JobSet(id: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

id = <object object>

class JobSetInfo(job_set: 'JobSet' = <object object at 0x7f2cabcb78b0>, jobs: List[ForwardRef('JobInfo')] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

job_set = <object object>

jobs = <object object>

class JobState(value)[source]

Bases: betterproto.Enum

An enumeration.

JOB_CREATED = 1

JOB_EGRESSING = 7

JOB_FAILURE = 4

JOB_FINISHING = 8

JOB_KILLED = 6

JOB_RUNNING = 3

JOB_STARTING = 2

JOB_STATE_UNKNOWN = 0

JOB_SUCCESS = 5

class ListDatumRequest(job: 'Job' = <object object at 0x7f2cabcb78b0>, input: 'Input' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

input = <object object>

job = <object object>

class ListJobRequest(pipeline: 'Pipeline' = <object object at 0x7f2cabcb78b0>, input_commit: List[ForwardRef('_pfs_v2__.Commit')] = <object object at 0x7f2cabcb78b0>, history: int = <object object at 0x7f2cabcb78b0>, details: bool = <object object at 0x7f2cabcb78b0>, jq_filter: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

details = <object object>

history = <object object>

input_commit = <object object>

jq_filter = <object object>

pipeline = <object object>

class ListJobSetRequest(details: bool = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

details = <object object>

class ListPipelineRequest(pipeline: 'Pipeline' = <object object at 0x7f2cabcb78b0>, history: int = <object object at 0x7f2cabcb78b0>, details: bool = <object object at 0x7f2cabcb78b0>, jq_filter: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

details = <object object>

history = <object object>

jq_filter = <object object>

pipeline = <object object>

class LogMessage(pipeline_name=<object object>, job_id=<object object>, worker_id=<object object>, datum_id=<object object>, master=<object object>, data=<object object>, user=<object object>, ts=<object object>, message=<object object>)[source]

Bases: betterproto.Message

LogMessage is a log line from a PPS worker, annotated with metadata indicating when and why the line was logged.

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

data = <object object>

datum_id = <object object>

job_id = <object object>

master = <object object>

message = <object object>

pipeline_name = <object object>

ts = <object object>

user = <object object>

worker_id = <object object>

class Metadata(annotations: Dict[str, str] = <object object at 0x7f2cabcb78b0>, labels: Dict[str, str] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

annotations = <object object>

labels = <object object>

class ParallelismSpec(constant: int = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

constant = <object object>

class PfsInput(name: str = <object object at 0x7f2cabcb78b0>, repo: str = <object object at 0x7f2cabcb78b0>, repo_type: str = <object object at 0x7f2cabcb78b0>, branch: str = <object object at 0x7f2cabcb78b0>, commit: str = <object object at 0x7f2cabcb78b0>, glob: str = <object object at 0x7f2cabcb78b0>, join_on: str = <object object at 0x7f2cabcb78b0>, outer_join: bool = <object object at 0x7f2cabcb78b0>, group_by: str = <object object at 0x7f2cabcb78b0>, lazy: bool = <object object at 0x7f2cabcb78b0>, empty_files: bool = <object object at 0x7f2cabcb78b0>, s3: bool = <object object at 0x7f2cabcb78b0>, trigger: '_pfs_v2__.Trigger' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

branch = <object object>

commit = <object object>

empty_files = <object object>

glob = <object object>

group_by = <object object>

join_on = <object object>

lazy = <object object>

name = <object object>

outer_join = <object object>

repo = <object object>

repo_type = <object object>

s3 = <object object>

trigger = <object object>

class Pipeline(name: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

name = <object object>

class PipelineInfo(pipeline=<object object>, version=<object object>, spec_commit=<object object>, stopped=<object object>, state=<object object>, reason=<object object>, job_counts=<object object>, last_job_state=<object object>, parallelism=<object object>, type=<object object>, auth_token=<object object>, details=<object object>)[source]

Bases: betterproto.Message

PipelineInfo is proto for each pipeline that Pachd stores in the database. It tracks the state of the pipeline, and points to its metadata in PFS (and, by pointing to a PFS commit, de facto tracks the pipeline’s version). Any information about the pipeline _not_ stored in the database is in the Details object, which requires fetching the spec from PFS or other potentially expensive operations.

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

auth_token = <object object>

details = <object object>

job_counts = <object object>

last_job_state = <object object>

parallelism = <object object>

pipeline = <object object>

reason = <object object>

spec_commit = <object object>

state = <object object>

stopped = <object object>

type = <object object>

version = <object object>

class PipelineInfoDetails(transform: 'Transform' = <object object at 0x7f2cabcb78b0>, tf_job: 'TfJob' = <object object at 0x7f2cabcb78b0>, parallelism_spec: 'ParallelismSpec' = <object object at 0x7f2cabcb78b0>, egress: 'Egress' = <object object at 0x7f2cabcb78b0>, created_at: datetime.datetime = <object object at 0x7f2cabcb78b0>, recent_error: str = <object object at 0x7f2cabcb78b0>, workers_requested: int = <object object at 0x7f2cabcb78b0>, workers_available: int = <object object at 0x7f2cabcb78b0>, output_branch: str = <object object at 0x7f2cabcb78b0>, resource_requests: 'ResourceSpec' = <object object at 0x7f2cabcb78b0>, resource_limits: 'ResourceSpec' = <object object at 0x7f2cabcb78b0>, sidecar_resource_limits: 'ResourceSpec' = <object object at 0x7f2cabcb78b0>, input: 'Input' = <object object at 0x7f2cabcb78b0>, description: str = <object object at 0x7f2cabcb78b0>, salt: str = <object object at 0x7f2cabcb78b0>, reason: str = <object object at 0x7f2cabcb78b0>, service: 'Service' = <object object at 0x7f2cabcb78b0>, spout: 'Spout' = <object object at 0x7f2cabcb78b0>, datum_set_spec: 'DatumSetSpec' = <object object at 0x7f2cabcb78b0>, datum_timeout: datetime.timedelta = <object object at 0x7f2cabcb78b0>, job_timeout: datetime.timedelta = <object object at 0x7f2cabcb78b0>, datum_tries: int = <object object at 0x7f2cabcb78b0>, scheduling_spec: 'SchedulingSpec' = <object object at 0x7f2cabcb78b0>, pod_spec: str = <object object at 0x7f2cabcb78b0>, pod_patch: str = <object object at 0x7f2cabcb78b0>, s3_out: bool = <object object at 0x7f2cabcb78b0>, metadata: 'Metadata' = <object object at 0x7f2cabcb78b0>, reprocess_spec: str = <object object at 0x7f2cabcb78b0>, unclaimed_tasks: int = <object object at 0x7f2cabcb78b0>, worker_rc: str = <object object at 0x7f2cabcb78b0>, autoscaling: bool = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

autoscaling = <object object>

created_at = <object object>

datum_set_spec = <object object>

datum_timeout = <object object>

datum_tries = <object object>

description = <object object>

egress = <object object>

input = <object object>

job_timeout = <object object>

metadata = <object object>

output_branch = <object object>

parallelism_spec = <object object>

pod_patch = <object object>

pod_spec = <object object>

reason = <object object>

recent_error = <object object>

reprocess_spec = <object object>

resource_limits = <object object>

resource_requests = <object object>

s3_out = <object object>

salt = <object object>

scheduling_spec = <object object>

service = <object object>

sidecar_resource_limits = <object object>

spout = <object object>

tf_job = <object object>

transform = <object object>

unclaimed_tasks = <object object>

worker_rc = <object object>

workers_available = <object object>

workers_requested = <object object>

class PipelineInfoPipelineType(value)[source]

Bases: betterproto.Enum

An enumeration.

PIPELINE_TYPE_SERVICE = 3

PIPELINE_TYPE_SPOUT = 2

PIPELINE_TYPE_TRANSFORM = 1

PIPELINT_TYPE_UNKNOWN = 0

class PipelineInfos(pipeline_info: List[ForwardRef('PipelineInfo')] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

pipeline_info = <object object>

class PipelineState(value)[source]

Bases: betterproto.Enum

An enumeration.

PIPELINE_CRASHING = 7

PIPELINE_FAILURE = 4

PIPELINE_PAUSED = 5

PIPELINE_RESTARTING = 3

PIPELINE_RUNNING = 2

PIPELINE_STANDBY = 6

PIPELINE_STARTING = 1

PIPELINE_STATE_UNKNOWN = 0

class ProcessStats(download_time: datetime.timedelta = <object object at 0x7f2cabcb78b0>, process_time: datetime.timedelta = <object object at 0x7f2cabcb78b0>, upload_time: datetime.timedelta = <object object at 0x7f2cabcb78b0>, download_bytes: int = <object object at 0x7f2cabcb78b0>, upload_bytes: int = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

download_bytes = <object object>

download_time = <object object>

process_time = <object object>

upload_bytes = <object object>

upload_time = <object object>

class ResourceSpec(cpu=<object object>, memory=<object object>, gpu=<object object>, disk=<object object>)[source]

Bases: betterproto.Message

ResourceSpec describes the amount of resources that pipeline pods should request from kubernetes, for scheduling.

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

cpu = <object object>

disk = <object object>

gpu = <object object>

memory = <object object>

class RestartDatumRequest(job: 'Job' = <object object at 0x7f2cabcb78b0>, data_filters: List[str] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

data_filters = <object object>

job = <object object>

class RunCronRequest(pipeline: 'Pipeline' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

pipeline = <object object>

class RunPipelineRequest(pipeline: 'Pipeline' = <object object at 0x7f2cabcb78b0>, provenance: List[ForwardRef('_pfs_v2__.Commit')] = <object object at 0x7f2cabcb78b0>, job_id: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

job_id = <object object>

pipeline = <object object>

provenance = <object object>

class SchedulingSpec(node_selector: Dict[str, str] = <object object at 0x7f2cabcb78b0>, priority_class_name: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

node_selector = <object object>

priority_class_name = <object object>

class Secret(name: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

name = <object object>

class SecretInfo(secret: 'Secret' = <object object at 0x7f2cabcb78b0>, type: str = <object object at 0x7f2cabcb78b0>, creation_timestamp: datetime.datetime = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

creation_timestamp = <object object>

secret = <object object>

type = <object object>

class SecretInfos(secret_info: List[ForwardRef('SecretInfo')] = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

secret_info = <object object>

class SecretMount(name: str = <object object at 0x7f2cabcb78b0>, key: str = <object object at 0x7f2cabcb78b0>, mount_path: str = <object object at 0x7f2cabcb78b0>, env_var: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

env_var = <object object>

key = <object object>

mount_path = <object object>

name = <object object>

class Service(internal_port: int = <object object at 0x7f2cabcb78b0>, external_port: int = <object object at 0x7f2cabcb78b0>, ip: str = <object object at 0x7f2cabcb78b0>, type: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

external_port = <object object>

internal_port = <object object>

ip = <object object>

type = <object object>

class Spout(service: 'Service' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

service = <object object>

class StartPipelineRequest(pipeline: 'Pipeline' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

pipeline = <object object>

class StopJobRequest(job: 'Job' = <object object at 0x7f2cabcb78b0>, reason: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

job = <object object>

reason = <object object>

class StopPipelineRequest(pipeline: 'Pipeline' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

pipeline = <object object>

class SubscribeJobRequest(pipeline=<object object>, details=<object object>)[source]

Bases: betterproto.Message

Streams open jobs until canceled

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

details = <object object>

pipeline = <object object>

class TfJob(tf_job: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

tf_job = <object object>

class Transform(image: str = <object object at 0x7f2cabcb78b0>, cmd: List[str] = <object object at 0x7f2cabcb78b0>, err_cmd: List[str] = <object object at 0x7f2cabcb78b0>, env: Dict[str, str] = <object object at 0x7f2cabcb78b0>, secrets: List[ForwardRef('SecretMount')] = <object object at 0x7f2cabcb78b0>, image_pull_secrets: List[str] = <object object at 0x7f2cabcb78b0>, stdin: List[str] = <object object at 0x7f2cabcb78b0>, err_stdin: List[str] = <object object at 0x7f2cabcb78b0>, accept_return_code: List[int] = <object object at 0x7f2cabcb78b0>, debug: bool = <object object at 0x7f2cabcb78b0>, user: str = <object object at 0x7f2cabcb78b0>, working_dir: str = <object object at 0x7f2cabcb78b0>, dockerfile: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

accept_return_code = <object object>

cmd = <object object>

debug = <object object>

dockerfile = <object object>

env = <object object>

err_cmd = <object object>

err_stdin = <object object>

image = <object object>

image_pull_secrets = <object object>

secrets = <object object>

stdin = <object object>

user = <object object>

working_dir = <object object>

class UpdateJobStateRequest(job: 'Job' = <object object at 0x7f2cabcb78b0>, state: 'JobState' = <object object at 0x7f2cabcb78b0>, reason: str = <object object at 0x7f2cabcb78b0>, restart: int = <object object at 0x7f2cabcb78b0>, data_processed: int = <object object at 0x7f2cabcb78b0>, data_skipped: int = <object object at 0x7f2cabcb78b0>, data_failed: int = <object object at 0x7f2cabcb78b0>, data_recovered: int = <object object at 0x7f2cabcb78b0>, data_total: int = <object object at 0x7f2cabcb78b0>, stats: 'ProcessStats' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

data_failed = <object object>

data_processed = <object object>

data_recovered = <object object>

data_skipped = <object object>

data_total = <object object>

job = <object object>

reason = <object object>

restart = <object object>

state = <object object>

stats = <object object>

class Worker(name: str = <object object at 0x7f2cabcb78b0>, state: 'WorkerState' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

name = <object object>

state = <object object>

class WorkerState(value)[source]

Bases: betterproto.Enum

An enumeration.

POD_FAILED = 3

POD_RUNNING = 1

POD_SUCCESS = 2

WORKER_STATE_UNKNOWN = 0

class WorkerStatus(worker_id: str = <object object at 0x7f2cabcb78b0>, job_id: str = <object object at 0x7f2cabcb78b0>, datum_status: 'DatumStatus' = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

`FromString`(data)	Parse the binary encoded Protobuf into this message instance.
`SerializeToString`()	Get the binary encoded Protobuf representation of this message instance.
`from_dict`(value)	Parse the key/value pairs into the current message instance.
`from_json`(value)	A helper function to return the message instance from its JSON representation.
`parse`(data)	Parse the binary encoded Protobuf into this message instance.
`to_dict`([casing, include_default_values])	Returns a JSON serializable dict representation of this object.
`to_json`([indent])	A helper function to parse the message instance into its JSON representation.

datum_status = <object object>

job_id = <object object>

worker_id = <object object>