statusv2

package
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 8, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ClientStatusDiscoveryService_StreamClientStatus_FullMethodName = "/envoy.service.status.v2.ClientStatusDiscoveryService/StreamClientStatus"
	ClientStatusDiscoveryService_FetchClientStatus_FullMethodName  = "/envoy.service.status.v2.ClientStatusDiscoveryService/FetchClientStatus"
)

Variables

View Source
var (
	ConfigStatus_name = map[int32]string{
		0: "UNKNOWN",
		1: "SYNCED",
		2: "NOT_SENT",
		3: "STALE",
		4: "ERROR",
	}
	ConfigStatus_value = map[string]int32{
		"UNKNOWN":  0,
		"SYNCED":   1,
		"NOT_SENT": 2,
		"STALE":    3,
		"ERROR":    4,
	}
)

Enum value maps for ConfigStatus.

View Source
var ClientStatusDiscoveryService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "envoy.service.status.v2.ClientStatusDiscoveryService",
	HandlerType: (*ClientStatusDiscoveryServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "FetchClientStatus",
			Handler:    _ClientStatusDiscoveryService_FetchClientStatus_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamClientStatus",
			Handler:       _ClientStatusDiscoveryService_StreamClientStatus_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "envoy/service/status/v2/csds.proto",
}

ClientStatusDiscoveryService_ServiceDesc is the grpc.ServiceDesc for ClientStatusDiscoveryService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_envoy_service_status_v2_csds_proto protoreflect.FileDescriptor

Functions

func RegisterClientStatusDiscoveryServiceServer

func RegisterClientStatusDiscoveryServiceServer(s grpc.ServiceRegistrar, srv ClientStatusDiscoveryServiceServer)

Types

type ClientConfig

