 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
- Variables
- type AggregateClusterResource
- func (*AggregateClusterResource) Descriptor() ([]byte, []int)deprecated
- func (x *AggregateClusterResource) GetConfigSource() *v3.ConfigSource
- func (x *AggregateClusterResource) GetResourceName() string
- func (*AggregateClusterResource) ProtoMessage()
- func (x *AggregateClusterResource) ProtoReflect() protoreflect.Message
- func (x *AggregateClusterResource) Reset()
- func (x *AggregateClusterResource) String() string
- func (m *AggregateClusterResource) Validate() error
- func (m *AggregateClusterResource) ValidateAll() error
 
- type AggregateClusterResourceMultiError
- type AggregateClusterResourceValidationError
- func (e AggregateClusterResourceValidationError) Cause() error
- func (e AggregateClusterResourceValidationError) Error() string
- func (e AggregateClusterResourceValidationError) ErrorName() string
- func (e AggregateClusterResourceValidationError) Field() string
- func (e AggregateClusterResourceValidationError) Key() bool
- func (e AggregateClusterResourceValidationError) Reason() string
 
- type ClusterConfig
- func (*ClusterConfig) Descriptor() ([]byte, []int)deprecated
- func (x *ClusterConfig) GetClusters() []string
- func (*ClusterConfig) ProtoMessage()
- func (x *ClusterConfig) ProtoReflect() protoreflect.Message
- func (x *ClusterConfig) Reset()
- func (x *ClusterConfig) String() string
- func (m *ClusterConfig) Validate() error
- func (m *ClusterConfig) ValidateAll() error
 
- type ClusterConfigMultiError
- type ClusterConfigValidationError
- func (e ClusterConfigValidationError) Cause() error
- func (e ClusterConfigValidationError) Error() string
- func (e ClusterConfigValidationError) ErrorName() string
- func (e ClusterConfigValidationError) Field() string
- func (e ClusterConfigValidationError) Key() bool
- func (e ClusterConfigValidationError) Reason() string
 
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_clusters_aggregate_v3_cluster_proto protoreflect.FileDescriptor
    Functions ¶
