pachyderm: github.com/pachyderm/pachyderm/src/client/enterprise Index | Files

package enterprise

import "github.com/pachyderm/pachyderm/src/client/enterprise"

Index

Package Files

enterprise.pb.go

Variables

var (
    ErrInvalidLengthEnterprise = fmt.Errorf("proto: negative length found during unmarshaling")
    ErrIntOverflowEnterprise   = fmt.Errorf("proto: integer overflow")
)
var State_name = map[int32]string{
    0:  "NONE",
    1:  "ACTIVE",
    2:  "EXPIRED",
}
var State_value = map[string]int32{
    "NONE":    0,
    "ACTIVE":  1,
    "EXPIRED": 2,
}

func RegisterAPIServer Uses

func RegisterAPIServer(s *grpc.Server, srv APIServer)

type APIClient Uses

type APIClient interface {
    // Provide a Pachyderm enterprise token, enabling Pachyderm enterprise
    // features, such as the Pachyderm Dashboard and Auth system
    Activate(ctx context.Context, in *ActivateRequest, opts ...grpc.CallOption) (*ActivateResponse, error)
    GetState(ctx context.Context, in *GetStateRequest, opts ...grpc.CallOption) (*GetStateResponse, error)
    // Deactivate is a testing API. It removes a cluster's enterprise activation
    // token and sets its enterprise state to NONE (normally, once a cluster has
    // been activated, the only reachable state is EXPIRED).
    //
    // NOTE: This endpoint also calls DeleteAll (and deletes all Pachyderm data in
    // its cluster). This is to avoid dealing with invalid, intermediate states
    // (e.g. auth is activated but enterprise state is NONE)
    Deactivate(ctx context.Context, in *DeactivateRequest, opts ...grpc.CallOption) (*DeactivateResponse, error)
}

APIClient is the client API for API service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewAPIClient Uses

func NewAPIClient(cc *grpc.ClientConn) APIClient

type APIServer Uses

type APIServer interface {
    // Provide a Pachyderm enterprise token, enabling Pachyderm enterprise
    // features, such as the Pachyderm Dashboard and Auth system
    Activate(context.Context, *ActivateRequest) (*ActivateResponse, error)
    GetState(context.Context, *GetStateRequest) (*GetStateResponse, error)
    // Deactivate is a testing API. It removes a cluster's enterprise activation
    // token and sets its enterprise state to NONE (normally, once a cluster has
    // been activated, the only reachable state is EXPIRED).
    //
    // NOTE: This endpoint also calls DeleteAll (and deletes all Pachyderm data in
    // its cluster). This is to avoid dealing with invalid, intermediate states
    // (e.g. auth is activated but enterprise state is NONE)
    Deactivate(context.Context, *DeactivateRequest) (*DeactivateResponse, error)
}

APIServer is the server API for API service.

type ActivateRequest Uses

type ActivateRequest struct {
    // activation_code is a Pachyderm enterprise activation code. New users can
    // obtain trial activation codes
    ActivationCode string `protobuf:"bytes,1,opt,name=activation_code,json=activationCode,proto3" json:"activation_code,omitempty"`
    // expires is a timestamp indicating when this activation code will expire.
    // This should not generally be set (it's primarily used for testing), and is
    // only applied if it's earlier than the signed expiration time in
    // 'activation_code'.
    Expires              *types.Timestamp `protobuf:"bytes,2,opt,name=expires,proto3" json:"expires,omitempty"`
    XXX_NoUnkeyedLiteral struct{}         `json:"-"`
    XXX_unrecognized     []byte           `json:"-"`
    XXX_sizecache        int32            `json:"-"`
}

func (*ActivateRequest) Descriptor Uses

func (*ActivateRequest) Descriptor() ([]byte, []int)

func (*ActivateRequest) GetActivationCode Uses

func (m *ActivateRequest) GetActivationCode() string

func (*ActivateRequest) GetExpires Uses

func (m *ActivateRequest) GetExpires() *types.Timestamp

func (*ActivateRequest) Marshal Uses

func (m *ActivateRequest) Marshal() (dAtA []byte, err error)

func (*ActivateRequest) MarshalTo Uses