type ClientConfig struct {

	// Node for a particular client.
	Node      *core.Node      `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
	XdsConfig []*PerXdsConfig `protobuf:"bytes,2,rep,name=xds_config,json=xdsConfig,proto3" json:"xds_config,omitempty"`
	// contains filtered or unexported fields
}

All xds configs for a particular client.

func (*ClientConfig) Descriptor deprecated

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

Deprecated: Use ClientConfig.ProtoReflect.Descriptor instead.

func (*ClientConfig) GetNode

func (x *ClientConfig) GetNode() *core.Node

func (*ClientConfig) GetXdsConfig

func (x *ClientConfig) GetXdsConfig() []*PerXdsConfig

func (*ClientConfig) ProtoMessage

func (*ClientConfig) ProtoMessage()

func (*ClientConfig) ProtoReflect

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

func (*ClientConfig) Reset

func (x *ClientConfig) Reset()

func (*ClientConfig) String

func (x *ClientConfig) String() string

type ClientStatusDiscoveryServiceClient

type ClientStatusDiscoveryServiceClient interface {
	StreamClientStatus(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[ClientStatusRequest, ClientStatusResponse], error)
	FetchClientStatus(ctx context.Context, in *ClientStatusRequest, opts ...grpc.CallOption) (*ClientStatusResponse, error)
}

ClientStatusDiscoveryServiceClient is the client API for ClientStatusDiscoveryService 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.

CSDS is Client Status Discovery Service. It can be used to get the status of an xDS-compliant client from the management server's point of view. In the future, it can potentially be used as an interface to get the current state directly from the client.

type ClientStatusDiscoveryServiceServer

type ClientStatusDiscoveryServiceServer interface {
	StreamClientStatus(grpc.BidiStreamingServer[ClientStatusRequest, ClientStatusResponse]) error
	FetchClientStatus(context.Context, *ClientStatusRequest) (*ClientStatusResponse, error)
	// contains filtered or unexported methods
}

ClientStatusDiscoveryServiceServer is the server API for ClientStatusDiscoveryService service. All implementations must embed UnimplementedClientStatusDiscoveryServiceServer for forward compatibility.

CSDS is Client Status Discovery Service. It can be used to get the status of an xDS-compliant client from the management server's point of view. In the future, it can potentially be used as an interface to get the current state directly from the client.

type ClientStatusDiscoveryService_StreamClientStatusClient

type ClientStatusDiscoveryService_StreamClientStatusClient = grpc.BidiStreamingClient[ClientStatusRequest, ClientStatusResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type ClientStatusDiscoveryService_StreamClientStatusServer

type ClientStatusDiscoveryService_StreamClientStatusServer = grpc.BidiStreamingServer[ClientStatusRequest, ClientStatusResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type ClientStatusRequest

type ClientStatusRequest struct {

	// Management server can use these match criteria to identify clients.
	// The match follows OR semantics.
	NodeMatchers []*matcher.NodeMatcher `protobuf:"bytes,1,rep,name=node_matchers,json=nodeMatchers,proto3" json:"node_matchers,omitempty"`
	// contains filtered or unexported fields
}

Request for client status of clients identified by a list of NodeMatchers.

func (*ClientStatusRequest) Descriptor deprecated

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

Deprecated: Use ClientStatusRequest.ProtoReflect.Descriptor instead.

func (*ClientStatusRequest) GetNodeMatchers

func (x *ClientStatusRequest) GetNodeMatchers() []*matcher.NodeMatcher

func (*ClientStatusRequest) ProtoMessage

func (*ClientStatusRequest) ProtoMessage()

func (*ClientStatusRequest) ProtoReflect

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

func (*ClientStatusRequest) Reset

func (x *ClientStatusRequest) Reset()

func (*ClientStatusRequest) String

func (x *ClientStatusRequest) String() string

type ClientStatusResponse

type ClientStatusResponse struct {

	// Client configs for the clients specified in the ClientStatusRequest.
	Config []*ClientConfig `protobuf:"bytes,1,rep,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*ClientStatusResponse) Descriptor deprecated

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

Deprecated: Use ClientStatusResponse.ProtoReflect.Descriptor instead.

func (*ClientStatusResponse) GetConfig

func (x *ClientStatusResponse) GetConfig() []*ClientConfig

func (*ClientStatusResponse) ProtoMessage

func (*ClientStatusResponse) ProtoMessage()

func (*ClientStatusResponse) ProtoReflect

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

func (*ClientStatusResponse) Reset

func (x *ClientStatusResponse) Reset()

func (*ClientStatusResponse) String

func (x *ClientStatusResponse) String() string

type ConfigStatus

type ConfigStatus int32

Status of a config.

const (
	// Status info is not available/unknown.
	ConfigStatus_UNKNOWN ConfigStatus = 0
	// Management server has sent the config to client and received ACK.
	ConfigStatus_SYNCED ConfigStatus = 1
	// Config is not sent.
	ConfigStatus_NOT_SENT ConfigStatus = 2
	// Management server has sent the config to client but hasn’t received
	// ACK/NACK.
	ConfigStatus_STALE ConfigStatus = 3
	// Management server has sent the config to client but received NACK.
	ConfigStatus_ERROR ConfigStatus = 4
)

func (ConfigStatus) Descriptor

func (ConfigStatus) Enum

func (x ConfigStatus) Enum() *ConfigStatus

func (ConfigStatus) EnumDescriptor deprecated

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

Deprecated: Use ConfigStatus.Descriptor instead.

func (ConfigStatus) Number

func (ConfigStatus) String

func (x ConfigStatus) String() string

func (ConfigStatus) Type

type PerXdsConfig

type PerXdsConfig struct {
	Status ConfigStatus `protobuf:"varint,1,opt,name=status,proto3,enum=envoy.service.status.v2.ConfigStatus" json:"status,omitempty"`
	// Types that are assignable to PerXdsConfig:
	//
	//	*PerXdsConfig_ListenerConfig
	//	*PerXdsConfig_ClusterConfig
	//	*PerXdsConfig_RouteConfig
	//	*PerXdsConfig_ScopedRouteConfig
	PerXdsConfig isPerXdsConfig_PerXdsConfig `protobuf_oneof:"per_xds_config"`
	// contains filtered or unexported fields
}

Detailed config (per xDS) with status. [#next-free-field: 6]

func (*PerXdsConfig) Descriptor deprecated

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

Deprecated: Use PerXdsConfig.ProtoReflect.Descriptor instead.

func (*PerXdsConfig) GetClusterConfig

func (x *PerXdsConfig) GetClusterConfig() *v2alpha.ClustersConfigDump

func (*PerXdsConfig) GetListenerConfig

func (x *PerXdsConfig) GetListenerConfig() *v2alpha.ListenersConfigDump

func (*PerXdsConfig) GetPerXdsConfig

func (m *PerXdsConfig) GetPerXdsConfig() isPerXdsConfig_PerXdsConfig

func (*PerXdsConfig) GetRouteConfig

func (x *PerXdsConfig) GetRouteConfig() *v2alpha.RoutesConfigDump

func (*PerXdsConfig) GetScopedRouteConfig

func (x *PerXdsConfig) GetScopedRouteConfig() *v2alpha.ScopedRoutesConfigDump

func (*PerXdsConfig) GetStatus

func (x *PerXdsConfig) GetStatus() ConfigStatus

func (*PerXdsConfig) ProtoMessage

func (*PerXdsConfig) ProtoMessage()

func (*PerXdsConfig) ProtoReflect

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

func (*PerXdsConfig) Reset

func (x *PerXdsConfig) Reset()

func (*PerXdsConfig) String

func (x *PerXdsConfig) String() string

type PerXdsConfig_ClusterConfig

type PerXdsConfig_ClusterConfig struct {
	ClusterConfig *v2alpha.ClustersConfigDump `protobuf:"bytes,3,opt,name=cluster_config,json=clusterConfig,proto3,oneof"`
}

type PerXdsConfig_ListenerConfig

type PerXdsConfig_ListenerConfig struct {
	ListenerConfig *v2alpha.ListenersConfigDump `protobuf:"bytes,2,opt,name=listener_config,json=listenerConfig,proto3,oneof"`
}

type PerXdsConfig_RouteConfig

type PerXdsConfig_RouteConfig struct {
	RouteConfig *v2alpha.RoutesConfigDump `protobuf:"bytes,4,opt,name=route_config,json=routeConfig,proto3,oneof"`
}

type PerXdsConfig_ScopedRouteConfig

type PerXdsConfig_ScopedRouteConfig struct {
	ScopedRouteConfig *v2alpha.ScopedRoutesConfigDump `protobuf:"bytes,5,opt,name=scoped_route_config,json=scopedRouteConfig,proto3,oneof"`
}

type UnimplementedClientStatusDiscoveryServiceServer

type UnimplementedClientStatusDiscoveryServiceServer struct{}

UnimplementedClientStatusDiscoveryServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedClientStatusDiscoveryServiceServer) FetchClientStatus

func (UnimplementedClientStatusDiscoveryServiceServer) StreamClientStatus

type UnsafeClientStatusDiscoveryServiceServer

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL