Important

These protos have been generated with the open-source library betterproto (https://github.com/danielgtaylor/python-betterproto) rather than the google protobuf library. These protos are more pythonic and easier to work with than the google-generated protos.

To create a proto object, import the relevant module from python_pachyderm.experimental.service (i.e. from python_pachyderm.experimental.service import pfs_proto, auth_proto) For using the docs to create the proto object, we recommend clicking the “[source]” button to better see each class’ members. The documentation generator doesn’t handle these dataclass objects well.

Admin proto

class ClusterInfo(id: str = <object object at 0x7f962eb7ff50>, deployment_id: str = <object object at 0x7f962eb7ff50>)

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.

deployment_id = <object object>

id = <object object>

Auth proto

class ActivateRequest(root_token=<object object>)

ActivateRequest enables authentication on the cluster. It issues an auth token with no expiration for the irrevocable admin user pach:root.

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.

root_token = <object object>

class ActivateResponse(pach_token: str = <object object at 0x7f962eb7ff50>)

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.

pach_token = <object object>

class AuthenticateRequest(oidc_state: str = <object object at 0x7f962eb7ff50>, id_token: str = <object object at 0x7f962eb7ff50>)

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_token = <object object>

oidc_state = <object object>

class AuthenticateResponse(pach_token: str = <object object at 0x7f962eb7ff50>)

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.

pach_token = <object object>

class AuthorizeRequest(resource: 'Resource' = <object object at 0x7f962eb7ff50>, permissions: List[ForwardRef('Permission')] = <object object at 0x7f962eb7ff50>)

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.

permissions = <object object>

resource = <object object>

class AuthorizeResponse(authorized: bool = <object object at 0x7f962eb7ff50>, satisfied: List[ForwardRef('Permission')] = <object object at 0x7f962eb7ff50>, missing: List[ForwardRef('Permission')] = <object object at 0x7f962eb7ff50>, principal: str = <object object at 0x7f962eb7ff50>)

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.

authorized = <object object>

missing = <object object>

principal = <object object>

satisfied = <object object>

class DeactivateRequest

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 DeactivateResponse

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 DeleteExpiredAuthTokensRequest

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 DeleteExpiredAuthTokensResponse

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 ExtractAuthTokensRequest

ExtractAuthTokens returns all the hashed robot tokens that have been issued. User tokens are not extracted as they can be recreated by logging in.

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 ExtractAuthTokensResponse(tokens: List[ForwardRef('TokenInfo')] = <object object at 0x7f962eb7ff50>)

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.

tokens = <object object>

class GetConfigurationRequest

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 GetConfigurationResponse(configuration: 'OidcConfig' = <object object at 0x7f962eb7ff50>)

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.

configuration = <object object>

class GetGroupsForPrincipalRequest(principal: str = <object object at 0x7f962eb7ff50>)

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.

principal = <object object>

class GetGroupsRequest

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 GetGroupsResponse(groups: List[str] = <object object at 0x7f962eb7ff50>)

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.

groups = <object object>

class GetOidcLoginRequest

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 GetOidcLoginResponse(login_url: str = <object object at 0x7f962eb7ff50>, state: str = <object object at 0x7f962eb7ff50>)

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.

login_url = <object object>

state = <object object>

class GetPermissionsForPrincipalRequest(resource=<object object>, principal=<object object>)

GetPermissionsForPrincipal evaluates an arbitrary principal’s permissions on a resource

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.

principal = <object object>

resource = <object object>

class GetPermissionsRequest(resource=<object object>)

GetPermissions evaluates the current user’s permissions on a resource

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.

resource = <object object>

class GetPermissionsResponse(permissions: List[ForwardRef('Permission')] = <object object at 0x7f962eb7ff50>, roles: List[str] = <object object at 0x7f962eb7ff50>)

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.

permissions = <object object>

roles = <object object>

class GetRobotTokenRequest(robot: str = <object object at 0x7f962eb7ff50>, ttl: int = <object object at 0x7f962eb7ff50>)

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.

robot = <object object>

ttl = <object object>

class GetRobotTokenResponse(token: str = <object object at 0x7f962eb7ff50>)

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.

token = <object object>

class GetRoleBindingRequest(resource: 'Resource' = <object object at 0x7f962eb7ff50>)

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.

resource = <object object>

class GetRoleBindingResponse(binding: 'RoleBinding' = <object object at 0x7f962eb7ff50>)

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.

binding = <object object>

class GetRolesForPermissionRequest(permission: 'Permission' = <object object at 0x7f962eb7ff50>)

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.

permission = <object object>

class GetRolesForPermissionResponse(roles: List[ForwardRef('Role')] = <object object at 0x7f962eb7ff50>)

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.

roles = <object object>

class GetUsersRequest(group: str = <object object at 0x7f962eb7ff50>)

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.

group = <object object>

class GetUsersResponse(usernames: List[str] = <object object at 0x7f962eb7ff50>)

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.

usernames = <object object>

class Groups(groups: Dict[str, bool] = <object object at 0x7f962eb7ff50>)

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.

groups = <object object>

class ModifyMembersRequest(group: str = <object object at 0x7f962eb7ff50>, add: List[str] = <object object at 0x7f962eb7ff50>, remove: List[str] = <object object at 0x7f962eb7ff50>)

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.

add = <object object>

group = <object object>

remove = <object object>

class ModifyMembersResponse

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 ModifyRoleBindingRequest(resource: 'Resource' = <object object at 0x7f962eb7ff50>, principal: str = <object object at 0x7f962eb7ff50>, roles: List[str] = <object object at 0x7f962eb7ff50>)

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.

principal = <object object>

resource = <object object>

roles = <object object>

class ModifyRoleBindingResponse

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 OidcConfig(issuer=<object object>, client_id=<object object>, client_secret=<object object>, redirect_uri=<object object>, scopes=<object object>, require_email_verified=<object object>, localhost_issuer=<object object>, user_accessible_issuer_host=<object object>)

Configure Pachyderm’s auth system with an OIDC provider

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.

client_id = <object object>

client_secret = <object object>

issuer = <object object>

localhost_issuer = <object object>

redirect_uri = <object object>

require_email_verified = <object object>

scopes = <object object>

user_accessible_issuer_host = <object object>

class Permission(value)

Permission represents the ability to perform a given operation on a Resource

CLUSTER_AUTH_ACTIVATE = 102

CLUSTER_AUTH_DEACTIVATE = 103

CLUSTER_AUTH_DELETE_EXPIRED_TOKENS = 140

CLUSTER_AUTH_EXTRACT_TOKENS = 112

CLUSTER_AUTH_GET_CONFIG = 104

CLUSTER_AUTH_GET_GROUPS = 110

CLUSTER_AUTH_GET_GROUP_USERS = 111

CLUSTER_AUTH_GET_PERMISSIONS_FOR_PRINCIPAL = 141

CLUSTER_AUTH_GET_ROBOT_TOKEN = 139

CLUSTER_AUTH_MODIFY_GROUP_MEMBERS = 109

CLUSTER_AUTH_RESTORE_TOKEN = 113

CLUSTER_AUTH_REVOKE_USER_TOKENS = 142

CLUSTER_AUTH_ROTATE_ROOT_TOKEN = 147

CLUSTER_AUTH_SET_CONFIG = 105

CLUSTER_CREATE_SECRET = 143

CLUSTER_DEBUG_DUMP = 131

CLUSTER_DELETE_ALL = 138

CLUSTER_ENTERPRISE_ACTIVATE = 114

CLUSTER_ENTERPRISE_DEACTIVATE = 117

CLUSTER_ENTERPRISE_GET_CODE = 116

CLUSTER_ENTERPRISE_HEARTBEAT = 115

CLUSTER_ENTERPRISE_PAUSE = 149

CLUSTER_GET_BINDINGS = 101

CLUSTER_GET_PACHD_LOGS = 148

CLUSTER_IDENTITY_CREATE_IDP = 120

CLUSTER_IDENTITY_CREATE_OIDC_CLIENT = 125

CLUSTER_IDENTITY_DELETE_IDP = 124

CLUSTER_IDENTITY_DELETE_OIDC_CLIENT = 129

CLUSTER_IDENTITY_GET_CONFIG = 119

CLUSTER_IDENTITY_GET_IDP = 123

CLUSTER_IDENTITY_GET_OIDC_CLIENT = 128

CLUSTER_IDENTITY_LIST_IDPS = 122

CLUSTER_IDENTITY_LIST_OIDC_CLIENTS = 127

CLUSTER_IDENTITY_SET_CONFIG = 118

CLUSTER_IDENTITY_UPDATE_IDP = 121

CLUSTER_IDENTITY_UPDATE_OIDC_CLIENT = 126

CLUSTER_LICENSE_ACTIVATE = 132

CLUSTER_LICENSE_ADD_CLUSTER = 134

CLUSTER_LICENSE_DELETE_CLUSTER = 136

CLUSTER_LICENSE_GET_CODE = 133

CLUSTER_LICENSE_LIST_CLUSTERS = 137

CLUSTER_LICENSE_UPDATE_CLUSTER = 135

CLUSTER_LIST_SECRETS = 144

CLUSTER_MODIFY_BINDINGS = 100

PERMISSION_UNKNOWN = 0

PIPELINE_LIST_JOB = 301

REPO_ADD_PIPELINE_READER = 212

REPO_ADD_PIPELINE_WRITER = 214

REPO_CREATE_BRANCH = 207

REPO_DELETE = 203

REPO_DELETE_BRANCH = 209

REPO_DELETE_COMMIT = 206

REPO_INSPECT_COMMIT = 204

REPO_INSPECT_FILE = 210

REPO_LIST_BRANCH = 208

REPO_LIST_COMMIT = 205

REPO_LIST_FILE = 211

REPO_MODIFY_BINDINGS = 202

REPO_READ = 200

REPO_REMOVE_PIPELINE_READER = 213

REPO_WRITE = 201

SECRET_DELETE = 145

SECRET_INSPECT = 146

class Resource(type=<object object>, name=<object object>)

Resource represents any resource that has role-bindings in the system

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>

type = <object object>

class ResourceType(value)

ResourceType represents the type of a Resource

CLUSTER = 1

REPO = 2

RESOURCE_TYPE_UNKNOWN = 0

SPEC_REPO = 3

class RestoreAuthTokenRequest(token=<object object>)

RestoreAuthToken inserts a hashed token that has previously been extracted.

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.

token = <object object>

class RestoreAuthTokenResponse

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 RevokeAuthTokenRequest(token: str = <object object at 0x7f962eb7ff50>)

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.

token = <object object>

class RevokeAuthTokenResponse

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 RevokeAuthTokensForUserRequest(username: str = <object object at 0x7f962eb7ff50>)

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.

username = <object object>

class RevokeAuthTokensForUserResponse

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 Role(name: str = <object object at 0x7f962eb7ff50>, permissions: List[ForwardRef('Permission')] = <object object at 0x7f962eb7ff50>, resource_types: List[ForwardRef('ResourceType')] = <object object at 0x7f962eb7ff50>)

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>

permissions = <object object>

resource_types = <object object>

class RoleBinding(entries=<object object>)

RoleBinding represents the set of roles principals have on a given Resource

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.

entries = <object object>

class Roles(roles=<object object>)

Roles represents the set of roles a principal has

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.

roles = <object object>

class RotateRootTokenRequest(root_token: str = <object object at 0x7f962eb7ff50>)

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.

root_token = <object object>

class RotateRootTokenResponse(root_token: str = <object object at 0x7f962eb7ff50>)

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.

root_token = <object object>

class SessionInfo(nonce=<object object>, email=<object object>, conversion_err=<object object>)

SessionInfo stores information associated with one OIDC authentication session (i.e. a single instance of a single user logging in). Sessions are short-lived and stored in the ‘oidc-authns’ collection, keyed by the OIDC ‘state’ token (30-character CSPRNG-generated string). ‘GetOIDCLogin’ generates and inserts entries, then /authorization-code/callback retrieves an access token from the ID provider and uses it to retrive the caller’s email and store it in ‘email’, and finally Authorize() returns a Pachyderm token identified with that email address as a subject in Pachyderm.

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.

conversion_err = <object object>

email = <object object>

nonce = <object object>

class SetConfigurationRequest(configuration: 'OidcConfig' = <object object at 0x7f962eb7ff50>)

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.

configuration = <object object>

class SetConfigurationResponse

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 SetGroupsForUserRequest(username: str = <object object at 0x7f962eb7ff50>, groups: List[str] = <object object at 0x7f962eb7ff50>)

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.

groups = <object object>

username = <object object>

class SetGroupsForUserResponse

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 TokenInfo(subject=<object object>, expiration=<object object>, hashed_token=<object object>)

TokenInfo is the ‘value’ of an auth token ‘key’ in the ‘tokens’ collection

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.

expiration = <object object>

hashed_token = <object object>

subject = <object object>

class Users(usernames: Dict[str, bool] = <object object at 0x7f962eb7ff50>)

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.

usernames = <object object>

class WhoAmIRequest

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 WhoAmIResponse(username: str = <object object at 0x7f962eb7ff50>, expiration: datetime.datetime = <object object at 0x7f962eb7ff50>)

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.

expiration = <object object>

username = <object object>

Debug proto

class BinaryRequest(filter: 'Filter' = <object object at 0x7f962eb7ff50>)

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.

filter = <object object>

class DumpRequest(filter: 'Filter' = <object object at 0x7f962eb7ff50>, limit: int = <object object at 0x7f962eb7ff50>)

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.

filter = <object object>

limit = <object object>

class Filter(pachd: bool = <object object at 0x7f962eb7ff50>, pipeline: '_pps_v2__.Pipeline' = <object object at 0x7f962eb7ff50>, worker: 'Worker' = <object object at 0x7f962eb7ff50>)

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.

pachd = <object object>

pipeline = <object object>

worker = <object object>

class Profile(name: str = <object object at 0x7f962eb7ff50>, duration: datetime.timedelta = <object object at 0x7f962eb7ff50>)

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.

duration = <object object>

name = <object object>

class ProfileRequest(profile: 'Profile' = <object object at 0x7f962eb7ff50>, filter: 'Filter' = <object object at 0x7f962eb7ff50>)

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.

filter = <object object>

profile = <object object>

class Worker(pod: str = <object object at 0x7f962eb7ff50>, redirected: bool = <object object at 0x7f962eb7ff50>)

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.

pod = <object object>

redirected = <object object>

Enterprise proto

class ActivateRequest(license_server: str = <object object at 0x7f962eb7ff50>, id: str = <object object at 0x7f962eb7ff50>, secret: str = <object object at 0x7f962eb7ff50>)

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>

license_server = <object object>

secret = <object object>

class ActivateResponse

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 DeactivateRequest

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 DeactivateResponse

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 EnterpriseConfig(license_server=<object object>, id=<object object>, secret=<object object>)

EnterpriseConfig is the configuration we store for heartbeating to the license server.

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>

license_server = <object object>

secret = <object object>

class EnterpriseRecord(license=<object object>, last_heartbeat=<object object>, heartbeat_failed=<object object>)

EnterpriseRecord is a protobuf we cache in etcd to store the enterprise status.

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.

heartbeat_failed = <object object>

last_heartbeat = <object object>

license = <object object>

class GetActivationCodeRequest

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 GetActivationCodeResponse(state: 'State' = <object object at 0x7f962eb7ff50>, info: 'TokenInfo' = <object object at 0x7f962eb7ff50>, activation_code: str = <object object at 0x7f962eb7ff50>)

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.

activation_code = <object object>

info = <object object>

state = <object object>

class GetStateRequest

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 GetStateResponse(state: 'State' = <object object at 0x7f962eb7ff50>, info: 'TokenInfo' = <object object at 0x7f962eb7ff50>, activation_code: str = <object object at 0x7f962eb7ff50>)

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.

activation_code = <object object>

info = <object object>

state = <object object>

class HeartbeatRequest

Heartbeat in the enterprise service just triggers a heartbeat for testing purposes. The RPC used to communicate with the license service is defined in the license service.

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 HeartbeatResponse

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 LicenseRecord(activation_code=<object object>, expires=<object object>)

LicenseRecord is the record we store in etcd for a Pachyderm enterprise token that has been provided to a Pachyderm license server

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.

activation_code = <object object>

expires = <object object>

class PauseRequest

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 PauseResponse

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 PauseStatusRequest

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 PauseStatusResponse(status: 'PauseStatusResponsePauseStatus' = <object object at 0x7f962eb7ff50>)

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.

status = <object object>

class PauseStatusResponsePauseStatus(value)

An enumeration.

PARTIALLY_PAUSED = 1

PAUSED = 2

UNPAUSED = 0

class State(value)

An enumeration.

ACTIVE = 1

EXPIRED = 2

HEARTBEAT_FAILED = 3

NONE = 0

class TokenInfo(expires=<object object>)

TokenInfo contains information about the currently active enterprise token

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.

expires = <object object>

class UnpauseRequest

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 UnpauseResponse

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.

Identity proto

class CreateIdpConnectorRequest(connector: 'IdpConnector' = <object object at 0x7f962eb7ff50>)

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.

connector = <object object>

class CreateIdpConnectorResponse

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 CreateOidcClientRequest(client: 'OidcClient' = <object object at 0x7f962eb7ff50>)

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.

client = <object object>

class CreateOidcClientResponse(client: 'OidcClient' = <object object at 0x7f962eb7ff50>)

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.

client = <object object>

class DeleteAllRequest

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 DeleteAllResponse

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 DeleteIdpConnectorRequest(id: str = <object object at 0x7f962eb7ff50>)

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 DeleteIdpConnectorResponse

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 DeleteOidcClientRequest(id: str = <object object at 0x7f962eb7ff50>)

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 DeleteOidcClientResponse

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 GetIdentityServerConfigRequest

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 GetIdentityServerConfigResponse(config: 'IdentityServerConfig' = <object object at 0x7f962eb7ff50>)

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.

config = <object object>

class GetIdpConnectorRequest(id: str = <object object at 0x7f962eb7ff50>)

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 GetIdpConnectorResponse(connector: 'IdpConnector' = <object object at 0x7f962eb7ff50>)

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.

connector = <object object>

class GetOidcClientRequest(id: str = <object object at 0x7f962eb7ff50>)

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 GetOidcClientResponse(client: 'OidcClient' = <object object at 0x7f962eb7ff50>)

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.

client = <object object>

class IdentityServerConfig(issuer=<object object>, id_token_expiry=<object object>, rotation_token_expiry=<object object>)

IdentityServerConfig is the configuration for the identity web server. When the configuration is changed the web server is reloaded automatically.

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_token_expiry = <object object>

issuer = <object object>

rotation_token_expiry = <object object>

class IdpConnector(id=<object object>, name=<object object>, type=<object object>, config_version=<object object>, json_config=<object object>)

IdpConnector represents a connection to an identity provider

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.

config_version = <object object>

id = <object object>

json_config = <object object>

name = <object object>

type = <object object>

class ListIdpConnectorsRequest

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 ListIdpConnectorsResponse(connectors: List[ForwardRef('IdpConnector')] = <object object at 0x7f962eb7ff50>)

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.

connectors = <object object>

class ListOidcClientsRequest

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 ListOidcClientsResponse(clients: List[ForwardRef('OidcClient')] = <object object at 0x7f962eb7ff50>)

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.

clients = <object object>

class OidcClient(id: str = <object object at 0x7f962eb7ff50>, redirect_uris: List[str] = <object object at 0x7f962eb7ff50>, trusted_peers: List[str] = <object object at 0x7f962eb7ff50>, name: str = <object object at 0x7f962eb7ff50>, secret: str = <object object at 0x7f962eb7ff50>)

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>

name = <object object>

redirect_uris = <object object>

secret = <object object>

trusted_peers = <object object>

class SetIdentityServerConfigRequest(config: 'IdentityServerConfig' = <object object at 0x7f962eb7ff50>)

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.

config = <object object>

class SetIdentityServerConfigResponse

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 UpdateIdpConnectorRequest(connector: 'IdpConnector' = <object object at 0x7f962eb7ff50>)

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.

connector = <object object>

class UpdateIdpConnectorResponse

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 UpdateOidcClientRequest(client: 'OidcClient' = <object object at 0x7f962eb7ff50>)

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.

client = <object object>

class UpdateOidcClientResponse

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 User(email=<object object>, last_authenticated=<object object>)

User represents an Idp user that has authenticated via Oidc

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.

email = <object object>

last_authenticated = <object object>

License proto

class ActivateRequest(activation_code: str = <object object at 0x7f962eb7ff50>, expires: datetime.datetime = <object object at 0x7f962eb7ff50>)

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.

activation_code = <object object>

expires = <object object>

class ActivateResponse(info: '_enterprise_v2__.TokenInfo' = <object object at 0x7f962eb7ff50>)

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.

info = <object object>

class AddClusterRequest(id: str = <object object at 0x7f962eb7ff50>, address: str = <object object at 0x7f962eb7ff50>, secret: str = <object object at 0x7f962eb7ff50>, user_address: str = <object object at 0x7f962eb7ff50>, cluster_deployment_id: str = <object object at 0x7f962eb7ff50>, enterprise_server: bool = <object object at 0x7f962eb7ff50>)

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.

address = <object object>

cluster_deployment_id = <object object>

enterprise_server = <object object>

id = <object object>

secret = <object object>

user_address = <object object>

class AddClusterResponse(secret: str = <object object at 0x7f962eb7ff50>)

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 ClusterStatus(id: str = <object object at 0x7f962eb7ff50>, address: str = <object object at 0x7f962eb7ff50>, version: str = <object object at 0x7f962eb7ff50>, auth_enabled: bool = <object object at 0x7f962eb7ff50>, client_id: str = <object object at 0x7f962eb7ff50>, last_heartbeat: datetime.datetime = <object object at 0x7f962eb7ff50>, created_at: datetime.datetime = <object object at 0x7f962eb7ff50>)

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.

address = <object object>

auth_enabled = <object object>

client_id = <object object>

created_at = <object object>

id = <object object>

last_heartbeat = <object object>

version = <object object>

class DeactivateRequest

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 DeactivateResponse

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 DeleteAllRequest

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 DeleteAllResponse

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 DeleteClusterRequest(id: str = <object object at 0x7f962eb7ff50>)

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 DeleteClusterResponse

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 GetActivationCodeRequest

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 GetActivationCodeResponse(state: '_enterprise_v2__.State' = <object object at 0x7f962eb7ff50>, info: '_enterprise_v2__.TokenInfo' = <object object at 0x7f962eb7ff50>, activation_code: str = <object object at 0x7f962eb7ff50>)

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.

activation_code = <object object>

info = <object object>

state = <object object>

class HeartbeatRequest(id: str = <object object at 0x7f962eb7ff50>, secret: str = <object object at 0x7f962eb7ff50>, version: str = <object object at 0x7f962eb7ff50>, auth_enabled: bool = <object object at 0x7f962eb7ff50>, client_id: str = <object object at 0x7f962eb7ff50>)

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_enabled = <object object>

client_id = <object object>

id = <object object>

secret = <object object>

version = <object object>

class HeartbeatResponse(license: '_enterprise_v2__.LicenseRecord' = <object object at 0x7f962eb7ff50>)

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.

license = <object object>

class ListClustersRequest

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 ListClustersResponse(clusters: List[ForwardRef('ClusterStatus')] = <object object at 0x7f962eb7ff50>)

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.

clusters = <object object>

class ListUserClustersRequest

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 ListUserClustersResponse(clusters: List[ForwardRef('UserClusterInfo')] = <object object at 0x7f962eb7ff50>)

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.

clusters = <object object>

class UpdateClusterRequest(id=<object object>, address=<object object>, user_address=<object object>, cluster_deployment_id=<object object>)

Note: Updates of the enterprise-server field are not allowed. In the worst case, a user can recreate their cluster if they need the field updated.

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.

address = <object object>

cluster_deployment_id = <object object>

id = <object object>

user_address = <object object>

class UpdateClusterResponse

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 UserClusterInfo(id: str = <object object at 0x7f962eb7ff50>, cluster_deployment_id: str = <object object at 0x7f962eb7ff50>, address: str = <object object at 0x7f962eb7ff50>, enterprise_server: bool = <object object at 0x7f962eb7ff50>)

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.

address = <object object>

cluster_deployment_id = <object object>

enterprise_server = <object object>

id = <object object>

PFS proto

class AddFile(path: str = <object object at 0x7f962eb7ff50>, datum: str = <object object at 0x7f962eb7ff50>, raw: Union[bytes, NoneType] = <object object at 0x7f962eb7ff50>, url: 'AddFileUrlSource' = <object object at 0x7f962eb7ff50>)

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>

path = <object object>

raw = <object object>

url = <object object>

class AddFileSetRequest(commit: 'Commit' = <object object at 0x7f962eb7ff50>, file_set_id: str = <object object at 0x7f962eb7ff50>)

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>

file_set_id = <object object>

class AddFileUrlSource(url: str = <object object at 0x7f962eb7ff50>, recursive: bool = <object object at 0x7f962eb7ff50>)

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.

recursive = <object object>

url = <object object>

class Branch(repo: 'Repo' = <object object at 0x7f962eb7ff50>, name: str = <object object at 0x7f962eb7ff50>)

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>

repo = <object object>

class BranchInfo(branch: 'Branch' = <object object at 0x7f962eb7ff50>, head: 'Commit' = <object object at 0x7f962eb7ff50>, provenance: List[ForwardRef('Branch')] = <object object at 0x7f962eb7ff50>, subvenance: List[ForwardRef('Branch')] = <object object at 0x7f962eb7ff50>, direct_provenance: List[ForwardRef('Branch')] = <object object at 0x7f962eb7ff50>, trigger: 'Trigger' = <object object at 0x7f962eb7ff50>)

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>

direct_provenance = <object object>

head = <object object>

provenance = <object object>

subvenance = <object object>

trigger = <object object>

class CheckStorageRequest(read_chunk_data: bool = <object object at 0x7f962eb7ff50>, chunk_begin: bytes = <object object at 0x7f962eb7ff50>, chunk_end: bytes = <object object at 0x7f962eb7ff50>)

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.

chunk_begin = <object object>

chunk_end = <object object>

read_chunk_data = <object object>

class CheckStorageResponse(chunk_object_count: int = <object object at 0x7f962eb7ff50>)

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.

chunk_object_count = <object object>

class ClearCacheRequest(tag_prefix: str = <object object at 0x7f962eb7ff50>)

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.

tag_prefix = <object object>

class ClearCommitRequest(commit: 'Commit' = <object object at 0x7f962eb7ff50>)

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>

class Commit(branch=<object object>, id=<object object>)

Commit is a reference to a commit (e.g. the collection of branches and the collection of currently-open commits in etcd are collections of Commit protos)

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>

id = <object object>

class CommitInfo(commit=<object object>, origin=<object object>, description=<object object>, parent_commit=<object object>, child_commits=<object object>, started=<object object>, finishing=<object object>, finished=<object object>, direct_provenance=<object object>, error=<object object>, size_bytes_upper_bound=<object object>, details=<object object>)

CommitInfo is the main data structure representing a commit in etcd

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.

child_commits = <object object>

commit = <object object>

description = <object object>

details = <object object>

direct_provenance = <object object>

error = <object object>

finished = <object object>

finishing = <object object>

origin = <object object>

parent_commit = <object object>

size_bytes_upper_bound = <object object>

started = <object object>

class CommitInfoDetails(size_bytes=<object object>, compacting_time=<object object>, validating_time=<object object>)

Details are only provided when explicitly requested

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.

compacting_time = <object object>

size_bytes = <object object>

validating_time = <object object>

class CommitOrigin(kind: 'OriginKind' = <object object at 0x7f962eb7ff50>)

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.

kind = <object object>

class CommitSet(id: str = <object object at 0x7f962eb7ff50>)

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 CommitSetInfo(commit_set: 'CommitSet' = <object object at 0x7f962eb7ff50>, commits: List[ForwardRef('CommitInfo')] = <object object at 0x7f962eb7ff50>)

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_set = <object object>

commits = <object object>

class CommitState(value)

CommitState describes the states a commit can be in. The states are increasingly specific, i.e. a commit that is FINISHED also counts as STARTED.

COMMIT_STATE_UNKNOWN = 0

FINISHED = 4

FINISHING = 3

READY = 2

STARTED = 1

class ComposeFileSetRequest(file_set_ids: List[str] = <object object at 0x7f962eb7ff50>, ttl_seconds: int = <object object at 0x7f962eb7ff50>)

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_set_ids = <object object>

ttl_seconds = <object object>

class CopyFile(dst: str = <object object at 0x7f962eb7ff50>, datum: str = <object object at 0x7f962eb7ff50>, src: 'File' = <object object at 0x7f962eb7ff50>, append: bool = <object object at 0x7f962eb7ff50>)

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.

append = <object object>

datum = <object object>

dst = <object object>

src = <object object>

class CreateBranchRequest(head: 'Commit' = <object object at 0x7f962eb7ff50>, branch: 'Branch' = <object object at 0x7f962eb7ff50>, provenance: List[ForwardRef('Branch')] = <object object at 0x7f962eb7ff50>, trigger: 'Trigger' = <object object at 0x7f962eb7ff50>, new_commit_set: bool = <object object at 0x7f962eb7ff50>)

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>

head = <object object>

new_commit_set = <object object>

provenance = <object object>

trigger = <object object>

class CreateFileSetResponse(file_set_id: str = <object object at 0x7f962eb7ff50>)

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_set_id = <object object>

class CreateRepoRequest(repo: 'Repo' = <object object at 0x7f962eb7ff50>, description: str = <object object at 0x7f962eb7ff50>, update: bool = <object object at 0x7f962eb7ff50>)

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.

description = <object object>

repo = <object object>

update = <object object>

class DeleteBranchRequest(branch: 'Branch' = <object object at 0x7f962eb7ff50>, force: bool = <object object at 0x7f962eb7ff50>)

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>

force = <object object>

class DeleteFile(path: str = <object object at 0x7f962eb7ff50>, datum: str = <object object at 0x7f962eb7ff50>)

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>

path = <object object>

class DeleteRepoRequest(repo: 'Repo' = <object object at 0x7f962eb7ff50>, force: bool = <object object at 0x7f962eb7ff50>)

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.

force = <object object>

repo = <object object>

class Delimiter(value)

An enumeration.

CSV = 4

JSON = 1

LINE = 2

NONE = 0

SQL = 3

class DiffFileRequest(new_file: 'File' = <object object at 0x7f962eb7ff50>, old_file: 'File' = <object object at 0x7f962eb7ff50>, shallow: bool = <object object at 0x7f962eb7ff50>)

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.

new_file = <object object>

old_file = <object object>

shallow = <object object>

class DiffFileResponse(new_file: 'FileInfo' = <object object at 0x7f962eb7ff50>, old_file: 'FileInfo' = <object object at 0x7f962eb7ff50>)

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.

new_file = <object object>

old_file = <object object>

class DropCommitSetRequest(commit_set: 'CommitSet' = <object object at 0x7f962eb7ff50>)

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_set = <object object>

class EgressRequest(commit: 'Commit' = <object object at 0x7f962eb7ff50>, object_storage: 'ObjectStorageEgress' = <object object at 0x7f962eb7ff50>, sql_database: 'SqlDatabaseEgress' = <object object at 0x7f962eb7ff50>)

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>

object_storage = <object object>

sql_database = <object object>

class EgressResponse(object_storage: 'EgressResponseObjectStorageResult' = <object object at 0x7f962eb7ff50>, sql_database: 'EgressResponseSqlDatabaseResult' = <object object at 0x7f962eb7ff50>)

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.

object_storage = <object object>

sql_database = <object object>

class EgressResponseObjectStorageResult(bytes_written: int = <object object at 0x7f962eb7ff50>)

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.

bytes_written = <object object>

class EgressResponseSqlDatabaseResult(rows_written: Dict[str, int] = <object object at 0x7f962eb7ff50>)

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.

rows_written = <object object>

class File(commit: 'Commit' = <object object at 0x7f962eb7ff50>, path: str = <object object at 0x7f962eb7ff50>, datum: str = <object object at 0x7f962eb7ff50>)

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>

datum = <object object>

path = <object object>

class FileInfo(file: 'File' = <object object at 0x7f962eb7ff50>, file_type: 'FileType' = <object object at 0x7f962eb7ff50>, committed: datetime.datetime = <object object at 0x7f962eb7ff50>, size_bytes: int = <object object at 0x7f962eb7ff50>, hash: bytes = <object object at 0x7f962eb7ff50>)

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.

committed = <object object>

file = <object object>

file_type = <object object>

hash = <object object>

size_bytes = <object object>

class FileType(value)

An enumeration.

DIR = 2

FILE = 1

RESERVED = 0

class FinishCommitRequest(commit: 'Commit' = <object object at 0x7f962eb7ff50>, description: str = <object object at 0x7f962eb7ff50>, error: str = <object object at 0x7f962eb7ff50>, force: bool = <object object at 0x7f962eb7ff50>)

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>

description = <object object>

error = <object object>

force = <object object>

class FsckRequest(fix: bool = <object object at 0x7f962eb7ff50>)

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.

fix = <object object>

class FsckResponse(fix: str = <object object at 0x7f962eb7ff50>, error: str = <object object at 0x7f962eb7ff50>)

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.

error = <object object>

fix = <object object>

class GetCacheRequest(key: str = <object object at 0x7f962eb7ff50>)

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.

key = <object object>

class GetCacheResponse(value: 'betterproto_lib_google_protobuf.Any' = <object object at 0x7f962eb7ff50>)

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.

value = <object object>

class GetFileRequest(file: 'File' = <object object at 0x7f962eb7ff50>, url: str = <object object at 0x7f962eb7ff50>, offset: int = <object object at 0x7f962eb7ff50>)

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>

offset = <object object>

url = <object object>

class GetFileSetRequest(commit: 'Commit' = <object object at 0x7f962eb7ff50>)

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>

class GlobFileRequest(commit: 'Commit' = <object object at 0x7f962eb7ff50>, pattern: str = <object object at 0x7f962eb7ff50>)

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>

pattern = <object object>

class InspectBranchRequest(branch: 'Branch' = <object object at 0x7f962eb7ff50>)

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>

class InspectCommitRequest(commit: 'Commit' = <object object at 0x7f962eb7ff50>, wait: 'CommitState' = <object object at 0x7f962eb7ff50>)

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>

wait = <object object>

class InspectCommitSetRequest(commit_set: 'CommitSet' = <object object at 0x7f962eb7ff50>, wait: bool = <object object at 0x7f962eb7ff50>)

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_set = <object object>

wait = <object object>

class InspectFileRequest(file: 'File' = <object object at 0x7f962eb7ff50>)

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 InspectRepoRequest(repo: 'Repo' = <object object at 0x7f962eb7ff50>)

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.

repo = <object object>

class ListBranchRequest(repo: 'Repo' = <object object at 0x7f962eb7ff50>, reverse: bool = <object object at 0x7f962eb7ff50>)

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.

repo = <object object>

reverse = <object object>

class ListCommitRequest(repo: 'Repo' = <object object at 0x7f962eb7ff50>, from_: 'Commit' = <object object at 0x7f962eb7ff50>, to: 'Commit' = <object object at 0x7f962eb7ff50>, number: int = <object object at 0x7f962eb7ff50>, reverse: bool = <object object at 0x7f962eb7ff50>, all: bool = <object object at 0x7f962eb7ff50>, origin_kind: 'OriginKind' = <object object at 0x7f962eb7ff50>)

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>

from_ = <object object>

number = <object object>

origin_kind = <object object>

repo = <object object>

reverse = <object object>

to = <object object>

class ListCommitSetRequest

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 ListFileRequest(file: 'File' = <object object at 0x7f962eb7ff50>)

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 ListRepoRequest(type: str = <object object at 0x7f962eb7ff50>)

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.

type = <object object>

class ModifyFileRequest(set_commit: 'Commit' = <object object at 0x7f962eb7ff50>, add_file: 'AddFile' = <object object at 0x7f962eb7ff50>, delete_file: 'DeleteFile' = <object object at 0x7f962eb7ff50>, copy_file: 'CopyFile' = <object object at 0x7f962eb7ff50>)

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.

add_file = <object object>

copy_file = <object object>

delete_file = <object object>

set_commit = <object object>

class ObjectStorageEgress(url: str = <object object at 0x7f962eb7ff50>)

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 OriginKind(value)

These are the different places where a commit may be originated from

ALIAS = 4

AUTO = 2

FSCK = 3

ORIGIN_KIND_UNKNOWN = 0

USER = 1

class PutCacheRequest(key: str = <object object at 0x7f962eb7ff50>, value: 'betterproto_lib_google_protobuf.Any' = <object object at 0x7f962eb7ff50>, file_set_ids: List[str] = <object object at 0x7f962eb7ff50>, tag: str = <object object at 0x7f962eb7ff50>)

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_set_ids = <object object>

key = <object object>

tag = <object object>

value = <object object>

class RenewFileSetRequest(file_set_id: str = <object object at 0x7f962eb7ff50>, ttl_seconds: int = <object object at 0x7f962eb7ff50>)

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_set_id = <object object>

ttl_seconds = <object object>

class Repo(name: str = <object object at 0x7f962eb7ff50>, type: str = <object object at 0x7f962eb7ff50>)

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>

type = <object object>

class RepoAuthInfo(permissions=<object object>, roles=<object object>)

RepoAuthInfo includes the caller’s access scope for a repo, and is returned by ListRepo and InspectRepo but not persisted in etcd. It’s used by the Pachyderm dashboard to render repo access appropriately. To set a user’s auth scope for a repo, use the Pachyderm Auth API (in src/client/auth/auth.proto)

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.

permissions = <object object>

roles = <object object>

class RepoInfo(repo=<object object>, created=<object object>, size_bytes_upper_bound=<object object>, description=<object object>, branches=<object object>, auth_info=<object object>, details=<object object>)

RepoInfo is the main data structure representing a Repo in etcd

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_info = <object object>

branches = <object object>

created = <object object>

description = <object object>

details = <object object>

repo = <object object>

size_bytes_upper_bound = <object object>

class RepoInfoDetails(size_bytes=<object object>)

Details are only provided when explicitly requested

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.

size_bytes = <object object>

class RunLoadTestRequest(spec: str = <object object at 0x7f962eb7ff50>, branch: 'Branch' = <object object at 0x7f962eb7ff50>, seed: int = <object object at 0x7f962eb7ff50>)

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>

seed = <object object>

spec = <object object>

class RunLoadTestResponse(spec: str = <object object at 0x7f962eb7ff50>, branch: 'Branch' = <object object at 0x7f962eb7ff50>, seed: int = <object object at 0x7f962eb7ff50>, error: str = <object object at 0x7f962eb7ff50>, duration: datetime.timedelta = <object object at 0x7f962eb7ff50>)

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>

duration = <object object>

error = <object object>

seed = <object object>

spec = <object object>

class SqlDatabaseEgress(url: str = <object object at 0x7f962eb7ff50>, file_format: 'SqlDatabaseEgressFileFormat' = <object object at 0x7f962eb7ff50>, secret: 'SqlDatabaseEgressSecret' = <object object at 0x7f962eb7ff50>)

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_format = <object object>

secret = <object object>

url = <object object>

class SqlDatabaseEgressFileFormat(type: 'SqlDatabaseEgressFileFormatType' = <object object at 0x7f962eb7ff50>, columns: List[str] = <object object at 0x7f962eb7ff50>)

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.

columns = <object object>

type = <object object>

class SqlDatabaseEgressFileFormatType(value)

An enumeration.

CSV = 1

JSON = 2

PARQUET = 3

UNKNOWN = 0

class SqlDatabaseEgressSecret(name: str = <object object at 0x7f962eb7ff50>, key: str = <object object at 0x7f962eb7ff50>)

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.

key = <object object>

name = <object object>

class SquashCommitSetRequest(commit_set: 'CommitSet' = <object object at 0x7f962eb7ff50>)

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_set = <object object>

class StartCommitRequest(parent: 'Commit' = <object object at 0x7f962eb7ff50>, description: str = <object object at 0x7f962eb7ff50>, branch: 'Branch' = <object object at 0x7f962eb7ff50>)

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>

description = <object object>

parent = <object object>

class SubscribeCommitRequest(repo: 'Repo' = <object object at 0x7f962eb7ff50>, branch: str = <object object at 0x7f962eb7ff50>, from_: 'Commit' = <object object at 0x7f962eb7ff50>, state: 'CommitState' = <object object at 0x7f962eb7ff50>, all: bool = <object object at 0x7f962eb7ff50>, origin_kind: 'OriginKind' = <object object at 0x7f962eb7ff50>)

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>

branch = <object object>

from_ = <object object>

origin_kind = <object object>

repo = <object object>

state = <object object>

class Trigger(branch=<object object>, all=<object object>, cron_spec=<object object>, size=<object object>, commits=<object object>)

Trigger defines the conditions under which a head is moved, and to which branch it is moved.

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>

branch = <object object>

commits = <object object>

cron_spec = <object object>

size = <object object>

class WalkFileRequest(file: 'File' = <object object at 0x7f962eb7ff50>)

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>

PPS proto

class Aggregate(count: int = <object object at 0x7f962eb7ff50>, mean: float = <object object at 0x7f962eb7ff50>, stddev: float = <object object at 0x7f962eb7ff50>, fifth_percentile: float = <object object at 0x7f962eb7ff50>, ninety_fifth_percentile: float = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, process_time: 'Aggregate' = <object object at 0x7f962eb7ff50>, upload_time: 'Aggregate' = <object object at 0x7f962eb7ff50>, download_bytes: 'Aggregate' = <object object at 0x7f962eb7ff50>, upload_bytes: 'Aggregate' = <object object at 0x7f962eb7ff50>)

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

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 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, repo: str = <object object at 0x7f962eb7ff50>, commit: str = <object object at 0x7f962eb7ff50>, spec: str = <object object at 0x7f962eb7ff50>, overwrite: bool = <object object at 0x7f962eb7ff50>, start: datetime.datetime = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, id: str = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, state: 'DatumState' = <object object at 0x7f962eb7ff50>, stats: 'ProcessStats' = <object object at 0x7f962eb7ff50>, pfs_state: '_pfs_v2__.File' = <object object at 0x7f962eb7ff50>, data: List[ForwardRef('_pfs_v2__.FileInfo')] = <object object at 0x7f962eb7ff50>, image_id: str = <object object at 0x7f962eb7ff50>)

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>

image_id = <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>)

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)

An enumeration.

FAILED = 1

RECOVERED = 5

SKIPPED = 3

STARTING = 4

SUCCESS = 2

UNKNOWN = 0

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

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 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, all: bool = <object object at 0x7f962eb7ff50>, force: bool = <object object at 0x7f962eb7ff50>, keep_repo: bool = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, object_storage: '_pfs_v2__.ObjectStorageEgress' = <object object at 0x7f962eb7ff50>, sql_database: '_pfs_v2__.SqlDatabaseEgress' = <object object at 0x7f962eb7ff50>)

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.

object_storage = <object object>

sql_database = <object object>

url = <object object>

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

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 0x7f962eb7ff50>, number: int = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, join: List[ForwardRef('Input')] = <object object at 0x7f962eb7ff50>, group: List[ForwardRef('Input')] = <object object at 0x7f962eb7ff50>, cross: List[ForwardRef('Input')] = <object object at 0x7f962eb7ff50>, union: List[ForwardRef('Input')] = <object object at 0x7f962eb7ff50>, cron: 'CronInput' = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, hash: bytes = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, wait: bool = <object object at 0x7f962eb7ff50>, details: bool = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, wait: bool = <object object at 0x7f962eb7ff50>, details: bool = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, details: bool = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, id: str = <object object at 0x7f962eb7ff50>)

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>)

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 0x7f962eb7ff50>, parallelism_spec: 'ParallelismSpec' = <object object at 0x7f962eb7ff50>, egress: 'Egress' = <object object at 0x7f962eb7ff50>, service: 'Service' = <object object at 0x7f962eb7ff50>, spout: 'Spout' = <object object at 0x7f962eb7ff50>, worker_status: List[ForwardRef('WorkerStatus')] = <object object at 0x7f962eb7ff50>, resource_requests: 'ResourceSpec' = <object object at 0x7f962eb7ff50>, resource_limits: 'ResourceSpec' = <object object at 0x7f962eb7ff50>, sidecar_resource_limits: 'ResourceSpec' = <object object at 0x7f962eb7ff50>, input: 'Input' = <object object at 0x7f962eb7ff50>, salt: str = <object object at 0x7f962eb7ff50>, datum_set_spec: 'DatumSetSpec' = <object object at 0x7f962eb7ff50>, datum_timeout: datetime.timedelta = <object object at 0x7f962eb7ff50>, job_timeout: datetime.timedelta = <object object at 0x7f962eb7ff50>, datum_tries: int = <object object at 0x7f962eb7ff50>, scheduling_spec: 'SchedulingSpec' = <object object at 0x7f962eb7ff50>, pod_spec: str = <object object at 0x7f962eb7ff50>, pod_patch: str = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, commit: '_pfs_v2__.Commit' = <object object at 0x7f962eb7ff50>, glob: str = <object object at 0x7f962eb7ff50>, lazy: bool = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, jobs: List[ForwardRef('JobInfo')] = <object object at 0x7f962eb7ff50>)

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)

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 0x7f962eb7ff50>, input: 'Input' = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, input_commit: List[ForwardRef('_pfs_v2__.Commit')] = <object object at 0x7f962eb7ff50>, history: int = <object object at 0x7f962eb7ff50>, details: bool = <object object at 0x7f962eb7ff50>, jq_filter: str = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, history: int = <object object at 0x7f962eb7ff50>, details: bool = <object object at 0x7f962eb7ff50>, jq_filter: str = <object object at 0x7f962eb7ff50>)

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>)

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 0x7f962eb7ff50>, labels: Dict[str, str] = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, repo: str = <object object at 0x7f962eb7ff50>, repo_type: str = <object object at 0x7f962eb7ff50>, branch: str = <object object at 0x7f962eb7ff50>, commit: str = <object object at 0x7f962eb7ff50>, glob: str = <object object at 0x7f962eb7ff50>, join_on: str = <object object at 0x7f962eb7ff50>, outer_join: bool = <object object at 0x7f962eb7ff50>, group_by: str = <object object at 0x7f962eb7ff50>, lazy: bool = <object object at 0x7f962eb7ff50>, empty_files: bool = <object object at 0x7f962eb7ff50>, s3: bool = <object object at 0x7f962eb7ff50>, trigger: '_pfs_v2__.Trigger' = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>)

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>, last_job_state=<object object>, parallelism=<object object>, type=<object object>, auth_token=<object object>, details=<object object>)

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>

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 0x7f962eb7ff50>, tf_job: 'TfJob' = <object object at 0x7f962eb7ff50>, parallelism_spec: 'ParallelismSpec' = <object object at 0x7f962eb7ff50>, egress: 'Egress' = <object object at 0x7f962eb7ff50>, created_at: datetime.datetime = <object object at 0x7f962eb7ff50>, recent_error: str = <object object at 0x7f962eb7ff50>, workers_requested: int = <object object at 0x7f962eb7ff50>, workers_available: int = <object object at 0x7f962eb7ff50>, output_branch: str = <object object at 0x7f962eb7ff50>, resource_requests: 'ResourceSpec' = <object object at 0x7f962eb7ff50>, resource_limits: 'ResourceSpec' = <object object at 0x7f962eb7ff50>, sidecar_resource_limits: 'ResourceSpec' = <object object at 0x7f962eb7ff50>, input: 'Input' = <object object at 0x7f962eb7ff50>, description: str = <object object at 0x7f962eb7ff50>, salt: str = <object object at 0x7f962eb7ff50>, reason: str = <object object at 0x7f962eb7ff50>, service: 'Service' = <object object at 0x7f962eb7ff50>, spout: 'Spout' = <object object at 0x7f962eb7ff50>, datum_set_spec: 'DatumSetSpec' = <object object at 0x7f962eb7ff50>, datum_timeout: datetime.timedelta = <object object at 0x7f962eb7ff50>, job_timeout: datetime.timedelta = <object object at 0x7f962eb7ff50>, datum_tries: int = <object object at 0x7f962eb7ff50>, scheduling_spec: 'SchedulingSpec' = <object object at 0x7f962eb7ff50>, pod_spec: str = <object object at 0x7f962eb7ff50>, pod_patch: str = <object object at 0x7f962eb7ff50>, s3_out: bool = <object object at 0x7f962eb7ff50>, metadata: 'Metadata' = <object object at 0x7f962eb7ff50>, reprocess_spec: str = <object object at 0x7f962eb7ff50>, unclaimed_tasks: int = <object object at 0x7f962eb7ff50>, worker_rc: str = <object object at 0x7f962eb7ff50>, autoscaling: bool = <object object at 0x7f962eb7ff50>)

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)

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 0x7f962eb7ff50>)

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)

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 0x7f962eb7ff50>, process_time: datetime.timedelta = <object object at 0x7f962eb7ff50>, upload_time: datetime.timedelta = <object object at 0x7f962eb7ff50>, download_bytes: int = <object object at 0x7f962eb7ff50>, upload_bytes: int = <object object at 0x7f962eb7ff50>)

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 RenderTemplateRequest(template: str = <object object at 0x7f962eb7ff50>, args: Dict[str, str] = <object object at 0x7f962eb7ff50>)

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.

