Documentation ¶
Index ¶
- Variables
- type Admin
- type AdminValidationError
- type Bootstrap
- func (*Bootstrap) Descriptor() ([]byte, []int)deprecated
- func (x *Bootstrap) GetAdmin() *Admin
- func (x *Bootstrap) GetCache() *Cache
- func (x *Bootstrap) GetLogging() *Logging
- func (x *Bootstrap) GetMetricsSink() *MetricsSink
- func (x *Bootstrap) GetOriginServer() *Upstream
- func (x *Bootstrap) GetServer() *Server
- func (*Bootstrap) ProtoMessage()
- func (x *Bootstrap) ProtoReflect() protoreflect.Message
- func (x *Bootstrap) Reset()
- func (x *Bootstrap) String() string
- func (m *Bootstrap) Validate() error
- type BootstrapValidationError
- type Cache
- func (*Cache) Descriptor() ([]byte, []int)deprecated
- func (x *Cache) GetMaxEntries() int32
- func (x *Cache) GetTtl() *duration.Duration
- func (*Cache) ProtoMessage()
- func (x *Cache) ProtoReflect() protoreflect.Message
- func (x *Cache) Reset()
- func (x *Cache) String() string
- func (m *Cache) Validate() error
- type CacheValidationError
- type Logging
- func (*Logging) Descriptor() ([]byte, []int)deprecated
- func (x *Logging) GetLevel() Logging_Level
- func (x *Logging) GetPath() string
- func (*Logging) ProtoMessage()
- func (x *Logging) ProtoReflect() protoreflect.Message
- func (x *Logging) Reset()
- func (x *Logging) String() string
- func (m *Logging) Validate() error
- type LoggingValidationError
- type Logging_Level
- func (Logging_Level) Descriptor() protoreflect.EnumDescriptor
- func (x Logging_Level) Enum() *Logging_Level
- func (Logging_Level) EnumDescriptor() ([]byte, []int)deprecated
- func (x Logging_Level) Number() protoreflect.EnumNumber
- func (x Logging_Level) String() string
- func (Logging_Level) Type() protoreflect.EnumType
- type MetricsSink
- func (*MetricsSink) Descriptor() ([]byte, []int)deprecated
- func (x *MetricsSink) GetStatsd() *Statsd
- func (m *MetricsSink) GetType() isMetricsSink_Type
- func (*MetricsSink) ProtoMessage()
- func (x *MetricsSink) ProtoReflect() protoreflect.Message
- func (x *MetricsSink) Reset()
- func (x *MetricsSink) String() string
- func (m *MetricsSink) Validate() error
- type MetricsSinkValidationError
- func (e MetricsSinkValidationError) Cause() error
- func (e MetricsSinkValidationError) Error() string
- func (e MetricsSinkValidationError) ErrorName() string
- func (e MetricsSinkValidationError) Field() string
- func (e MetricsSinkValidationError) Key() bool
- func (e MetricsSinkValidationError) Reason() string
- type MetricsSink_Statsd
- type Server
- type ServerValidationError
- type SocketAddress
- func (*SocketAddress) Descriptor() ([]byte, []int)deprecated
- func (x *SocketAddress) GetAddress() string
- func (x *SocketAddress) GetPortValue() uint32
- func (*SocketAddress) ProtoMessage()
- func (x *SocketAddress) ProtoReflect() protoreflect.Message
- func (x *SocketAddress) Reset()
- func (x *SocketAddress) String() string
- func (m *SocketAddress) Validate() error
- type SocketAddressValidationError
- func (e SocketAddressValidationError) Cause() error
- func (e SocketAddressValidationError) Error() string
- func (e SocketAddressValidationError) ErrorName() string
- func (e SocketAddressValidationError) Field() string
- func (e SocketAddressValidationError) Key() bool
- func (e SocketAddressValidationError) Reason() string
- type Statsd
- func (*Statsd) Descriptor() ([]byte, []int)deprecated
- func (x *Statsd) GetAddress() *SocketAddress
- func (x *Statsd) GetFlushInterval() *duration.Duration
- func (x *Statsd) GetRootPrefix() string
- func (*Statsd) ProtoMessage()
- func (x *Statsd) ProtoReflect() protoreflect.Message
- func (x *Statsd) Reset()
- func (x *Statsd) String() string
- func (m *Statsd) Validate() error
- type StatsdValidationError
- type Upstream
- func (*Upstream) Descriptor() ([]byte, []int)deprecated
- func (x *Upstream) GetAddress() *SocketAddress
- func (x *Upstream) GetKeepAliveTime() string
- func (x *Upstream) GetRequestNodeMetadata() string
- func (x *Upstream) GetStreamTimeout() string
- func (x *Upstream) GetStreamTimeoutJitter() string
- func (*Upstream) ProtoMessage()
- func (x *Upstream) ProtoReflect() protoreflect.Message
- func (x *Upstream) Reset()
- func (x *Upstream) String() string
- func (m *Upstream) Validate() error
- type UpstreamValidationError
Constants ¶
This section is empty.
Variables ¶
var ( Logging_Level_name = map[int32]string{ 0: "INFO", 1: "DEBUG", 2: "WARN", 3: "ERROR", } Logging_Level_value = map[string]int32{ "INFO": 0, "DEBUG": 1, "WARN": 2, "ERROR": 3, } )
Enum value maps for Logging_Level.
var File_bootstrap_v1_bootstrap_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Admin ¶
type Admin struct { // The TCP address that the admin server will listen on. Address *SocketAddress `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` // contains filtered or unexported fields }
[#next-free-field: 2]
func (*Admin) Descriptor
deprecated
func (*Admin) GetAddress ¶
func (x *Admin) GetAddress() *SocketAddress
func (*Admin) ProtoMessage ¶
func (*Admin) ProtoMessage()
func (*Admin) ProtoReflect ¶
func (x *Admin) ProtoReflect() protoreflect.Message
type AdminValidationError ¶
type AdminValidationError struct {
// contains filtered or unexported fields
}
AdminValidationError is the validation error returned by Admin.Validate if the designated constraints aren't met.
func (AdminValidationError) Cause ¶
func (e AdminValidationError) Cause() error
Cause function returns cause value.
func (AdminValidationError) Error ¶
func (e AdminValidationError) Error() string
Error satisfies the builtin error interface
func (AdminValidationError) ErrorName ¶
func (e AdminValidationError) ErrorName() string
ErrorName returns error name.
func (AdminValidationError) Field ¶
func (e AdminValidationError) Field() string
Field function returns field value.
func (AdminValidationError) Key ¶
func (e AdminValidationError) Key() bool
Key function returns key value.
func (AdminValidationError) Reason ¶
func (e AdminValidationError) Reason() string
Reason function returns reason value.
type Bootstrap ¶
type Bootstrap struct { // xds-relay server configuration. Server *Server `protobuf:"bytes,1,opt,name=server,proto3" json:"server,omitempty"` // Configuration information about the origin server. OriginServer *Upstream `protobuf:"bytes,2,opt,name=origin_server,json=originServer,proto3" json:"origin_server,omitempty"` // Logging settings. Logging *Logging `protobuf:"bytes,3,opt,name=logging,proto3" json:"logging,omitempty"` // Request/response cache settings. Cache *Cache `protobuf:"bytes,4,opt,name=cache,proto3" json:"cache,omitempty"` // Metrics sink settings MetricsSink *MetricsSink `protobuf:"bytes,5,opt,name=metrics_sink,json=metricsSink,proto3" json:"metrics_sink,omitempty"` // Admin server configuration. Admin *Admin `protobuf:"bytes,6,opt,name=admin,proto3" json:"admin,omitempty"` // contains filtered or unexported fields }
[#next-free-field: 7]
func (*Bootstrap) Descriptor
deprecated
func (*Bootstrap) GetLogging ¶
func (*Bootstrap) GetMetricsSink ¶
func (x *Bootstrap) GetMetricsSink() *MetricsSink
func (*Bootstrap) GetOriginServer ¶
func (*Bootstrap) ProtoMessage ¶
func (*Bootstrap) ProtoMessage()
func (*Bootstrap) ProtoReflect ¶
func (x *Bootstrap) ProtoReflect() protoreflect.Message
type BootstrapValidationError ¶
type BootstrapValidationError struct {
// contains filtered or unexported fields
}
BootstrapValidationError is the validation error returned by Bootstrap.Validate if the designated constraints aren't met.
func (BootstrapValidationError) Cause ¶
func (e BootstrapValidationError) Cause() error
Cause function returns cause value.
func (BootstrapValidationError) Error ¶
func (e BootstrapValidationError) Error() string
Error satisfies the builtin error interface
func (BootstrapValidationError) ErrorName ¶
func (e BootstrapValidationError) ErrorName() string
ErrorName returns error name.
func (BootstrapValidationError) Field ¶
func (e BootstrapValidationError) Field() string
Field function returns field value.
func (BootstrapValidationError) Key ¶
func (e BootstrapValidationError) Key() bool
Key function returns key value.
func (BootstrapValidationError) Reason ¶
func (e BootstrapValidationError) Reason() string
Reason function returns reason value.
type Cache ¶
type Cache struct { // Duration before which a key is evicted from the request/response cache. Zero means no expiration time. Ttl *duration.Duration `protobuf:"bytes,1,opt,name=ttl,proto3" json:"ttl,omitempty"` // The maximum number of keys allowed in the request/response cache. If unset, no maximum number will be enforced. MaxEntries int32 `protobuf:"varint,2,opt,name=max_entries,json=maxEntries,proto3" json:"max_entries,omitempty"` // contains filtered or unexported fields }
[#next-free-field: 3]
func (*Cache) Descriptor
deprecated
func (*Cache) GetMaxEntries ¶
func (*Cache) ProtoMessage ¶
func (*Cache) ProtoMessage()
func (*Cache) ProtoReflect ¶
func (x *Cache) ProtoReflect() protoreflect.Message
type CacheValidationError ¶
type CacheValidationError struct {
// contains filtered or unexported fields
}
CacheValidationError is the validation error returned by Cache.Validate if the designated constraints aren't met.
func (CacheValidationError) Cause ¶
func (e CacheValidationError) Cause() error
Cause function returns cause value.
func (CacheValidationError) Error ¶
func (e CacheValidationError) Error() string
Error satisfies the builtin error interface
func (CacheValidationError) ErrorName ¶
func (e CacheValidationError) ErrorName() string
ErrorName returns error name.
func (CacheValidationError) Field ¶
func (e CacheValidationError) Field() string
Field function returns field value.
func (CacheValidationError) Key ¶
func (e CacheValidationError) Key() bool
Key function returns key value.
func (CacheValidationError) Reason ¶
func (e CacheValidationError) Reason() string
Reason function returns reason value.
type Logging ¶
type Logging struct { // Filepath where logs are emitted. If no filepath is specified, logs will be written to stderr. Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"` Level Logging_Level `protobuf:"varint,2,opt,name=level,proto3,enum=bootstrap.Logging_Level" json:"level,omitempty"` // contains filtered or unexported fields }
[#next-free-field: 3]
func (*Logging) Descriptor
deprecated
func (*Logging) GetLevel ¶
func (x *Logging) GetLevel() Logging_Level
func (*Logging) ProtoMessage ¶
func (*Logging) ProtoMessage()
func (*Logging) ProtoReflect ¶
func (x *Logging) ProtoReflect() protoreflect.Message
type LoggingValidationError ¶
type LoggingValidationError struct {
// contains filtered or unexported fields
}
LoggingValidationError is the validation error returned by Logging.Validate if the designated constraints aren't met.
func (LoggingValidationError) Cause ¶
func (e LoggingValidationError) Cause() error
Cause function returns cause value.
func (LoggingValidationError) Error ¶
func (e LoggingValidationError) Error() string
Error satisfies the builtin error interface
func (LoggingValidationError) ErrorName ¶
func (e LoggingValidationError) ErrorName() string
ErrorName returns error name.
func (LoggingValidationError) Field ¶
func (e LoggingValidationError) Field() string
Field function returns field value.
func (LoggingValidationError) Key ¶
func (e LoggingValidationError) Key() bool
Key function returns key value.
func (LoggingValidationError) Reason ¶
func (e LoggingValidationError) Reason() string
Reason function returns reason value.
type Logging_Level ¶
type Logging_Level int32
The logging level. If no logging level is set, the default is INFO.
const ( Logging_INFO Logging_Level = 0 Logging_DEBUG Logging_Level = 1 Logging_WARN Logging_Level = 2 Logging_ERROR Logging_Level = 3 )
func (Logging_Level) Descriptor ¶
func (Logging_Level) Descriptor() protoreflect.EnumDescriptor
func (Logging_Level) Enum ¶
func (x Logging_Level) Enum() *Logging_Level
func (Logging_Level) EnumDescriptor
deprecated
func (Logging_Level) EnumDescriptor() ([]byte, []int)
Deprecated: Use Logging_Level.Descriptor instead.
func (Logging_Level) Number ¶
func (x Logging_Level) Number() protoreflect.EnumNumber
func (Logging_Level) String ¶
func (x Logging_Level) String() string
func (Logging_Level) Type ¶
func (Logging_Level) Type() protoreflect.EnumType
type MetricsSink ¶
type MetricsSink struct { // Types that are assignable to Type: // *MetricsSink_Statsd Type isMetricsSink_Type `protobuf_oneof:"type"` // contains filtered or unexported fields }
The type of metrics sink, i.e. statsd, prometheus, etc.
func (*MetricsSink) Descriptor
deprecated
func (*MetricsSink) Descriptor() ([]byte, []int)
Deprecated: Use MetricsSink.ProtoReflect.Descriptor instead.
func (*MetricsSink) GetStatsd ¶
func (x *MetricsSink) GetStatsd() *Statsd
func (*MetricsSink) GetType ¶
func (m *MetricsSink) GetType() isMetricsSink_Type
func (*MetricsSink) ProtoMessage ¶
func (*MetricsSink) ProtoMessage()
func (*MetricsSink) ProtoReflect ¶
func (x *MetricsSink) ProtoReflect() protoreflect.Message
func (*MetricsSink) Reset ¶
func (x *MetricsSink) Reset()
func (*MetricsSink) String ¶
func (x *MetricsSink) String() string
func (*MetricsSink) Validate ¶
func (m *MetricsSink) Validate() error
Validate checks the field values on MetricsSink with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type MetricsSinkValidationError ¶
type MetricsSinkValidationError struct {
// contains filtered or unexported fields
}
MetricsSinkValidationError is the validation error returned by MetricsSink.Validate if the designated constraints aren't met.
func (MetricsSinkValidationError) Cause ¶
func (e MetricsSinkValidationError) Cause() error
Cause function returns cause value.
func (MetricsSinkValidationError) Error ¶
func (e MetricsSinkValidationError) Error() string
Error satisfies the builtin error interface
func (MetricsSinkValidationError) ErrorName ¶
func (e MetricsSinkValidationError) ErrorName() string
ErrorName returns error name.
func (MetricsSinkValidationError) Field ¶
func (e MetricsSinkValidationError) Field() string
Field function returns field value.
func (MetricsSinkValidationError) Key ¶
func (e MetricsSinkValidationError) Key() bool
Key function returns key value.
func (MetricsSinkValidationError) Reason ¶
func (e MetricsSinkValidationError) Reason() string
Reason function returns reason value.
type MetricsSink_Statsd ¶
type MetricsSink_Statsd struct {
Statsd *Statsd `protobuf:"bytes,1,opt,name=statsd,proto3,oneof"`
}
type Server ¶
type Server struct { // The TCP address that the xds-relay server will listen on. Address *SocketAddress `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` // contains filtered or unexported fields }
[#next-free-field: 2]
func (*Server) Descriptor
deprecated
func (*Server) GetAddress ¶
func (x *Server) GetAddress() *SocketAddress
func (*Server) ProtoMessage ¶
func (*Server) ProtoMessage()
func (*Server) ProtoReflect ¶
func (x *Server) ProtoReflect() protoreflect.Message
type ServerValidationError ¶
type ServerValidationError struct {
// contains filtered or unexported fields
}
ServerValidationError is the validation error returned by Server.Validate if the designated constraints aren't met.
func (ServerValidationError) Cause ¶
func (e ServerValidationError) Cause() error
Cause function returns cause value.
func (ServerValidationError) Error ¶
func (e ServerValidationError) Error() string
Error satisfies the builtin error interface
func (ServerValidationError) ErrorName ¶
func (e ServerValidationError) ErrorName() string
ErrorName returns error name.
func (ServerValidationError) Field ¶
func (e ServerValidationError) Field() string
Field function returns field value.
func (ServerValidationError) Key ¶
func (e ServerValidationError) Key() bool
Key function returns key value.
func (ServerValidationError) Reason ¶
func (e ServerValidationError) Reason() string
Reason function returns reason value.
type SocketAddress ¶
type SocketAddress struct { // The address for this socket. Listeners will bind to the address. Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` PortValue uint32 `protobuf:"varint,2,opt,name=port_value,json=portValue,proto3" json:"port_value,omitempty"` // contains filtered or unexported fields }
[#next-free-field: 3]
func (*SocketAddress) Descriptor
deprecated
func (*SocketAddress) Descriptor() ([]byte, []int)
Deprecated: Use SocketAddress.ProtoReflect.Descriptor instead.
func (*SocketAddress) GetAddress ¶
func (x *SocketAddress) GetAddress() string
func (*SocketAddress) GetPortValue ¶
func (x *SocketAddress) GetPortValue() uint32
func (*SocketAddress) ProtoMessage ¶
func (*SocketAddress) ProtoMessage()
func (*SocketAddress) ProtoReflect ¶
func (x *SocketAddress) ProtoReflect() protoreflect.Message
func (*SocketAddress) Reset ¶
func (x *SocketAddress) Reset()
func (*SocketAddress) String ¶
func (x *SocketAddress) String() string
func (*SocketAddress) Validate ¶
func (m *SocketAddress) Validate() error
Validate checks the field values on SocketAddress with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type SocketAddressValidationError ¶
type SocketAddressValidationError struct {
// contains filtered or unexported fields
}
SocketAddressValidationError is the validation error returned by SocketAddress.Validate if the designated constraints aren't met.
func (SocketAddressValidationError) Cause ¶
func (e SocketAddressValidationError) Cause() error
Cause function returns cause value.
func (SocketAddressValidationError) Error ¶
func (e SocketAddressValidationError) Error() string
Error satisfies the builtin error interface
func (SocketAddressValidationError) ErrorName ¶
func (e SocketAddressValidationError) ErrorName() string
ErrorName returns error name.
func (SocketAddressValidationError) Field ¶
func (e SocketAddressValidationError) Field() string
Field function returns field value.
func (SocketAddressValidationError) Key ¶
func (e SocketAddressValidationError) Key() bool
Key function returns key value.
func (SocketAddressValidationError) Reason ¶
func (e SocketAddressValidationError) Reason() string
Reason function returns reason value.
type Statsd ¶
type Statsd struct { Address *SocketAddress `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` RootPrefix string `protobuf:"bytes,2,opt,name=root_prefix,json=rootPrefix,proto3" json:"root_prefix,omitempty"` FlushInterval *duration.Duration `protobuf:"bytes,3,opt,name=flush_interval,json=flushInterval,proto3" json:"flush_interval,omitempty"` // contains filtered or unexported fields }
[#next-free-field: 4]
func (*Statsd) Descriptor
deprecated
func (*Statsd) GetAddress ¶
func (x *Statsd) GetAddress() *SocketAddress
func (*Statsd) GetFlushInterval ¶
func (*Statsd) GetRootPrefix ¶
func (*Statsd) ProtoMessage ¶
func (*Statsd) ProtoMessage()
func (*Statsd) ProtoReflect ¶
func (x *Statsd) ProtoReflect() protoreflect.Message
type StatsdValidationError ¶
type StatsdValidationError struct {
// contains filtered or unexported fields
}
StatsdValidationError is the validation error returned by Statsd.Validate if the designated constraints aren't met.
func (StatsdValidationError) Cause ¶
func (e StatsdValidationError) Cause() error
Cause function returns cause value.
func (StatsdValidationError) Error ¶
func (e StatsdValidationError) Error() string
Error satisfies the builtin error interface
func (StatsdValidationError) ErrorName ¶
func (e StatsdValidationError) ErrorName() string
ErrorName returns error name.
func (StatsdValidationError) Field ¶
func (e StatsdValidationError) Field() string
Field function returns field value.
func (StatsdValidationError) Key ¶
func (e StatsdValidationError) Key() bool
Key function returns key value.
func (StatsdValidationError) Reason ¶
func (e StatsdValidationError) Reason() string
Reason function returns reason value.
type Upstream ¶
type Upstream struct { // The address for the upstream cluster. Address *SocketAddress `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` // grpc connection keep alive time backed by https://github.com/grpc/grpc-go/blob/v1.32.0/keepalive/keepalive.go#L34-L37 // If unset defaults to 5 minutes. // Usage example: 2m to represent 2 minutes // Reason for not using google.protobuf.Duration // keepalive will be in minutes or possibly hours. // From https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Duration // Duration only lets us represent time in 's' KeepAliveTime string `protobuf:"bytes,2,opt,name=keep_alive_time,json=keepAliveTime,proto3" json:"keep_alive_time,omitempty"` // Timeout for upstream connection stream. // If unset defaults to no timeout. // Usage example: 2m to represent 2 minutes. StreamTimeout string `protobuf:"bytes,3,opt,name=stream_timeout,json=streamTimeout,proto3" json:"stream_timeout,omitempty"` // Jitter for upstream connection stream timeouts. Used with timeout to reset streams without overloading // the upstream server. Jitter is the upper tolerance for random variation in the timeout. e.g. timeout=15s, // jitter=5s -> stream timeout is a random value between 15s and 20s. // If unset defaults to no jitter. StreamTimeoutJitter string `protobuf:"bytes,4,opt,name=stream_timeout_jitter,json=streamTimeoutJitter,proto3" json:"stream_timeout_jitter,omitempty"` // Extra string field to provide xds-relay related node metadata to management server if needed. This is // added to the NodeMetadata field of the xds request passed upstream. RequestNodeMetadata string `protobuf:"bytes,5,opt,name=request_node_metadata,json=requestNodeMetadata,proto3" json:"request_node_metadata,omitempty"` // contains filtered or unexported fields }
[#next-free-field: 6]
func (*Upstream) Descriptor
deprecated
func (*Upstream) GetAddress ¶
func (x *Upstream) GetAddress() *SocketAddress
func (*Upstream) GetKeepAliveTime ¶
func (*Upstream) GetRequestNodeMetadata ¶
func (*Upstream) GetStreamTimeout ¶
func (*Upstream) GetStreamTimeoutJitter ¶
func (*Upstream) ProtoMessage ¶
func (*Upstream) ProtoMessage()
func (*Upstream) ProtoReflect ¶
func (x *Upstream) ProtoReflect() protoreflect.Message
type UpstreamValidationError ¶
type UpstreamValidationError struct {
// contains filtered or unexported fields
}
UpstreamValidationError is the validation error returned by Upstream.Validate if the designated constraints aren't met.
func (UpstreamValidationError) Cause ¶
func (e UpstreamValidationError) Cause() error
Cause function returns cause value.
func (UpstreamValidationError) Error ¶
func (e UpstreamValidationError) Error() string
Error satisfies the builtin error interface
func (UpstreamValidationError) ErrorName ¶
func (e UpstreamValidationError) ErrorName() string
ErrorName returns error name.
func (UpstreamValidationError) Field ¶
func (e UpstreamValidationError) Field() string
Field function returns field value.
func (UpstreamValidationError) Key ¶
func (e UpstreamValidationError) Key() bool
Key function returns key value.
func (UpstreamValidationError) Reason ¶
func (e UpstreamValidationError) Reason() string
Reason function returns reason value.