func (m *ActivateRequest) MarshalTo(dAtA []byte) (int, error)

func (*ActivateRequest) MarshalToSizedBuffer Uses

func (m *ActivateRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ActivateRequest) ProtoMessage Uses

func (*ActivateRequest) ProtoMessage()

func (*ActivateRequest) Reset Uses

func (m *ActivateRequest) Reset()

func (*ActivateRequest) Size Uses

func (m *ActivateRequest) Size() (n int)

func (*ActivateRequest) String Uses

func (m *ActivateRequest) String() string

func (*ActivateRequest) Unmarshal Uses

func (m *ActivateRequest) Unmarshal(dAtA []byte) error

func (*ActivateRequest) XXX_DiscardUnknown Uses

func (m *ActivateRequest) XXX_DiscardUnknown()

func (*ActivateRequest) XXX_Marshal Uses

func (m *ActivateRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ActivateRequest) XXX_Merge Uses

func (m *ActivateRequest) XXX_Merge(src proto.Message)

func (*ActivateRequest) XXX_Size Uses

func (m *ActivateRequest) XXX_Size() int

func (*ActivateRequest) XXX_Unmarshal Uses

func (m *ActivateRequest) XXX_Unmarshal(b []byte) error

type ActivateResponse Uses

type ActivateResponse struct {
    Info                 *TokenInfo `protobuf:"bytes,1,opt,name=info,proto3" json:"info,omitempty"`
    XXX_NoUnkeyedLiteral struct{}   `json:"-"`
    XXX_unrecognized     []byte     `json:"-"`
    XXX_sizecache        int32      `json:"-"`
}

func (*ActivateResponse) Descriptor Uses

func (*ActivateResponse) Descriptor() ([]byte, []int)

func (*ActivateResponse) GetInfo Uses

func (m *ActivateResponse) GetInfo() *TokenInfo

func (*ActivateResponse) Marshal Uses

func (m *ActivateResponse) Marshal() (dAtA []byte, err error)

func (*ActivateResponse) MarshalTo Uses

func (m *ActivateResponse) MarshalTo(dAtA []byte) (int, error)

func (*ActivateResponse) MarshalToSizedBuffer Uses

func (m *ActivateResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ActivateResponse) ProtoMessage Uses

func (*ActivateResponse) ProtoMessage()

func (*ActivateResponse) Reset Uses

func (m *ActivateResponse) Reset()

func (*ActivateResponse) Size Uses

func (m *ActivateResponse) Size() (n int)

func (*ActivateResponse) String Uses

func (m *ActivateResponse) String() string

func (*ActivateResponse) Unmarshal Uses

func (m *ActivateResponse) Unmarshal(dAtA []byte) error

func (*ActivateResponse) XXX_DiscardUnknown Uses

func (m *ActivateResponse) XXX_DiscardUnknown()

func (*ActivateResponse) XXX_Marshal Uses

func (m *ActivateResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ActivateResponse) XXX_Merge Uses

func (m *ActivateResponse) XXX_Merge(src proto.Message)

func (*ActivateResponse) XXX_Size Uses

func (m *ActivateResponse) XXX_Size() int

func (*ActivateResponse) XXX_Unmarshal Uses

func (m *ActivateResponse) XXX_Unmarshal(b []byte) error

type DeactivateRequest Uses