args = <object object>

template = <object object>

class RenderTemplateResponse(json: str = <object object at 0x7f962eb7ff50>, specs: List[ForwardRef('CreatePipelineRequest')] = <object object at 0x7f962eb7ff50>)

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.

json = <object object>

specs = <object object>

class ResourceSpec(cpu=<object object>, memory=<object object>, gpu=<object object>, disk=<object object>)

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 0x7f962eb7ff50>, data_filters: List[str] = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, provenance: List[ForwardRef('_pfs_v2__.Commit')] = <object object at 0x7f962eb7ff50>, job_id: str = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, priority_class_name: str = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, type: str = <object object at 0x7f962eb7ff50>, creation_timestamp: datetime.datetime = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, key: str = <object object at 0x7f962eb7ff50>, mount_path: str = <object object at 0x7f962eb7ff50>, env_var: str = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, external_port: int = <object object at 0x7f962eb7ff50>, ip: str = <object object at 0x7f962eb7ff50>, type: str = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>)

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 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, reason: str = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>)

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>)

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 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, cmd: List[str] = <object object at 0x7f962eb7ff50>, err_cmd: List[str] = <object object at 0x7f962eb7ff50>, env: Dict[str, str] = <object object at 0x7f962eb7ff50>, secrets: List[ForwardRef('SecretMount')] = <object object at 0x7f962eb7ff50>, image_pull_secrets: List[str] = <object object at 0x7f962eb7ff50>, stdin: List[str] = <object object at 0x7f962eb7ff50>, err_stdin: List[str] = <object object at 0x7f962eb7ff50>, accept_return_code: List[int] = <object object at 0x7f962eb7ff50>, debug: bool = <object object at 0x7f962eb7ff50>, user: str = <object object at 0x7f962eb7ff50>, working_dir: str = <object object at 0x7f962eb7ff50>, dockerfile: str = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, state: 'JobState' = <object object at 0x7f962eb7ff50>, reason: str = <object object at 0x7f962eb7ff50>, restart: int = <object object at 0x7f962eb7ff50>, data_processed: int = <object object at 0x7f962eb7ff50>, data_skipped: int = <object object at 0x7f962eb7ff50>, data_failed: int = <object object at 0x7f962eb7ff50>, data_recovered: int = <object object at 0x7f962eb7ff50>, data_total: int = <object object at 0x7f962eb7ff50>, stats: 'ProcessStats' = <object object at 0x7f962eb7ff50>)

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 0x7f962eb7ff50>, state: 'WorkerState' = <object object at 0x7f962eb7ff50>)

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)