This section is empty.
Types ¶
type AggregateClusterResource ¶ added in v1.35.0
type AggregateClusterResource struct {
	// Configuration source specifier for the ClusterConfig resource.
	// Only the aggregated protocol variants are supported; if configured
	// otherwise, the cluster resource will be NACKed.
	ConfigSource *v3.ConfigSource `protobuf:"bytes,1,opt,name=config_source,json=configSource,proto3" json:"config_source,omitempty"`
	// The name of the ClusterConfig resource to subscribe to.
	ResourceName string `protobuf:"bytes,2,opt,name=resource_name,json=resourceName,proto3" json:"resource_name,omitempty"`
	// contains filtered or unexported fields
}
    Configures an aggregate cluster whose :ref:`ClusterConfig <envoy_v3_api_msg_extensions.clusters.aggregate.v3.ClusterConfig>` is to be fetched from a separate xDS resource. [#extension: envoy.clusters.aggregate_resource] [#not-implemented-hide:]
        
          
            func (*AggregateClusterResource) Descriptor
            deprecated
            
          
  
    
      added in
      v1.35.0
    
  
      
      func (*AggregateClusterResource) Descriptor() ([]byte, []int)
Deprecated: Use AggregateClusterResource.ProtoReflect.Descriptor instead.
func (*AggregateClusterResource) GetConfigSource ¶ added in v1.35.0
func (x *AggregateClusterResource) GetConfigSource() *v3.ConfigSource
func (*AggregateClusterResource) GetResourceName ¶ added in v1.35.0
func (x *AggregateClusterResource) GetResourceName() string
func (*AggregateClusterResource) ProtoMessage ¶ added in v1.35.0
func (*AggregateClusterResource) ProtoMessage()
func (*AggregateClusterResource) ProtoReflect ¶ added in v1.35.0
func (x *AggregateClusterResource) ProtoReflect() protoreflect.Message
func (*AggregateClusterResource) Reset ¶ added in v1.35.0
func (x *AggregateClusterResource) Reset()
func (*AggregateClusterResource) String ¶ added in v1.35.0
func (x *AggregateClusterResource) String() string
func (*AggregateClusterResource) Validate ¶ added in v1.35.0
func (m *AggregateClusterResource) Validate() error
Validate checks the field values on AggregateClusterResource with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*AggregateClusterResource) ValidateAll ¶ added in v1.35.0
func (m *AggregateClusterResource) ValidateAll() error
ValidateAll checks the field values on AggregateClusterResource with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in AggregateClusterResourceMultiError, or nil if none found.
type AggregateClusterResourceMultiError ¶ added in v1.35.0
type AggregateClusterResourceMultiError []error
AggregateClusterResourceMultiError is an error wrapping multiple validation errors returned by AggregateClusterResource.ValidateAll() if the designated constraints aren't met.
func (AggregateClusterResourceMultiError) AllErrors ¶ added in v1.35.0
func (m AggregateClusterResourceMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (AggregateClusterResourceMultiError) Error ¶ added in v1.35.0
func (m AggregateClusterResourceMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type AggregateClusterResourceValidationError ¶ added in v1.35.0
type AggregateClusterResourceValidationError struct {
	// contains filtered or unexported fields
}
    AggregateClusterResourceValidationError is the validation error returned by AggregateClusterResource.Validate if the designated constraints aren't met.
func (AggregateClusterResourceValidationError) Cause ¶ added in v1.35.0
func (e AggregateClusterResourceValidationError) Cause() error
Cause function returns cause value.
func (AggregateClusterResourceValidationError) Error ¶ added in v1.35.0
func (e AggregateClusterResourceValidationError) Error() string
Error satisfies the builtin error interface
func (AggregateClusterResourceValidationError) ErrorName ¶ added in v1.35.0
func (e AggregateClusterResourceValidationError) ErrorName() string
ErrorName returns error name.
func (AggregateClusterResourceValidationError) Field ¶ added in v1.35.0
func (e AggregateClusterResourceValidationError) Field() string
Field function returns field value.
func (AggregateClusterResourceValidationError) Key ¶ added in v1.35.0
func (e AggregateClusterResourceValidationError) Key() bool
Key function returns key value.
func (AggregateClusterResourceValidationError) Reason ¶ added in v1.35.0
func (e AggregateClusterResourceValidationError) Reason() string
Reason function returns reason value.
type ClusterConfig ¶
type ClusterConfig struct {
	// Load balancing clusters in aggregate cluster. Clusters are prioritized based on the order they
	// appear in this list.
	Clusters []string `protobuf:"bytes,1,rep,name=clusters,proto3" json:"clusters,omitempty"`
	// contains filtered or unexported fields
}
    Configuration for the aggregate cluster. See the :ref:`architecture overview <arch_overview_aggregate_cluster>` for more information. [#extension: envoy.clusters.aggregate]
        
          
            func (*ClusterConfig) Descriptor
            deprecated
            
          
  
    
  
      
      func (*ClusterConfig) Descriptor() ([]byte, []int)
Deprecated: Use ClusterConfig.ProtoReflect.Descriptor instead.
func (*ClusterConfig) GetClusters ¶
func (x *ClusterConfig) GetClusters() []string
func (*ClusterConfig) ProtoMessage ¶
func (*ClusterConfig) ProtoMessage()
func (*ClusterConfig) ProtoReflect ¶
func (x *ClusterConfig) ProtoReflect() protoreflect.Message
func (*ClusterConfig) Reset ¶
func (x *ClusterConfig) Reset()
func (*ClusterConfig) String ¶
func (x *ClusterConfig) String() string
func (*ClusterConfig) Validate ¶
func (m *ClusterConfig) Validate() error
Validate checks the field values on ClusterConfig with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*ClusterConfig) ValidateAll ¶
func (m *ClusterConfig) ValidateAll() error
ValidateAll checks the field values on ClusterConfig with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ClusterConfigMultiError, or nil if none found.
type ClusterConfigMultiError ¶
type ClusterConfigMultiError []error
ClusterConfigMultiError is an error wrapping multiple validation errors returned by ClusterConfig.ValidateAll() if the designated constraints aren't met.
func (ClusterConfigMultiError) AllErrors ¶
func (m ClusterConfigMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ClusterConfigMultiError) Error ¶
func (m ClusterConfigMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type ClusterConfigValidationError ¶
type ClusterConfigValidationError struct {
	// contains filtered or unexported fields
}
    ClusterConfigValidationError is the validation error returned by ClusterConfig.Validate if the designated constraints aren't met.
func (ClusterConfigValidationError) Cause ¶
func (e ClusterConfigValidationError) Cause() error
Cause function returns cause value.
func (ClusterConfigValidationError) Error ¶
func (e ClusterConfigValidationError) Error() string
Error satisfies the builtin error interface
func (ClusterConfigValidationError) ErrorName ¶
func (e ClusterConfigValidationError) ErrorName() string
ErrorName returns error name.
func (ClusterConfigValidationError) Field ¶
func (e ClusterConfigValidationError) Field() string
Field function returns field value.
func (ClusterConfigValidationError) Key ¶
func (e ClusterConfigValidationError) Key() bool
Key function returns key value.
func (ClusterConfigValidationError) Reason ¶
func (e ClusterConfigValidationError) Reason() string
Reason function returns reason value.