type DeactivateRequest struct {
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

func (*DeactivateRequest) Descriptor Uses

func (*DeactivateRequest) Descriptor() ([]byte, []int)

func (*DeactivateRequest) Marshal Uses

func (m *DeactivateRequest) Marshal() (dAtA []byte, err error)

func (*DeactivateRequest) MarshalTo Uses

func (m *DeactivateRequest) MarshalTo(dAtA []byte) (int, error)

func (*DeactivateRequest) MarshalToSizedBuffer Uses

func (m *DeactivateRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DeactivateRequest) ProtoMessage Uses

func (*DeactivateRequest) ProtoMessage()

func (*DeactivateRequest) Reset Uses

func (m *DeactivateRequest) Reset()

func (*DeactivateRequest) Size Uses

func (m *DeactivateRequest) Size() (n int)

func (*DeactivateRequest) String Uses

func (m *DeactivateRequest) String() string

func (*DeactivateRequest) Unmarshal Uses

func (m *DeactivateRequest) Unmarshal(dAtA []byte) error

func (*DeactivateRequest) XXX_DiscardUnknown Uses

func (m *DeactivateRequest) XXX_DiscardUnknown()

func (*DeactivateRequest) XXX_Marshal Uses

func (m *DeactivateRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeactivateRequest) XXX_Merge Uses

func (m *DeactivateRequest) XXX_Merge(src proto.Message)

func (*DeactivateRequest) XXX_Size Uses

func (m *DeactivateRequest) XXX_Size() int

func (*DeactivateRequest) XXX_Unmarshal Uses

func (m *DeactivateRequest) XXX_Unmarshal(b []byte) error

type DeactivateResponse Uses

type DeactivateResponse struct {
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

func (*DeactivateResponse) Descriptor Uses

func (*DeactivateResponse) Descriptor() ([]byte, []int)

func (*DeactivateResponse) Marshal Uses

func (m *DeactivateResponse) Marshal() (dAtA []byte, err error)

func (*DeactivateResponse) MarshalTo Uses

func (m *DeactivateResponse) MarshalTo(dAtA []byte) (int, error)

func (*DeactivateResponse) MarshalToSizedBuffer Uses

func (m *DeactivateResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DeactivateResponse) ProtoMessage Uses

func (*DeactivateResponse) ProtoMessage()

func (*DeactivateResponse) Reset Uses

func (m *DeactivateResponse) Reset()

func (*DeactivateResponse) Size Uses

func (m *DeactivateResponse) Size() (n int)

func (*DeactivateResponse) String Uses

func (m *DeactivateResponse) String() string

func (*DeactivateResponse) Unmarshal Uses

func (m *DeactivateResponse) Unmarshal(dAtA []byte) error

func (*DeactivateResponse) XXX_DiscardUnknown Uses

func (m *DeactivateResponse) XXX_DiscardUnknown()

func (*DeactivateResponse) XXX_Marshal Uses

func (m *DeactivateResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeactivateResponse) XXX_Merge Uses

func (m *DeactivateResponse) XXX_Merge(src proto.Message)

func (*DeactivateResponse) XXX_Size Uses

func (m *DeactivateResponse) XXX_Size() int

func (*DeactivateResponse) XXX_Unmarshal Uses

func (m *DeactivateResponse) XXX_Unmarshal(b []byte) error

type EnterpriseRecord Uses

type EnterpriseRecord struct {
    ActivationCode string `protobuf:"bytes,1,opt,name=activation_code,json=activationCode,proto3" json:"activation_code,omitempty"`
    // expires is a timestamp indicating when this activation code will expire.
    Expires              *types.Timestamp `protobuf:"bytes,2,opt,name=expires,proto3" json:"expires,omitempty"`
    XXX_NoUnkeyedLiteral struct{}         `json:"-"`
    XXX_unrecognized     []byte           `json:"-"`
    XXX_sizecache        int32            `json:"-"`
}

EnterpriseRecord is the record we store in etcd for a Pachyderm enterprise token that has been provided to a Pachyderm cluster

func (*EnterpriseRecord) Descriptor Uses

func (*EnterpriseRecord) Descriptor() ([]byte, []int)

func (*EnterpriseRecord) GetActivationCode Uses

func (m *EnterpriseRecord) GetActivationCode() string

func (*EnterpriseRecord) GetExpires Uses

func (m *EnterpriseRecord) GetExpires() *types.Timestamp

func (*EnterpriseRecord) Marshal Uses

func (m *EnterpriseRecord) Marshal() (dAtA []byte, err error)

func (*EnterpriseRecord) MarshalTo Uses

func (m *EnterpriseRecord) MarshalTo(dAtA []byte) (int, error)

func (*EnterpriseRecord) MarshalToSizedBuffer Uses

func (m *EnterpriseRecord) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*EnterpriseRecord) ProtoMessage Uses

func (*EnterpriseRecord) ProtoMessage()

func (*EnterpriseRecord) Reset Uses

func (m *EnterpriseRecord) Reset()

func (*EnterpriseRecord) Size Uses

func (m *EnterpriseRecord) Size() (n int)

func (*EnterpriseRecord) String Uses

func (m *EnterpriseRecord) String() string

func (*EnterpriseRecord) Unmarshal Uses

func (m *EnterpriseRecord) Unmarshal(dAtA []byte) error

func (*EnterpriseRecord) XXX_DiscardUnknown Uses

func (m *EnterpriseRecord) XXX_DiscardUnknown()

func (*EnterpriseRecord) XXX_Marshal Uses

func (m *EnterpriseRecord) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*EnterpriseRecord) XXX_Merge Uses

func (m *EnterpriseRecord) XXX_Merge(src proto.Message)

func (*EnterpriseRecord) XXX_Size Uses

func (m *EnterpriseRecord) XXX_Size() int

func (*EnterpriseRecord) XXX_Unmarshal Uses

func (m *EnterpriseRecord) XXX_Unmarshal(b []byte) error

type GetStateRequest Uses

type GetStateRequest struct {
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

func (*GetStateRequest) Descriptor Uses

func (*GetStateRequest) Descriptor() ([]byte, []int)

func (*GetStateRequest) Marshal Uses

func (m *GetStateRequest) Marshal() (dAtA []byte, err error)

func (*GetStateRequest) MarshalTo Uses

func (m *GetStateRequest) MarshalTo(dAtA []byte) (int, error)

func (*GetStateRequest) MarshalToSizedBuffer Uses

func (m *GetStateRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*GetStateRequest) ProtoMessage Uses

func (*GetStateRequest) ProtoMessage()

func (*GetStateRequest) Reset Uses

func (m *GetStateRequest) Reset()

func (*GetStateRequest) Size Uses

func (m *GetStateRequest) Size() (n int)

func (*GetStateRequest) String Uses

func (m *GetStateRequest) String() string

func (*GetStateRequest) Unmarshal Uses

func (m *GetStateRequest) Unmarshal(dAtA []byte) error

func (*GetStateRequest) XXX_DiscardUnknown Uses

func (m *GetStateRequest) XXX_DiscardUnknown()

func (*GetStateRequest) XXX_Marshal Uses

func (m *GetStateRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetStateRequest) XXX_Merge Uses

func (m *GetStateRequest) XXX_Merge(src proto.Message)

func (*GetStateRequest) XXX_Size Uses

func (m *GetStateRequest) XXX_Size() int

func (*GetStateRequest) XXX_Unmarshal Uses

func (m *GetStateRequest) XXX_Unmarshal(b []byte) error

type GetStateResponse Uses

type GetStateResponse struct {
    State                State      `protobuf:"varint,1,opt,name=state,proto3,enum=enterprise.State" json:"state,omitempty"`
    Info                 *TokenInfo `protobuf:"bytes,2,opt,name=info,proto3" json:"info,omitempty"`
    ActivationCode       string     `protobuf:"bytes,3,opt,name=activation_code,json=activationCode,proto3" json:"activation_code,omitempty"`
    XXX_NoUnkeyedLiteral struct{}   `json:"-"`
    XXX_unrecognized     []byte     `json:"-"`
    XXX_sizecache        int32      `json:"-"`
}

func (*GetStateResponse) Descriptor Uses

func (*GetStateResponse) Descriptor() ([]byte, []int)

func (*GetStateResponse) GetActivationCode Uses

func (m *GetStateResponse) GetActivationCode() string

func (*GetStateResponse) GetInfo Uses

func (m *GetStateResponse) GetInfo() *TokenInfo

func (*GetStateResponse) GetState Uses

func (m *GetStateResponse) GetState() State

func (*GetStateResponse) Marshal Uses

func (m *GetStateResponse) Marshal() (dAtA []byte, err error)

func (*GetStateResponse) MarshalTo Uses

func (m *GetStateResponse) MarshalTo(dAtA []byte) (int, error)

func (*GetStateResponse) MarshalToSizedBuffer Uses

func (m *GetStateResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*GetStateResponse) ProtoMessage Uses

func (*GetStateResponse) ProtoMessage()

func (*GetStateResponse) Reset Uses

func (m *GetStateResponse) Reset()

func (*GetStateResponse) Size Uses

func (m *GetStateResponse) Size() (n int)

func (*GetStateResponse) String Uses

func (m *GetStateResponse) String() string

func (*GetStateResponse) Unmarshal Uses

func (m *GetStateResponse) Unmarshal(dAtA []byte) error

func (*GetStateResponse) XXX_DiscardUnknown Uses

func (m *GetStateResponse) XXX_DiscardUnknown()

func (*GetStateResponse) XXX_Marshal Uses

func (m *GetStateResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetStateResponse) XXX_Merge Uses

func (m *GetStateResponse) XXX_Merge(src proto.Message)

func (*GetStateResponse) XXX_Size Uses

func (m *GetStateResponse) XXX_Size() int

func (*GetStateResponse) XXX_Unmarshal Uses

func (m *GetStateResponse) XXX_Unmarshal(b []byte) error

type State Uses

type State int32
const (
    State_NONE    State = 0
    State_ACTIVE  State = 1
    State_EXPIRED State = 2
)

func (State) EnumDescriptor Uses

func (State) EnumDescriptor() ([]byte, []int)

func (State) String Uses

func (x State) String() string

type TokenInfo Uses

type TokenInfo struct {
    // expires indicates when the current token expires (unset if there is no
    // current token)
    Expires              *types.Timestamp `protobuf:"bytes,1,opt,name=expires,proto3" json:"expires,omitempty"`
    XXX_NoUnkeyedLiteral struct{}         `json:"-"`
    XXX_unrecognized     []byte           `json:"-"`
    XXX_sizecache        int32            `json:"-"`
}

TokenInfo contains information about the currently active enterprise token

func (*TokenInfo) Descriptor Uses

func (*TokenInfo) Descriptor() ([]byte, []int)

func (*TokenInfo) GetExpires Uses

func (m *TokenInfo) GetExpires() *types.Timestamp

func (*TokenInfo) Marshal Uses

func (m *TokenInfo) Marshal() (dAtA []byte, err error)

func (*TokenInfo) MarshalTo Uses

func (m *TokenInfo) MarshalTo(dAtA []byte) (int, error)

func (*TokenInfo) MarshalToSizedBuffer Uses

func (m *TokenInfo) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*TokenInfo) ProtoMessage Uses