An enumeration.

POD_FAILED = 3

POD_RUNNING = 1

POD_SUCCESS = 2

WORKER_STATE_UNKNOWN = 0

class WorkerStatus(worker_id: str = <object object at 0x7f962eb7ff50>, job_id: str = <object object at 0x7f962eb7ff50>, datum_status: 'DatumStatus' = <object object at 0x7f962eb7ff50>)

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>

Transaction proto

class BatchTransactionRequest(requests: List[ForwardRef('TransactionRequest')] = <object object at 0x7f962eb7ff50>)

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.

requests = <object object>

class DeleteAllRequest

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 DeleteTransactionRequest(transaction: 'Transaction' = <object object at 0x7f962eb7ff50>)

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.

transaction = <object object>

class FinishTransactionRequest(transaction: 'Transaction' = <object object at 0x7f962eb7ff50>)

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.

transaction = <object object>

class InspectTransactionRequest(transaction: 'Transaction' = <object object at 0x7f962eb7ff50>)

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.

transaction = <object object>

class ListTransactionRequest

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 StartTransactionRequest

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 Transaction(id: str = <object object at 0x7f962eb7ff50>)

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 TransactionInfo(transaction: 'Transaction' = <object object at 0x7f962eb7ff50>, requests: List[ForwardRef('TransactionRequest')] = <object object at 0x7f962eb7ff50>, responses: List[ForwardRef('TransactionResponse')] = <object object at 0x7f962eb7ff50>, started: datetime.datetime = <object object at 0x7f962eb7ff50>, version: int = <object object at 0x7f962eb7ff50>)

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.

