Documentation ¶
Overview ¶
Package enterprise is a generated protocol buffer package.
It is generated from these files:
client/enterprise/enterprise.proto
It has these top-level messages:
EnterpriseRecord TokenInfo ActivateRequest ActivateResponse GetStateRequest GetStateResponse DeactivateRequest DeactivateResponse
Index ¶
- Variables
- func RegisterAPIServer(s *grpc.Server, srv APIServer)
- type APIClient
- type APIServer
- type ActivateRequest
- func (*ActivateRequest) Descriptor() ([]byte, []int)
- func (m *ActivateRequest) GetActivationCode() string
- func (m *ActivateRequest) GetExpires() *google_protobuf.Timestamp
- func (m *ActivateRequest) Marshal() (dAtA []byte, err error)
- func (m *ActivateRequest) MarshalTo(dAtA []byte) (int, error)
- func (*ActivateRequest) ProtoMessage()
- func (m *ActivateRequest) Reset()
- func (m *ActivateRequest) Size() (n int)
- func (m *ActivateRequest) String() string
- func (m *ActivateRequest) Unmarshal(dAtA []byte) error
- type ActivateResponse
- func (*ActivateResponse) Descriptor() ([]byte, []int)
- func (m *ActivateResponse) GetInfo() *TokenInfo
- func (m *ActivateResponse) Marshal() (dAtA []byte, err error)
- func (m *ActivateResponse) MarshalTo(dAtA []byte) (int, error)
- func (*ActivateResponse) ProtoMessage()
- func (m *ActivateResponse) Reset()
- func (m *ActivateResponse) Size() (n int)
- func (m *ActivateResponse) String() string
- func (m *ActivateResponse) Unmarshal(dAtA []byte) error
- type DeactivateRequest
- func (*DeactivateRequest) Descriptor() ([]byte, []int)
- func (m *DeactivateRequest) Marshal() (dAtA []byte, err error)
- func (m *DeactivateRequest) MarshalTo(dAtA []byte) (int, error)
- func (*DeactivateRequest) ProtoMessage()
- func (m *DeactivateRequest) Reset()
- func (m *DeactivateRequest) Size() (n int)
- func (m *DeactivateRequest) String() string
- func (m *DeactivateRequest) Unmarshal(dAtA []byte) error
- type DeactivateResponse
- func (*DeactivateResponse) Descriptor() ([]byte, []int)
- func (m *DeactivateResponse) Marshal() (dAtA []byte, err error)
- func (m *DeactivateResponse) MarshalTo(dAtA []byte) (int, error)
- func (*DeactivateResponse) ProtoMessage()
- func (m *DeactivateResponse) Reset()
- func (m *DeactivateResponse) Size() (n int)
- func (m *DeactivateResponse) String() string
- func (m *DeactivateResponse) Unmarshal(dAtA []byte) error
- type EnterpriseRecord
- func (*EnterpriseRecord) Descriptor() ([]byte, []int)
- func (m *EnterpriseRecord) GetActivationCode() string
- func (m *EnterpriseRecord) GetExpires() *google_protobuf.Timestamp
- func (m *EnterpriseRecord) Marshal() (dAtA []byte, err error)
- func (m *EnterpriseRecord) MarshalTo(dAtA []byte) (int, error)
- func (*EnterpriseRecord) ProtoMessage()
- func (m *EnterpriseRecord) Reset()
- func (m *EnterpriseRecord) Size() (n int)
- func (m *EnterpriseRecord) String() string
- func (m *EnterpriseRecord) Unmarshal(dAtA []byte) error
- type GetStateRequest
- func (*GetStateRequest) Descriptor() ([]byte, []int)
- func (m *GetStateRequest) Marshal() (dAtA []byte, err error)
- func (m *GetStateRequest) MarshalTo(dAtA []byte) (int, error)
- func (*GetStateRequest) ProtoMessage()
- func (m *GetStateRequest) Reset()
- func (m *GetStateRequest) Size() (n int)
- func (m *GetStateRequest) String() string
- func (m *GetStateRequest) Unmarshal(dAtA []byte) error
- type GetStateResponse
- func (*GetStateResponse) Descriptor() ([]byte, []int)
- func (m *GetStateResponse) GetInfo() *TokenInfo
- func (m *GetStateResponse) GetState() State
- func (m *GetStateResponse) Marshal() (dAtA []byte, err error)
- func (m *GetStateResponse) MarshalTo(dAtA []byte) (int, error)
- func (*GetStateResponse) ProtoMessage()
- func (m *GetStateResponse) Reset()
- func (m *GetStateResponse) Size() (n int)
- func (m *GetStateResponse) String() string
- func (m *GetStateResponse) Unmarshal(dAtA []byte) error
- type State
- type TokenInfo
- func (*TokenInfo) Descriptor() ([]byte, []int)
- func (m *TokenInfo) GetExpires() *google_protobuf.Timestamp
- func (m *TokenInfo) Marshal() (dAtA []byte, err error)
- func (m *TokenInfo) MarshalTo(dAtA []byte) (int, error)
- func (*TokenInfo) ProtoMessage()
- func (m *TokenInfo) Reset()
- func (m *TokenInfo) Size() (n int)
- func (m *TokenInfo) String() string
- func (m *TokenInfo) Unmarshal(dAtA []byte) error
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrInvalidLengthEnterprise = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowEnterprise = fmt.Errorf("proto: integer overflow") )
View Source
var State_name = map[int32]string{
0: "NONE",
1: "ACTIVE",
2: "EXPIRED",
}
View Source
var State_value = map[string]int32{
"NONE": 0,
"ACTIVE": 1,
"EXPIRED": 2,
}
Functions ¶
func RegisterAPIServer ¶
Types ¶
type APIClient ¶
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) }
func NewAPIClient ¶
func NewAPIClient(cc *grpc.ClientConn) APIClient
type APIServer ¶
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) }
type ActivateRequest ¶
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 *google_protobuf.Timestamp `protobuf:"bytes,2,opt,name=expires" json:"expires,omitempty"` }
func (*ActivateRequest) Descriptor ¶
func (*ActivateRequest) Descriptor() ([]byte, []int)
func (*ActivateRequest) GetActivationCode ¶
func (m *ActivateRequest) GetActivationCode() string
func (*ActivateRequest) GetExpires ¶
func (m *ActivateRequest) GetExpires() *google_protobuf.Timestamp
func (*ActivateRequest) Marshal ¶
func (m *ActivateRequest) Marshal() (dAtA []byte, err error)
func (*ActivateRequest) ProtoMessage ¶
func (*ActivateRequest) ProtoMessage()
func (*ActivateRequest) Reset ¶
func (m *ActivateRequest) Reset()
func (*ActivateRequest) Size ¶
func (m *ActivateRequest) Size() (n int)
func (*ActivateRequest) String ¶
func (m *ActivateRequest) String() string
func (*ActivateRequest) Unmarshal ¶
func (m *ActivateRequest) Unmarshal(dAtA []byte) error
type ActivateResponse ¶
type ActivateResponse struct {
Info *TokenInfo `protobuf:"bytes,1,opt,name=info" json:"info,omitempty"`
}
func (*ActivateResponse) Descriptor ¶
func (*ActivateResponse) Descriptor() ([]byte, []int)
func (*ActivateResponse) GetInfo ¶
func (m *ActivateResponse) GetInfo() *TokenInfo
func (*ActivateResponse) Marshal ¶
func (m *ActivateResponse) Marshal() (dAtA []byte, err error)
func (*ActivateResponse) ProtoMessage ¶
func (*ActivateResponse) ProtoMessage()
func (*ActivateResponse) Reset ¶
func (m *ActivateResponse) Reset()
func (*ActivateResponse) Size ¶
func (m *ActivateResponse) Size() (n int)
func (*ActivateResponse) String ¶
func (m *ActivateResponse) String() string
func (*ActivateResponse) Unmarshal ¶
func (m *ActivateResponse) Unmarshal(dAtA []byte) error
type DeactivateRequest ¶ added in v1.7.0
type DeactivateRequest struct { }
func (*DeactivateRequest) Descriptor ¶ added in v1.7.0
func (*DeactivateRequest) Descriptor() ([]byte, []int)
func (*DeactivateRequest) Marshal ¶ added in v1.7.0
func (m *DeactivateRequest) Marshal() (dAtA []byte, err error)
func (*DeactivateRequest) MarshalTo ¶ added in v1.7.0
func (m *DeactivateRequest) MarshalTo(dAtA []byte) (int, error)
func (*DeactivateRequest) ProtoMessage ¶ added in v1.7.0
func (*DeactivateRequest) ProtoMessage()
func (*DeactivateRequest) Reset ¶ added in v1.7.0
func (m *DeactivateRequest) Reset()
func (*DeactivateRequest) Size ¶ added in v1.7.0
func (m *DeactivateRequest) Size() (n int)
func (*DeactivateRequest) String ¶ added in v1.7.0
func (m *DeactivateRequest) String() string
func (*DeactivateRequest) Unmarshal ¶ added in v1.7.0
func (m *DeactivateRequest) Unmarshal(dAtA []byte) error
type DeactivateResponse ¶ added in v1.7.0
type DeactivateResponse struct { }
func (*DeactivateResponse) Descriptor ¶ added in v1.7.0
func (*DeactivateResponse) Descriptor() ([]byte, []int)
func (*DeactivateResponse) Marshal ¶ added in v1.7.0
func (m *DeactivateResponse) Marshal() (dAtA []byte, err error)
func (*DeactivateResponse) MarshalTo ¶ added in v1.7.0
func (m *DeactivateResponse) MarshalTo(dAtA []byte) (int, error)
func (*DeactivateResponse) ProtoMessage ¶ added in v1.7.0
func (*DeactivateResponse) ProtoMessage()
func (*DeactivateResponse) Reset ¶ added in v1.7.0
func (m *DeactivateResponse) Reset()
func (*DeactivateResponse) Size ¶ added in v1.7.0
func (m *DeactivateResponse) Size() (n int)
func (*DeactivateResponse) String ¶ added in v1.7.0
func (m *DeactivateResponse) String() string
func (*DeactivateResponse) Unmarshal ¶ added in v1.7.0
func (m *DeactivateResponse) Unmarshal(dAtA []byte) error
type EnterpriseRecord ¶
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 *google_protobuf.Timestamp `protobuf:"bytes,2,opt,name=expires" json:"expires,omitempty"` }
EnterpriseRecord is the record we store in etcd for a Pachyderm enterprise token that has been provided to a Pachyderm cluster
func (*EnterpriseRecord) Descriptor ¶
func (*EnterpriseRecord) Descriptor() ([]byte, []int)
func (*EnterpriseRecord) GetActivationCode ¶
func (m *EnterpriseRecord) GetActivationCode() string
func (*EnterpriseRecord) GetExpires ¶
func (m *EnterpriseRecord) GetExpires() *google_protobuf.Timestamp
func (*EnterpriseRecord) Marshal ¶
func (m *EnterpriseRecord) Marshal() (dAtA []byte, err error)
func (*EnterpriseRecord) ProtoMessage ¶
func (*EnterpriseRecord) ProtoMessage()
func (*EnterpriseRecord) Reset ¶
func (m *EnterpriseRecord) Reset()
func (*EnterpriseRecord) Size ¶
func (m *EnterpriseRecord) Size() (n int)
func (*EnterpriseRecord) String ¶
func (m *EnterpriseRecord) String() string
func (*EnterpriseRecord) Unmarshal ¶
func (m *EnterpriseRecord) Unmarshal(dAtA []byte) error
type GetStateRequest ¶
type GetStateRequest struct { }
func (*GetStateRequest) Descriptor ¶
func (*GetStateRequest) Descriptor() ([]byte, []int)
func (*GetStateRequest) Marshal ¶
func (m *GetStateRequest) Marshal() (dAtA []byte, err error)
func (*GetStateRequest) ProtoMessage ¶
func (*GetStateRequest) ProtoMessage()
func (*GetStateRequest) Reset ¶
func (m *GetStateRequest) Reset()
func (*GetStateRequest) Size ¶
func (m *GetStateRequest) Size() (n int)
func (*GetStateRequest) String ¶
func (m *GetStateRequest) String() string
func (*GetStateRequest) Unmarshal ¶
func (m *GetStateRequest) Unmarshal(dAtA []byte) error
type GetStateResponse ¶
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" json:"info,omitempty"` }
func (*GetStateResponse) Descriptor ¶
func (*GetStateResponse) Descriptor() ([]byte, []int)
func (*GetStateResponse) GetInfo ¶
func (m *GetStateResponse) GetInfo() *TokenInfo
func (*GetStateResponse) GetState ¶
func (m *GetStateResponse) GetState() State
func (*GetStateResponse) Marshal ¶
func (m *GetStateResponse) Marshal() (dAtA []byte, err error)
func (*GetStateResponse) ProtoMessage ¶
func (*GetStateResponse) ProtoMessage()
func (*GetStateResponse) Reset ¶
func (m *GetStateResponse) Reset()
func (*GetStateResponse) Size ¶
func (m *GetStateResponse) Size() (n int)
func (*GetStateResponse) String ¶
func (m *GetStateResponse) String() string
func (*GetStateResponse) Unmarshal ¶
func (m *GetStateResponse) Unmarshal(dAtA []byte) error
type TokenInfo ¶
type TokenInfo struct { // expires indicates when the current token expires (unset if there is no // current token) Expires *google_protobuf.Timestamp `protobuf:"bytes,1,opt,name=expires" json:"expires,omitempty"` }
TokenInfo contains information about the currently active enterprise token
func (*TokenInfo) Descriptor ¶
func (*TokenInfo) GetExpires ¶
func (m *TokenInfo) GetExpires() *google_protobuf.Timestamp
func (*TokenInfo) ProtoMessage ¶
func (*TokenInfo) ProtoMessage()
Click to show internal directories.
Click to hide internal directories.