Documentation ¶
Overview ¶
Package v1alpha1 is a generated protocol buffer package.
This package defines the common, core types used by the Mesh Configuration Protocol.
It is generated from these files:
config/mcp/v1alpha1/envelope.proto config/mcp/v1alpha1/mcp.proto config/mcp/v1alpha1/metadata.proto
It has these top-level messages:
Envelope Client MeshConfigRequest MeshConfigResponse Metadata
Index ¶
- Variables
- func RegisterAggregatedMeshConfigServiceServer(s *grpc.Server, srv AggregatedMeshConfigServiceServer)
- type AggregatedMeshConfigServiceClient
- type AggregatedMeshConfigServiceServer
- type AggregatedMeshConfigService_StreamAggregatedResourcesClient
- type AggregatedMeshConfigService_StreamAggregatedResourcesServer
- type Client
- func (*Client) Descriptor() ([]byte, []int)
- func (this *Client) Equal(that interface{}) bool
- func (m *Client) GetId() string
- func (m *Client) GetMetadata() *google_protobuf2.Struct
- func (m *Client) Marshal() (dAtA []byte, err error)
- func (m *Client) MarshalTo(dAtA []byte) (int, error)
- func (*Client) ProtoMessage()
- func (m *Client) Reset()
- func (m *Client) Size() (n int)
- func (m *Client) String() string
- func (m *Client) Unmarshal(dAtA []byte) error
- type Envelope
- func (*Envelope) Descriptor() ([]byte, []int)
- func (this *Envelope) Equal(that interface{}) bool
- func (m *Envelope) GetMetadata() *Metadata
- func (m *Envelope) GetResource() *google_protobuf.Any
- func (m *Envelope) Marshal() (dAtA []byte, err error)
- func (m *Envelope) MarshalTo(dAtA []byte) (int, error)
- func (*Envelope) ProtoMessage()
- func (m *Envelope) Reset()
- func (m *Envelope) Size() (n int)
- func (m *Envelope) String() string
- func (m *Envelope) Unmarshal(dAtA []byte) error
- type MeshConfigRequest
- func (*MeshConfigRequest) Descriptor() ([]byte, []int)
- func (this *MeshConfigRequest) Equal(that interface{}) bool
- func (m *MeshConfigRequest) GetClient() *Client
- func (m *MeshConfigRequest) GetErrorDetail() *google_rpc.Status
- func (m *MeshConfigRequest) GetResponseNonce() string
- func (m *MeshConfigRequest) GetTypeUrl() string
- func (m *MeshConfigRequest) GetVersionInfo() string
- func (m *MeshConfigRequest) Marshal() (dAtA []byte, err error)
- func (m *MeshConfigRequest) MarshalTo(dAtA []byte) (int, error)
- func (*MeshConfigRequest) ProtoMessage()
- func (m *MeshConfigRequest) Reset()
- func (m *MeshConfigRequest) Size() (n int)
- func (m *MeshConfigRequest) String() string
- func (m *MeshConfigRequest) Unmarshal(dAtA []byte) error
- type MeshConfigResponse
- func (*MeshConfigResponse) Descriptor() ([]byte, []int)
- func (this *MeshConfigResponse) Equal(that interface{}) bool
- func (m *MeshConfigResponse) GetEnvelopes() []Envelope
- func (m *MeshConfigResponse) GetNonce() string
- func (m *MeshConfigResponse) GetTypeUrl() string
- func (m *MeshConfigResponse) GetVersionInfo() string
- func (m *MeshConfigResponse) Marshal() (dAtA []byte, err error)
- func (m *MeshConfigResponse) MarshalTo(dAtA []byte) (int, error)
- func (*MeshConfigResponse) ProtoMessage()
- func (m *MeshConfigResponse) Reset()
- func (m *MeshConfigResponse) Size() (n int)
- func (m *MeshConfigResponse) String() string
- func (m *MeshConfigResponse) Unmarshal(dAtA []byte) error
- type Metadata
- func (*Metadata) Descriptor() ([]byte, []int)
- func (this *Metadata) Equal(that interface{}) bool
- func (m *Metadata) GetName() string
- func (m *Metadata) Marshal() (dAtA []byte, err error)
- func (m *Metadata) MarshalTo(dAtA []byte) (int, error)
- func (*Metadata) ProtoMessage()
- func (m *Metadata) Reset()
- func (m *Metadata) Size() (n int)
- func (m *Metadata) String() string
- func (m *Metadata) Unmarshal(dAtA []byte) error
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidLengthEnvelope = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowEnvelope = fmt.Errorf("proto: integer overflow") )
var ( ErrInvalidLengthMcp = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowMcp = fmt.Errorf("proto: integer overflow") )
var ( ErrInvalidLengthMetadata = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowMetadata = fmt.Errorf("proto: integer overflow") )
Functions ¶
func RegisterAggregatedMeshConfigServiceServer ¶
func RegisterAggregatedMeshConfigServiceServer(s *grpc.Server, srv AggregatedMeshConfigServiceServer)
Types ¶
type AggregatedMeshConfigServiceClient ¶
type AggregatedMeshConfigServiceClient interface { // StreamAggregatedResources provides the ability to carefully // sequence updates across multiple resource types. A single stream // is used with multiple independent MeshConfigRequest / // MeshConfigResponses sequences multiplexed via the type URL. StreamAggregatedResources(ctx context.Context, opts ...grpc.CallOption) (AggregatedMeshConfigService_StreamAggregatedResourcesClient, error) }
func NewAggregatedMeshConfigServiceClient ¶
func NewAggregatedMeshConfigServiceClient(cc *grpc.ClientConn) AggregatedMeshConfigServiceClient
type AggregatedMeshConfigServiceServer ¶
type AggregatedMeshConfigServiceServer interface { // StreamAggregatedResources provides the ability to carefully // sequence updates across multiple resource types. A single stream // is used with multiple independent MeshConfigRequest / // MeshConfigResponses sequences multiplexed via the type URL. StreamAggregatedResources(AggregatedMeshConfigService_StreamAggregatedResourcesServer) error }
type AggregatedMeshConfigService_StreamAggregatedResourcesClient ¶
type AggregatedMeshConfigService_StreamAggregatedResourcesClient interface { Send(*MeshConfigRequest) error Recv() (*MeshConfigResponse, error) grpc.ClientStream }
type AggregatedMeshConfigService_StreamAggregatedResourcesServer ¶
type AggregatedMeshConfigService_StreamAggregatedResourcesServer interface { Send(*MeshConfigResponse) error Recv() (*MeshConfigRequest, error) grpc.ServerStream }
type Client ¶
type Client struct { // An opaque identifier for the MCP client. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // Opaque metadata extending the client identifier. Metadata *google_protobuf2.Struct `protobuf:"bytes,2,opt,name=metadata" json:"metadata,omitempty"` }
Identifies a specific MCP client instance. The client identifier is presented to the management server, which may use this identifier to distinguish per client configuration for serving. This information is not authoriative. Authoritative identity should come from the underlying transport layer (e.g. rpc credentials).
func (*Client) Descriptor ¶
func (*Client) GetMetadata ¶
func (m *Client) GetMetadata() *google_protobuf2.Struct
func (*Client) ProtoMessage ¶
func (*Client) ProtoMessage()
type Envelope ¶
type Envelope struct { // Common metadata describing the resource. Metadata *Metadata `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"` // The resource itself. Resource *google_protobuf.Any `protobuf:"bytes,2,opt,name=resource" json:"resource,omitempty"` }
Envelope for a configuration resource as transferred via the Mesh Configuration Protocol. Each envelope is made up of common metadata, and a type-specific resource payload.
func (*Envelope) Descriptor ¶
func (*Envelope) GetMetadata ¶
func (*Envelope) GetResource ¶
func (m *Envelope) GetResource() *google_protobuf.Any
func (*Envelope) ProtoMessage ¶
func (*Envelope) ProtoMessage()
type MeshConfigRequest ¶
type MeshConfigRequest struct { // The version_info provided in the request messages will be the // version_info received with the most recent successfully processed // response or empty on the first request. It is expected that no // new request is sent after a response is received until the client // instance is ready to ACK/NACK the new configuration. ACK/NACK // takes place by returning the new API config version as applied or // the previous API config version respectively. Each type_url (see // below) has an independent version associated with it. VersionInfo string `protobuf:"bytes,1,opt,name=version_info,json=versionInfo,proto3" json:"version_info,omitempty"` // The client making the request. Client *Client `protobuf:"bytes,2,opt,name=client" json:"client,omitempty"` // Type of the resource that is being requested, e.g. // "type.googleapis.com/istio.io.networking.v1alpha3.VirtualService". TypeUrl string `protobuf:"bytes,3,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"` // The nonce corresponding to MeshConfigResponse being // ACK/NACKed. See above discussion on version_info and the // MeshConfigResponse nonce comment. This may be empty if no nonce is // available, e.g. at startup. ResponseNonce string `protobuf:"bytes,4,opt,name=response_nonce,json=responseNonce,proto3" json:"response_nonce,omitempty"` // This is populated when the previous MeshConfigResponse failed to // update configuration. The *message* field in *error_details* // provides the client internal exception related to the failure. It // is only intended for consumption during manual debugging, the // string provided is not guaranteed to be stable across client // versions. ErrorDetail *google_rpc.Status `protobuf:"bytes,5,opt,name=error_detail,json=errorDetail" json:"error_detail,omitempty"` }
A MeshConfigRequest requests a set of versioned resources of the same type for a given client.
func (*MeshConfigRequest) Descriptor ¶
func (*MeshConfigRequest) Descriptor() ([]byte, []int)
func (*MeshConfigRequest) Equal ¶
func (this *MeshConfigRequest) Equal(that interface{}) bool
func (*MeshConfigRequest) GetClient ¶
func (m *MeshConfigRequest) GetClient() *Client
func (*MeshConfigRequest) GetErrorDetail ¶
func (m *MeshConfigRequest) GetErrorDetail() *google_rpc.Status
func (*MeshConfigRequest) GetResponseNonce ¶
func (m *MeshConfigRequest) GetResponseNonce() string
func (*MeshConfigRequest) GetTypeUrl ¶
func (m *MeshConfigRequest) GetTypeUrl() string
func (*MeshConfigRequest) GetVersionInfo ¶
func (m *MeshConfigRequest) GetVersionInfo() string
func (*MeshConfigRequest) Marshal ¶
func (m *MeshConfigRequest) Marshal() (dAtA []byte, err error)
func (*MeshConfigRequest) MarshalTo ¶
func (m *MeshConfigRequest) MarshalTo(dAtA []byte) (int, error)
func (*MeshConfigRequest) ProtoMessage ¶
func (*MeshConfigRequest) ProtoMessage()
func (*MeshConfigRequest) Reset ¶
func (m *MeshConfigRequest) Reset()
func (*MeshConfigRequest) Size ¶
func (m *MeshConfigRequest) Size() (n int)
func (*MeshConfigRequest) String ¶
func (m *MeshConfigRequest) String() string
func (*MeshConfigRequest) Unmarshal ¶
func (m *MeshConfigRequest) Unmarshal(dAtA []byte) error
type MeshConfigResponse ¶
type MeshConfigResponse struct { // The version of the response data. VersionInfo string `protobuf:"bytes,1,opt,name=version_info,json=versionInfo,proto3" json:"version_info,omitempty"` // The response resources wrapped in the common MCP *Envelope* // message. Envelopes []Envelope `protobuf:"bytes,2,rep,name=envelopes" json:"envelopes"` // Type URL for resources wrapped in the provided envelope(s). This // must be consistent with the type_url in the wrapper messages if // envelopes is non-empty. TypeUrl string `protobuf:"bytes,3,opt,name=type_url,json=typeUrl,proto3" json:"type_url,omitempty"` // The nonce provides a way to explicitly ack a specific // MeshConfigResponse in a following MeshConfigRequest. Additional // messages may have been sent by client to the management server for // the previous version on the stream prior to this // MeshConfigResponse, that were unprocessed at response send // time. The nonce allows the management server to ignore any // further MeshConfigRequests for the previous version until a // MeshConfigRequest bearing the nonce. Nonce string `protobuf:"bytes,4,opt,name=nonce,proto3" json:"nonce,omitempty"` }
A MeshConfigResponse delivers a set of versioned resources of the same type in response to a MeshConfigRequest.
func (*MeshConfigResponse) Descriptor ¶
func (*MeshConfigResponse) Descriptor() ([]byte, []int)
func (*MeshConfigResponse) Equal ¶
func (this *MeshConfigResponse) Equal(that interface{}) bool
func (*MeshConfigResponse) GetEnvelopes ¶
func (m *MeshConfigResponse) GetEnvelopes() []Envelope
func (*MeshConfigResponse) GetNonce ¶
func (m *MeshConfigResponse) GetNonce() string
func (*MeshConfigResponse) GetTypeUrl ¶
func (m *MeshConfigResponse) GetTypeUrl() string
func (*MeshConfigResponse) GetVersionInfo ¶
func (m *MeshConfigResponse) GetVersionInfo() string
func (*MeshConfigResponse) Marshal ¶
func (m *MeshConfigResponse) Marshal() (dAtA []byte, err error)
func (*MeshConfigResponse) MarshalTo ¶
func (m *MeshConfigResponse) MarshalTo(dAtA []byte) (int, error)
func (*MeshConfigResponse) ProtoMessage ¶
func (*MeshConfigResponse) ProtoMessage()
func (*MeshConfigResponse) Reset ¶
func (m *MeshConfigResponse) Reset()
func (*MeshConfigResponse) Size ¶
func (m *MeshConfigResponse) Size() (n int)
func (*MeshConfigResponse) String ¶
func (m *MeshConfigResponse) String() string
func (*MeshConfigResponse) Unmarshal ¶
func (m *MeshConfigResponse) Unmarshal(dAtA []byte) error
type Metadata ¶
type Metadata struct { // The name of the resource. It is unique within the context of a resource type and the origin server of // the resource. The resource type is identified by the TypeUrl of the resource field of the Envelope // message. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` }
Metadata information that all resources within the Mesh Configuration Protocol must have.
func (*Metadata) Descriptor ¶
func (*Metadata) ProtoMessage ¶
func (*Metadata) ProtoMessage()