func (*TokenInfo) ProtoMessage()

func (*TokenInfo) Reset Uses

func (m *TokenInfo) Reset()

func (*TokenInfo) Size Uses

func (m *TokenInfo) Size() (n int)

func (*TokenInfo) String Uses

func (m *TokenInfo) String() string

func (*TokenInfo) Unmarshal Uses

func (m *TokenInfo) Unmarshal(dAtA []byte) error

func (*TokenInfo) XXX_DiscardUnknown Uses

func (m *TokenInfo) XXX_DiscardUnknown()

func (*TokenInfo) XXX_Marshal Uses

func (m *TokenInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TokenInfo) XXX_Merge Uses

func (m *TokenInfo) XXX_Merge(src proto.Message)

func (*TokenInfo) XXX_Size Uses

func (m *TokenInfo) XXX_Size() int

func (*TokenInfo) XXX_Unmarshal Uses

func (m *TokenInfo) XXX_Unmarshal(b []byte) error

type UnimplementedAPIServer Uses

type UnimplementedAPIServer struct {
}

UnimplementedAPIServer can be embedded to have forward compatible implementations.

func (*UnimplementedAPIServer) Activate Uses

func (*UnimplementedAPIServer) Activate(ctx context.Context, req *ActivateRequest) (*ActivateResponse, error)

func (*UnimplementedAPIServer) Deactivate Uses

func (*UnimplementedAPIServer) Deactivate(ctx context.Context, req *DeactivateRequest) (*DeactivateResponse, error)

func (*UnimplementedAPIServer) GetState Uses

func (*UnimplementedAPIServer) GetState(ctx context.Context, req *GetStateRequest) (*GetStateResponse, error)

Package enterprise imports 10 packages (graph) and is imported by 14 packages. Updated 2019-09-10. Refresh now. Tools for package owners.