debugv1

Documentation

Index

• Variables
• func RegisterDebugServer(s grpc.ServiceRegistrar, srv DebugServer)
• type DebugClient
  • func NewDebugClient(cc grpc.ClientConnInterface) DebugClient
• type DebugServer
• type GetInfoRequest
  • func (*GetInfoRequest) Descriptor() ([]byte, []int)
  • func (*GetInfoRequest) ProtoMessage()
  • func (x *GetInfoRequest) ProtoReflect() protoreflect.Message
  • func (x *GetInfoRequest) Reset()
  • func (x *GetInfoRequest) String() string
• type GetInfoResponse
  • func (*GetInfoResponse) Descriptor() ([]byte, []int)
  • func (x *GetInfoResponse) GetAgentsCount() int32
  • func (x *GetInfoResponse) GetEntriesCount() int32
  • func (x *GetInfoResponse) GetFederatedBundlesCount() int32
  • func (x *GetInfoResponse) GetSvidChain() []*GetInfoResponse_Cert
  • func (x *GetInfoResponse) GetUptime() int32
  • func (*GetInfoResponse) ProtoMessage()
  • func (x *GetInfoResponse) ProtoReflect() protoreflect.Message
  • func (x *GetInfoResponse) Reset()
  • func (x *GetInfoResponse) String() string
• type GetInfoResponse_Cert
  • func (*GetInfoResponse_Cert) Descriptor() ([]byte, []int)
  • func (x *GetInfoResponse_Cert) GetExpiresAt() int64
  • func (x *GetInfoResponse_Cert) GetId() *types.SPIFFEID
  • func (x *GetInfoResponse_Cert) GetSubject() string
  • func (*GetInfoResponse_Cert) ProtoMessage()
  • func (x *GetInfoResponse_Cert) ProtoReflect() protoreflect.Message
  • func (x *GetInfoResponse_Cert) Reset()
  • func (x *GetInfoResponse_Cert) String() string
• type UnimplementedDebugServer
  • func (UnimplementedDebugServer) GetInfo(context.Context, *GetInfoRequest) (*GetInfoResponse, error)
• type UnsafeDebugServer

Variables

var File_spire_api_server_debug_v1_debug_proto protoreflect.FileDescriptor

Functions

func RegisterDebugServer

func RegisterDebugServer(s grpc.ServiceRegistrar, srv DebugServer)

Types

type DebugClient

type DebugClient interface {
	// Get information about SPIRE server
	GetInfo(ctx context.Context, in *GetInfoRequest, opts ...grpc.CallOption) (*GetInfoResponse, error)
}

DebugClient is the client API for Debug service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewDebugClient

func NewDebugClient(cc grpc.ClientConnInterface) DebugClient

type DebugServer

type DebugServer interface {
	// Get information about SPIRE server
	GetInfo(context.Context, *GetInfoRequest) (*GetInfoResponse, error)
	// contains filtered or unexported methods
}

DebugServer is the server API for Debug service. All implementations must embed UnimplementedDebugServer for forward compatibility

type GetInfoRequest

type GetInfoRequest struct {
	// contains filtered or unexported fields
}

func (*GetInfoRequest) Descriptor

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

Deprecated: Use GetInfoRequest.ProtoReflect.Descriptor instead.

func (*GetInfoRequest) ProtoMessage

func (*GetInfoRequest) ProtoMessage()

func (*GetInfoRequest) ProtoReflect

func (x *GetInfoRequest) ProtoReflect() protoreflect.Message

func (*GetInfoRequest) Reset

func (x *GetInfoRequest) Reset()

func (*GetInfoRequest) String

func (x *GetInfoRequest) String() string

type GetInfoResponse

type GetInfoResponse struct {

	// Server SVID chain
	SvidChain []*GetInfoResponse_Cert `protobuf:"bytes,1,rep,name=svid_chain,json=svidChain,proto3" json:"svid_chain,omitempty"`
	// Server uptime in seconds
	Uptime int32 `protobuf:"varint,2,opt,name=uptime,proto3" json:"uptime,omitempty"`
	// Amount of registered agents
	AgentsCount int32 `protobuf:"varint,3,opt,name=agents_count,json=agentsCount,proto3" json:"agents_count,omitempty"`
	// Amount of federated bundles
	FederatedBundlesCount int32 `` /* 127-byte string literal not displayed */
	// Amount of registration entries on database
	EntriesCount int32 `protobuf:"varint,5,opt,name=entries_count,json=entriesCount,proto3" json:"entries_count,omitempty"`
	// contains filtered or unexported fields
}

func (*GetInfoResponse) Descriptor

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

Deprecated: Use GetInfoResponse.ProtoReflect.Descriptor instead.

func (*GetInfoResponse) GetAgentsCount

func (x *GetInfoResponse) GetAgentsCount() int32

func (*GetInfoResponse) GetEntriesCount

func (x *GetInfoResponse) GetEntriesCount() int32

func (*GetInfoResponse) GetFederatedBundlesCount

func (x *GetInfoResponse) GetFederatedBundlesCount() int32

func (*GetInfoResponse) GetSvidChain

func (x *GetInfoResponse) GetSvidChain() []*GetInfoResponse_Cert

func (*GetInfoResponse) GetUptime

func (x *GetInfoResponse) GetUptime() int32

func (*GetInfoResponse) ProtoMessage

func (*GetInfoResponse) ProtoMessage()

func (*GetInfoResponse) ProtoReflect

func (x *GetInfoResponse) ProtoReflect() protoreflect.Message

func (*GetInfoResponse) Reset

func (x *GetInfoResponse) Reset()

func (*GetInfoResponse) String

func (x *GetInfoResponse) String() string

type GetInfoResponse_Cert

type GetInfoResponse_Cert struct {

	// Certificate SPIFFE ID
	Id *types.SPIFFEID `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Expiration time
	ExpiresAt int64 `protobuf:"varint,2,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
	// Subject
	Subject string `protobuf:"bytes,3,opt,name=subject,proto3" json:"subject,omitempty"`
	// contains filtered or unexported fields
}

func (*GetInfoResponse_Cert) Descriptor

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

Deprecated: Use GetInfoResponse_Cert.ProtoReflect.Descriptor instead.

func (*GetInfoResponse_Cert) GetExpiresAt

func (x *GetInfoResponse_Cert) GetExpiresAt() int64

func (*GetInfoResponse_Cert) GetId

func (x *GetInfoResponse_Cert) GetId() *types.SPIFFEID

func (*GetInfoResponse_Cert) GetSubject

func (x *GetInfoResponse_Cert) GetSubject() string

func (*GetInfoResponse_Cert) ProtoMessage

func (*GetInfoResponse_Cert) ProtoMessage()

func (*GetInfoResponse_Cert) ProtoReflect

func (x *GetInfoResponse_Cert) ProtoReflect() protoreflect.Message

func (*GetInfoResponse_Cert) Reset

func (x *GetInfoResponse_Cert) Reset()

func (*GetInfoResponse_Cert) String

func (x *GetInfoResponse_Cert) String() string

type UnimplementedDebugServer

type UnimplementedDebugServer struct {
}

UnimplementedDebugServer must be embedded to have forward compatible implementations.

func (UnimplementedDebugServer) GetInfo

func (UnimplementedDebugServer) GetInfo(context.Context, *GetInfoRequest) (*GetInfoResponse, error)

type UnsafeDebugServer

type UnsafeDebugServer interface {
	// contains filtered or unexported methods
}

UnsafeDebugServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DebugServer will result in compilation errors.