requests = <object object>

responses = <object object>

started = <object object>

transaction = <object object>

version = <object object>

class TransactionInfos(transaction_info: List[ForwardRef('TransactionInfo')] = <object object at 0x7f962eb7ff50>)

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.

transaction_info = <object object>

class TransactionRequest(create_repo: '_pfs_v2__.CreateRepoRequest' = <object object at 0x7f962eb7ff50>, delete_repo: '_pfs_v2__.DeleteRepoRequest' = <object object at 0x7f962eb7ff50>, start_commit: '_pfs_v2__.StartCommitRequest' = <object object at 0x7f962eb7ff50>, finish_commit: '_pfs_v2__.FinishCommitRequest' = <object object at 0x7f962eb7ff50>, squash_commit_set: '_pfs_v2__.SquashCommitSetRequest' = <object object at 0x7f962eb7ff50>, create_branch: '_pfs_v2__.CreateBranchRequest' = <object object at 0x7f962eb7ff50>, delete_branch: '_pfs_v2__.DeleteBranchRequest' = <object object at 0x7f962eb7ff50>, update_job_state: '_pps_v2__.UpdateJobStateRequest' = <object object at 0x7f962eb7ff50>, create_pipeline: '_pps_v2__.CreatePipelineRequest' = <object object at 0x7f962eb7ff50>, stop_job: '_pps_v2__.StopJobRequest' = <object object at 0x7f962eb7ff50>)

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.

create_branch = <object object>

create_pipeline = <object object>

create_repo = <object object>

delete_branch = <object object>

delete_repo = <object object>

finish_commit = <object object>

squash_commit_set = <object object>

start_commit = <object object>

stop_job = <object object>

update_job_state = <object object>

class TransactionResponse(commit: '_pfs_v2__.Commit' = <object object at 0x7f962eb7ff50>)

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>

Version proto

class Version(major: int = <object object at 0x7f962eb7ff50>, minor: int = <object object at 0x7f962eb7ff50>, micro: int = <object object at 0x7f962eb7ff50>, additional: str = <object object at 0x7f962eb7ff50>)

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.

additional = <object object>

major = <object object>

micro = <object object>

minor = <object object>