python_pachyderm.experimental.proto.v2.enterprise_v2 package

Module contents

class ActivateRequest(license_server: str = <object object at 0x7f2cabcb78b0>, id: str = <object object at 0x7f2cabcb78b0>, secret: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

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

id = <object object>

license_server = <object object>

secret = <object object>

class ActivateResponse[source]

Bases: betterproto.Message

Methods

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

class ApiBase[source]

Bases: betterproto.grpc.grpclib_server.ServiceBase

Methods

activate
deactivate
get_activation_code
get_state
heartbeat

async activate(license_server, id, secret)[source]

async deactivate()[source]

async get_activation_code()[source]

async get_state()[source]

async heartbeat()[source]

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

Bases: betterproto.grpc.grpclib_client.ServiceStub

Methods

activate
deactivate
get_activation_code
get_state
heartbeat

async activate(*, license_server='', id='', secret='')[source]

async deactivate()[source]

async get_activation_code()[source]

async get_state()[source]

async heartbeat()[source]

class DeactivateRequest[source]

Bases: betterproto.Message

Methods

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

class DeactivateResponse[source]

Bases: betterproto.Message

Methods

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

class EnterpriseConfig(license_server=<object object>, id=<object object>, secret=<object object>)[source]

Bases: betterproto.Message

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>)[source]

Bases: betterproto.Message

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[source]

Bases: betterproto.Message

Methods

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

class GetActivationCodeResponse(state: 'State' = <object object at 0x7f2cabcb78b0>, info: 'TokenInfo' = <object object at 0x7f2cabcb78b0>, activation_code: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

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

activation_code = <object object>

info = <object object>

state = <object object>

class GetStateRequest[source]

Bases: betterproto.Message

Methods

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

class GetStateResponse(state: 'State' = <object object at 0x7f2cabcb78b0>, info: 'TokenInfo' = <object object at 0x7f2cabcb78b0>, activation_code: str = <object object at 0x7f2cabcb78b0>)[source]

Bases: betterproto.Message

Methods

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

activation_code = <object object>

info = <object object>

state = <object object>

class HeartbeatRequest[source]

Bases: betterproto.Message

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[source]

Bases: betterproto.Message

Methods

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

class LicenseRecord(activation_code=<object object>, expires=<object object>)[source]

Bases: betterproto.Message

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 State(value)[source]

Bases: betterproto.Enum

An enumeration.

ACTIVE = 1

EXPIRED = 2

HEARTBEAT_FAILED = 3

NONE = 0

class TokenInfo(expires=<object object>)[source]

Bases: betterproto.Message

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