Documentation ¶
Overview ¶
Package client is a generated protocol buffer package.
It is generated from these files:
mixer/v1/config/client/api_spec.proto mixer/v1/config/client/client_config.proto mixer/v1/config/client/quota.proto mixer/v1/config/client/service.proto
It has these top-level messages:
HTTPAPISpec HTTPAPISpecPattern APIKey HTTPAPISpecReference HTTPAPISpecBinding NetworkFailPolicy ServiceConfig TransportConfig HttpClientConfig TcpClientConfig QuotaSpec QuotaRule StringMatch AttributeMatch Quota QuotaSpecBinding IstioService
Index ¶
- Variables
- type APIKey
- func (*APIKey) Descriptor() ([]byte, []int)
- func (m *APIKey) GetCookie() string
- func (m *APIKey) GetHeader() string
- func (m *APIKey) GetKey() isAPIKey_Key
- func (m *APIKey) GetQuery() string
- func (m *APIKey) Marshal() (dAtA []byte, err error)
- func (m *APIKey) MarshalTo(dAtA []byte) (int, error)
- func (*APIKey) ProtoMessage()
- func (m *APIKey) Reset()
- func (m *APIKey) Size() (n int)
- func (this *APIKey) String() string
- func (m *APIKey) Unmarshal(dAtA []byte) error
- func (*APIKey) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
- type APIKey_Cookie
- type APIKey_Header
- type APIKey_Query
- type AttributeMatch
- func (*AttributeMatch) Descriptor() ([]byte, []int)
- func (m *AttributeMatch) Marshal() (dAtA []byte, err error)
- func (m *AttributeMatch) MarshalTo(dAtA []byte) (int, error)
- func (*AttributeMatch) ProtoMessage()
- func (m *AttributeMatch) Reset()
- func (m *AttributeMatch) Size() (n int)
- func (this *AttributeMatch) String() string
- func (m *AttributeMatch) Unmarshal(dAtA []byte) error
- type HTTPAPISpec
- func (*HTTPAPISpec) Descriptor() ([]byte, []int)
- func (m *HTTPAPISpec) Marshal() (dAtA []byte, err error)
- func (m *HTTPAPISpec) MarshalTo(dAtA []byte) (int, error)
- func (*HTTPAPISpec) ProtoMessage()
- func (m *HTTPAPISpec) Reset()
- func (m *HTTPAPISpec) Size() (n int)
- func (this *HTTPAPISpec) String() string
- func (m *HTTPAPISpec) Unmarshal(dAtA []byte) error
- type HTTPAPISpecBinding
- func (*HTTPAPISpecBinding) Descriptor() ([]byte, []int)
- func (m *HTTPAPISpecBinding) Marshal() (dAtA []byte, err error)
- func (m *HTTPAPISpecBinding) MarshalTo(dAtA []byte) (int, error)
- func (*HTTPAPISpecBinding) ProtoMessage()
- func (m *HTTPAPISpecBinding) Reset()
- func (m *HTTPAPISpecBinding) Size() (n int)
- func (this *HTTPAPISpecBinding) String() string
- func (m *HTTPAPISpecBinding) Unmarshal(dAtA []byte) error
- type HTTPAPISpecPattern
- func (*HTTPAPISpecPattern) Descriptor() ([]byte, []int)
- func (m *HTTPAPISpecPattern) GetPattern() isHTTPAPISpecPattern_Pattern
- func (m *HTTPAPISpecPattern) GetRegex() string
- func (m *HTTPAPISpecPattern) GetUriTemplate() string
- func (m *HTTPAPISpecPattern) Marshal() (dAtA []byte, err error)
- func (m *HTTPAPISpecPattern) MarshalTo(dAtA []byte) (int, error)
- func (*HTTPAPISpecPattern) ProtoMessage()
- func (m *HTTPAPISpecPattern) Reset()
- func (m *HTTPAPISpecPattern) Size() (n int)
- func (this *HTTPAPISpecPattern) String() string
- func (m *HTTPAPISpecPattern) Unmarshal(dAtA []byte) error
- func (*HTTPAPISpecPattern) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
- type HTTPAPISpecPattern_Regex
- type HTTPAPISpecPattern_UriTemplate
- type HTTPAPISpecReference
- func (*HTTPAPISpecReference) Descriptor() ([]byte, []int)
- func (m *HTTPAPISpecReference) Marshal() (dAtA []byte, err error)
- func (m *HTTPAPISpecReference) MarshalTo(dAtA []byte) (int, error)
- func (*HTTPAPISpecReference) ProtoMessage()
- func (m *HTTPAPISpecReference) Reset()
- func (m *HTTPAPISpecReference) Size() (n int)
- func (this *HTTPAPISpecReference) String() string
- func (m *HTTPAPISpecReference) Unmarshal(dAtA []byte) error
- type HttpClientConfig
- func (*HttpClientConfig) Descriptor() ([]byte, []int)
- func (m *HttpClientConfig) Marshal() (dAtA []byte, err error)
- func (m *HttpClientConfig) MarshalTo(dAtA []byte) (int, error)
- func (*HttpClientConfig) ProtoMessage()
- func (m *HttpClientConfig) Reset()
- func (m *HttpClientConfig) Size() (n int)
- func (this *HttpClientConfig) String() string
- func (m *HttpClientConfig) Unmarshal(dAtA []byte) error
- type IstioService
- func (*IstioService) Descriptor() ([]byte, []int)
- func (m *IstioService) Marshal() (dAtA []byte, err error)
- func (m *IstioService) MarshalTo(dAtA []byte) (int, error)
- func (*IstioService) ProtoMessage()
- func (m *IstioService) Reset()
- func (m *IstioService) Size() (n int)
- func (this *IstioService) String() string
- func (m *IstioService) Unmarshal(dAtA []byte) error
- type NetworkFailPolicy
- func (*NetworkFailPolicy) Descriptor() ([]byte, []int)
- func (m *NetworkFailPolicy) Marshal() (dAtA []byte, err error)
- func (m *NetworkFailPolicy) MarshalTo(dAtA []byte) (int, error)
- func (*NetworkFailPolicy) ProtoMessage()
- func (m *NetworkFailPolicy) Reset()
- func (m *NetworkFailPolicy) Size() (n int)
- func (this *NetworkFailPolicy) String() string
- func (m *NetworkFailPolicy) Unmarshal(dAtA []byte) error
- type NetworkFailPolicy_FailPolicy
- type Quota
- func (*Quota) Descriptor() ([]byte, []int)
- func (m *Quota) Marshal() (dAtA []byte, err error)
- func (m *Quota) MarshalTo(dAtA []byte) (int, error)
- func (*Quota) ProtoMessage()
- func (m *Quota) Reset()
- func (m *Quota) Size() (n int)
- func (this *Quota) String() string
- func (m *Quota) Unmarshal(dAtA []byte) error
- type QuotaRule
- func (*QuotaRule) Descriptor() ([]byte, []int)
- func (m *QuotaRule) Marshal() (dAtA []byte, err error)
- func (m *QuotaRule) MarshalTo(dAtA []byte) (int, error)
- func (*QuotaRule) ProtoMessage()
- func (m *QuotaRule) Reset()
- func (m *QuotaRule) Size() (n int)
- func (this *QuotaRule) String() string
- func (m *QuotaRule) Unmarshal(dAtA []byte) error
- type QuotaSpec
- func (*QuotaSpec) Descriptor() ([]byte, []int)
- func (m *QuotaSpec) Marshal() (dAtA []byte, err error)
- func (m *QuotaSpec) MarshalTo(dAtA []byte) (int, error)
- func (*QuotaSpec) ProtoMessage()
- func (m *QuotaSpec) Reset()
- func (m *QuotaSpec) Size() (n int)
- func (this *QuotaSpec) String() string
- func (m *QuotaSpec) Unmarshal(dAtA []byte) error
- type QuotaSpecBinding
- func (*QuotaSpecBinding) Descriptor() ([]byte, []int)
- func (m *QuotaSpecBinding) Marshal() (dAtA []byte, err error)
- func (m *QuotaSpecBinding) MarshalTo(dAtA []byte) (int, error)
- func (*QuotaSpecBinding) ProtoMessage()
- func (m *QuotaSpecBinding) Reset()
- func (m *QuotaSpecBinding) Size() (n int)
- func (this *QuotaSpecBinding) String() string
- func (m *QuotaSpecBinding) Unmarshal(dAtA []byte) error
- type QuotaSpecBinding_QuotaSpecReference
- func (*QuotaSpecBinding_QuotaSpecReference) Descriptor() ([]byte, []int)
- func (m *QuotaSpecBinding_QuotaSpecReference) Marshal() (dAtA []byte, err error)
- func (m *QuotaSpecBinding_QuotaSpecReference) MarshalTo(dAtA []byte) (int, error)
- func (*QuotaSpecBinding_QuotaSpecReference) ProtoMessage()
- func (m *QuotaSpecBinding_QuotaSpecReference) Reset()
- func (m *QuotaSpecBinding_QuotaSpecReference) Size() (n int)
- func (this *QuotaSpecBinding_QuotaSpecReference) String() string
- func (m *QuotaSpecBinding_QuotaSpecReference) Unmarshal(dAtA []byte) error
- type ServiceConfig
- func (*ServiceConfig) Descriptor() ([]byte, []int)
- func (m *ServiceConfig) Marshal() (dAtA []byte, err error)
- func (m *ServiceConfig) MarshalTo(dAtA []byte) (int, error)
- func (*ServiceConfig) ProtoMessage()
- func (m *ServiceConfig) Reset()
- func (m *ServiceConfig) Size() (n int)
- func (this *ServiceConfig) String() string
- func (m *ServiceConfig) Unmarshal(dAtA []byte) error
- type StringMatch
- func (*StringMatch) Descriptor() ([]byte, []int)
- func (m *StringMatch) GetExact() string
- func (m *StringMatch) GetMatchType() isStringMatch_MatchType
- func (m *StringMatch) GetPrefix() string
- func (m *StringMatch) GetRegex() string
- func (m *StringMatch) Marshal() (dAtA []byte, err error)
- func (m *StringMatch) MarshalTo(dAtA []byte) (int, error)
- func (*StringMatch) ProtoMessage()
- func (m *StringMatch) Reset()
- func (m *StringMatch) Size() (n int)
- func (this *StringMatch) String() string
- func (m *StringMatch) Unmarshal(dAtA []byte) error
- func (*StringMatch) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
- type StringMatch_Exact
- type StringMatch_Prefix
- type StringMatch_Regex
- type TcpClientConfig
- func (*TcpClientConfig) Descriptor() ([]byte, []int)
- func (m *TcpClientConfig) Marshal() (dAtA []byte, err error)
- func (m *TcpClientConfig) MarshalTo(dAtA []byte) (int, error)
- func (*TcpClientConfig) ProtoMessage()
- func (m *TcpClientConfig) Reset()
- func (m *TcpClientConfig) Size() (n int)
- func (this *TcpClientConfig) String() string
- func (m *TcpClientConfig) Unmarshal(dAtA []byte) error
- type TransportConfig
- func (*TransportConfig) Descriptor() ([]byte, []int)
- func (m *TransportConfig) Marshal() (dAtA []byte, err error)
- func (m *TransportConfig) MarshalTo(dAtA []byte) (int, error)
- func (*TransportConfig) ProtoMessage()
- func (m *TransportConfig) Reset()
- func (m *TransportConfig) Size() (n int)
- func (this *TransportConfig) String() string
- func (m *TransportConfig) Unmarshal(dAtA []byte) error
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidLengthApiSpec = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowApiSpec = fmt.Errorf("proto: integer overflow") )
var ( ErrInvalidLengthClientConfig = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowClientConfig = fmt.Errorf("proto: integer overflow") )
var ( ErrInvalidLengthQuota = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowQuota = fmt.Errorf("proto: integer overflow") )
var ( ErrInvalidLengthService = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowService = fmt.Errorf("proto: integer overflow") )
var NetworkFailPolicy_FailPolicy_name = map[int32]string{
0: "FAIL_OPEN",
1: "FAIL_CLOSE",
}
var NetworkFailPolicy_FailPolicy_value = map[string]int32{
"FAIL_OPEN": 0,
"FAIL_CLOSE": 1,
}
Functions ¶
This section is empty.
Types ¶
type APIKey ¶
type APIKey struct { // Types that are valid to be assigned to Key: // *APIKey_Query // *APIKey_Header // *APIKey_Cookie Key isAPIKey_Key `protobuf_oneof:"key"` }
APIKey defines the explicit configuration for generating the `request.api_key` attribute from HTTP requests.
See https://swagger.io/docs/specification/authentication/api-keys for a general overview of API keys as defined by OpenAPI.
func (*APIKey) Descriptor ¶
func (*APIKey) ProtoMessage ¶
func (*APIKey) ProtoMessage()
type APIKey_Cookie ¶
type APIKey_Cookie struct {
Cookie string `protobuf:"bytes,3,opt,name=cookie,proto3,oneof"`
}
func (*APIKey_Cookie) Size ¶
func (m *APIKey_Cookie) Size() (n int)
func (*APIKey_Cookie) String ¶
func (this *APIKey_Cookie) String() string
type APIKey_Header ¶
type APIKey_Header struct {
Header string `protobuf:"bytes,2,opt,name=header,proto3,oneof"`
}
func (*APIKey_Header) Size ¶
func (m *APIKey_Header) Size() (n int)
func (*APIKey_Header) String ¶
func (this *APIKey_Header) String() string
type APIKey_Query ¶
type APIKey_Query struct {
Query string `protobuf:"bytes,1,opt,name=query,proto3,oneof"`
}
func (*APIKey_Query) Size ¶
func (m *APIKey_Query) Size() (n int)
func (*APIKey_Query) String ¶
func (this *APIKey_Query) String() string
type AttributeMatch ¶
type AttributeMatch struct { // Map of attribute names to StringMatch type. // Each map element specifies one condition to match. // // Example: // // clause: // source.uid: // exact: SOURCE_UID // request.http_method: // exact: POST Clause map[string]*StringMatch `` /* 139-byte string literal not displayed */ }
Specifies a match clause to match Istio attributes
func (*AttributeMatch) Descriptor ¶
func (*AttributeMatch) Descriptor() ([]byte, []int)
func (*AttributeMatch) Marshal ¶
func (m *AttributeMatch) Marshal() (dAtA []byte, err error)
func (*AttributeMatch) ProtoMessage ¶
func (*AttributeMatch) ProtoMessage()
func (*AttributeMatch) Reset ¶
func (m *AttributeMatch) Reset()
func (*AttributeMatch) Size ¶
func (m *AttributeMatch) Size() (n int)
func (*AttributeMatch) String ¶
func (this *AttributeMatch) String() string
func (*AttributeMatch) Unmarshal ¶
func (m *AttributeMatch) Unmarshal(dAtA []byte) error
type HTTPAPISpec ¶
type HTTPAPISpec struct { // List of attributes that are generated when *any* of the HTTP // patterns match. This list typically includes the "api.service" // and "api.version" attributes. Attributes *istio_mixer_v1.Attributes `protobuf:"bytes,1,opt,name=attributes" json:"attributes,omitempty"` // List of HTTP patterns to match. Patterns []*HTTPAPISpecPattern `protobuf:"bytes,2,rep,name=patterns" json:"patterns,omitempty"` // List of APIKey that describes how to extract an API-KEY from an // HTTP request. The first API-Key match found in the list is used, // i.e. 'OR' semantics. // // The following default policies are used to generate the // `request.api_key` attribute if no explicit APIKey is defined. // // `query: key, `query: api_key`, and then `header: x-api-key` // ApiKeys []*APIKey `protobuf:"bytes,3,rep,name=api_keys,json=apiKeys" json:"api_keys,omitempty"` }
HTTPAPISpec defines the canonical configuration for generating API-related attributes from HTTP requests based on the method and uri templated path matches. It is sufficient for defining the API surface of a service for the purposes of API attribute generation. It is not intended to represent auth, quota, documentation, or other information commonly found in other API specifications, e.g. OpenAPI.
Existing standards that define operations (or methods) in terms of HTTP methods and paths can be normalized to this format for use in Istio. For example, a simple petstore API described by OpenAPIv2 [here](https://github.com/googleapis/gnostic/blob/master/examples/v2.0/yaml/petstore-simple.yaml) can be represented with the following HTTPAPISpec.
```yaml apiVersion: config.istio.io/v1alpha2 kind: HTTPAPISpec metadata:
name: petstore namespace: default
spec:
attributes: api.service: petstore.swagger.io api.version: 1.0.0 patterns: - attributes: api.operation: findPets httpMethod: GET uriTemplate: /api/pets - attributes: api.operation: addPet httpMethod: POST uriTemplate: /api/pets - attributes: api.operation: findPetById httpMethod: GET uriTemplate: /api/pets/{id} - attributes: api.operation: deletePet httpMethod: DELETE uriTemplate: /api/pets/{id} api_keys: - query: api-key
```
func (*HTTPAPISpec) Descriptor ¶
func (*HTTPAPISpec) Descriptor() ([]byte, []int)
func (*HTTPAPISpec) Marshal ¶
func (m *HTTPAPISpec) Marshal() (dAtA []byte, err error)
func (*HTTPAPISpec) ProtoMessage ¶
func (*HTTPAPISpec) ProtoMessage()
func (*HTTPAPISpec) Reset ¶
func (m *HTTPAPISpec) Reset()
func (*HTTPAPISpec) Size ¶
func (m *HTTPAPISpec) Size() (n int)
func (*HTTPAPISpec) String ¶
func (this *HTTPAPISpec) String() string
func (*HTTPAPISpec) Unmarshal ¶
func (m *HTTPAPISpec) Unmarshal(dAtA []byte) error
type HTTPAPISpecBinding ¶
type HTTPAPISpecBinding struct { // REQUIRED. One or more services to map the listed HTTPAPISpec onto. Services []*IstioService `protobuf:"bytes,1,rep,name=services" json:"services,omitempty"` // REQUIRED. One or more HTTPAPISpec references that should be mapped to // the specified service(s). The aggregate collection of match // conditions defined in the HTTPAPISpecs should not overlap. ApiSpecs []*HTTPAPISpecReference `protobuf:"bytes,2,rep,name=api_specs,json=apiSpecs" json:"api_specs,omitempty"` }
HTTPAPISpecBinding defines the binding between HTTPAPISpecs and one or more IstioService. For example, the following establishes a binding between the HTTPAPISpec `petstore` and service `foo` in namespace `bar`.
```yaml apiVersion: config.istio.io/v1alpha2 kind: HTTPAPISpecBinding metadata:
name: my-binding namespace: default
spec:
services: - name: foo namespace: bar api_specs: - name: petstore namespace: default
```
func (*HTTPAPISpecBinding) Descriptor ¶
func (*HTTPAPISpecBinding) Descriptor() ([]byte, []int)
func (*HTTPAPISpecBinding) Marshal ¶
func (m *HTTPAPISpecBinding) Marshal() (dAtA []byte, err error)
func (*HTTPAPISpecBinding) MarshalTo ¶
func (m *HTTPAPISpecBinding) MarshalTo(dAtA []byte) (int, error)
func (*HTTPAPISpecBinding) ProtoMessage ¶
func (*HTTPAPISpecBinding) ProtoMessage()
func (*HTTPAPISpecBinding) Reset ¶
func (m *HTTPAPISpecBinding) Reset()
func (*HTTPAPISpecBinding) Size ¶
func (m *HTTPAPISpecBinding) Size() (n int)
func (*HTTPAPISpecBinding) String ¶
func (this *HTTPAPISpecBinding) String() string
func (*HTTPAPISpecBinding) Unmarshal ¶
func (m *HTTPAPISpecBinding) Unmarshal(dAtA []byte) error
type HTTPAPISpecPattern ¶
type HTTPAPISpecPattern struct { // List of attributes that are generated if the HTTP request matches // the specified http_method and uri_template. This typically // includes the "api.operation" attribute. Attributes *istio_mixer_v1.Attributes `protobuf:"bytes,1,opt,name=attributes" json:"attributes,omitempty"` // HTTP request method to match against as defined by // [rfc7231](https://tools.ietf.org/html/rfc7231#page-21). For // example: GET, HEAD, POST, PUT, DELETE. HttpMethod string `protobuf:"bytes,2,opt,name=http_method,json=httpMethod,proto3" json:"http_method,omitempty"` // Types that are valid to be assigned to Pattern: // *HTTPAPISpecPattern_UriTemplate // *HTTPAPISpecPattern_Regex Pattern isHTTPAPISpecPattern_Pattern `protobuf_oneof:"pattern"` }
HTTPAPISpecPattern defines a single pattern to match against incoming HTTP requests. The per-pattern list of attributes is generated if both the http_method and uri_template match. In addition, the top-level list of attributes in the HTTPAPISpec is also generated.
```yaml pattern:
- attributes api.operation: doFooBar httpMethod: GET uriTemplate: /foo/bar
```
func (*HTTPAPISpecPattern) Descriptor ¶
func (*HTTPAPISpecPattern) Descriptor() ([]byte, []int)
func (*HTTPAPISpecPattern) GetPattern ¶
func (m *HTTPAPISpecPattern) GetPattern() isHTTPAPISpecPattern_Pattern
func (*HTTPAPISpecPattern) GetRegex ¶
func (m *HTTPAPISpecPattern) GetRegex() string
func (*HTTPAPISpecPattern) GetUriTemplate ¶
func (m *HTTPAPISpecPattern) GetUriTemplate() string
func (*HTTPAPISpecPattern) Marshal ¶
func (m *HTTPAPISpecPattern) Marshal() (dAtA []byte, err error)
func (*HTTPAPISpecPattern) MarshalTo ¶
func (m *HTTPAPISpecPattern) MarshalTo(dAtA []byte) (int, error)
func (*HTTPAPISpecPattern) ProtoMessage ¶
func (*HTTPAPISpecPattern) ProtoMessage()
func (*HTTPAPISpecPattern) Reset ¶
func (m *HTTPAPISpecPattern) Reset()
func (*HTTPAPISpecPattern) Size ¶
func (m *HTTPAPISpecPattern) Size() (n int)
func (*HTTPAPISpecPattern) String ¶
func (this *HTTPAPISpecPattern) String() string
func (*HTTPAPISpecPattern) Unmarshal ¶
func (m *HTTPAPISpecPattern) Unmarshal(dAtA []byte) error
func (*HTTPAPISpecPattern) XXX_OneofFuncs ¶
func (*HTTPAPISpecPattern) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type HTTPAPISpecPattern_Regex ¶
type HTTPAPISpecPattern_Regex struct {
Regex string `protobuf:"bytes,4,opt,name=regex,proto3,oneof"`
}
func (*HTTPAPISpecPattern_Regex) MarshalTo ¶
func (m *HTTPAPISpecPattern_Regex) MarshalTo(dAtA []byte) (int, error)
func (*HTTPAPISpecPattern_Regex) Size ¶
func (m *HTTPAPISpecPattern_Regex) Size() (n int)
func (*HTTPAPISpecPattern_Regex) String ¶
func (this *HTTPAPISpecPattern_Regex) String() string
type HTTPAPISpecPattern_UriTemplate ¶
type HTTPAPISpecPattern_UriTemplate struct {
UriTemplate string `protobuf:"bytes,3,opt,name=uri_template,json=uriTemplate,proto3,oneof"`
}
func (*HTTPAPISpecPattern_UriTemplate) MarshalTo ¶
func (m *HTTPAPISpecPattern_UriTemplate) MarshalTo(dAtA []byte) (int, error)
func (*HTTPAPISpecPattern_UriTemplate) Size ¶
func (m *HTTPAPISpecPattern_UriTemplate) Size() (n int)
func (*HTTPAPISpecPattern_UriTemplate) String ¶
func (this *HTTPAPISpecPattern_UriTemplate) String() string
type HTTPAPISpecReference ¶
type HTTPAPISpecReference struct { // REQUIRED. The short name of the HTTPAPISpec. This is the resource // name defined by the metadata name field. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Optional namespace of the HTTPAPISpec. Defaults to the encompassing // HTTPAPISpecBinding's metadata namespace field. Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"` }
HTTPAPISpecReference defines a reference to an HTTPAPISpec. This is typically used for establishing bindings between an HTTPAPISpec and an IstioService. For example, the following defines an HTTPAPISpecReference for service `foo` in namespace `bar`.
```yaml
- name: foo namespace: bar
```
func (*HTTPAPISpecReference) Descriptor ¶
func (*HTTPAPISpecReference) Descriptor() ([]byte, []int)
func (*HTTPAPISpecReference) Marshal ¶
func (m *HTTPAPISpecReference) Marshal() (dAtA []byte, err error)
func (*HTTPAPISpecReference) MarshalTo ¶
func (m *HTTPAPISpecReference) MarshalTo(dAtA []byte) (int, error)
func (*HTTPAPISpecReference) ProtoMessage ¶
func (*HTTPAPISpecReference) ProtoMessage()
func (*HTTPAPISpecReference) Reset ¶
func (m *HTTPAPISpecReference) Reset()
func (*HTTPAPISpecReference) Size ¶
func (m *HTTPAPISpecReference) Size() (n int)
func (*HTTPAPISpecReference) String ¶
func (this *HTTPAPISpecReference) String() string
func (*HTTPAPISpecReference) Unmarshal ¶
func (m *HTTPAPISpecReference) Unmarshal(dAtA []byte) error
type HttpClientConfig ¶
type HttpClientConfig struct { // The transport config. Transport *TransportConfig `protobuf:"bytes,1,opt,name=transport" json:"transport,omitempty"` // Map of control configuration indexed by destination.service. This // is used to support per-service configuration for cases where a // mixerclient serves multiple services. ServiceConfigs map[string]*ServiceConfig `` /* 177-byte string literal not displayed */ // Default destination service name if none was specified in the // client request. DefaultDestinationService string `` /* 138-byte string literal not displayed */ // Default attributes to send to Mixer in both Check and // Report. This typically includes "destination.ip" and // "destination.uid" attributes. MixerAttributes *istio_mixer_v1.Attributes `protobuf:"bytes,4,opt,name=mixer_attributes,json=mixerAttributes" json:"mixer_attributes,omitempty"` // Default attributes to forward to upstream. This typically // includes the "source.ip" and "source.uid" attributes. ForwardAttributes *istio_mixer_v1.Attributes `protobuf:"bytes,5,opt,name=forward_attributes,json=forwardAttributes" json:"forward_attributes,omitempty"` }
Defines the client config for HTTP.
func (*HttpClientConfig) Descriptor ¶
func (*HttpClientConfig) Descriptor() ([]byte, []int)
func (*HttpClientConfig) Marshal ¶
func (m *HttpClientConfig) Marshal() (dAtA []byte, err error)
func (*HttpClientConfig) ProtoMessage ¶
func (*HttpClientConfig) ProtoMessage()
func (*HttpClientConfig) Reset ¶
func (m *HttpClientConfig) Reset()
func (*HttpClientConfig) Size ¶
func (m *HttpClientConfig) Size() (n int)
func (*HttpClientConfig) String ¶
func (this *HttpClientConfig) String() string
func (*HttpClientConfig) Unmarshal ¶
func (m *HttpClientConfig) Unmarshal(dAtA []byte) error
type IstioService ¶
type IstioService struct { // The short name of the service such as "foo". Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Optional namespace of the service. Defaults to value of metadata namespace field. Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"` // Domain suffix used to construct the service FQDN in implementations that support such specification. Domain string `protobuf:"bytes,3,opt,name=domain,proto3" json:"domain,omitempty"` // The service FQDN. Service string `protobuf:"bytes,4,opt,name=service,proto3" json:"service,omitempty"` // Optional one or more labels that uniquely identify the service version. // // *Note:* When used for a RouteRule destination, labels MUST be empty. // Labels map[string]string `` /* 146-byte string literal not displayed */ }
IstioService identifies a service and optionally service version. The FQDN of the service is composed from the name, namespace, and implementation-specific domain suffix (e.g. on Kubernetes, "reviews" + "default" + "svc.cluster.local" -> "reviews.default.svc.cluster.local").
func (*IstioService) Descriptor ¶
func (*IstioService) Descriptor() ([]byte, []int)
func (*IstioService) Marshal ¶
func (m *IstioService) Marshal() (dAtA []byte, err error)
func (*IstioService) ProtoMessage ¶
func (*IstioService) ProtoMessage()
func (*IstioService) Reset ¶
func (m *IstioService) Reset()
func (*IstioService) Size ¶
func (m *IstioService) Size() (n int)
func (*IstioService) String ¶
func (this *IstioService) String() string
func (*IstioService) Unmarshal ¶
func (m *IstioService) Unmarshal(dAtA []byte) error
type NetworkFailPolicy ¶
type NetworkFailPolicy struct { // Specifies the behavior when the client is unable to connect to Mixer. Policy NetworkFailPolicy_FailPolicy `` /* 129-byte string literal not displayed */ }
Specifies the behavior when the client is unable to connect to Mixer.
func (*NetworkFailPolicy) Descriptor ¶
func (*NetworkFailPolicy) Descriptor() ([]byte, []int)
func (*NetworkFailPolicy) Marshal ¶
func (m *NetworkFailPolicy) Marshal() (dAtA []byte, err error)
func (*NetworkFailPolicy) MarshalTo ¶
func (m *NetworkFailPolicy) MarshalTo(dAtA []byte) (int, error)
func (*NetworkFailPolicy) ProtoMessage ¶
func (*NetworkFailPolicy) ProtoMessage()
func (*NetworkFailPolicy) Reset ¶
func (m *NetworkFailPolicy) Reset()
func (*NetworkFailPolicy) Size ¶
func (m *NetworkFailPolicy) Size() (n int)
func (*NetworkFailPolicy) String ¶
func (this *NetworkFailPolicy) String() string
func (*NetworkFailPolicy) Unmarshal ¶
func (m *NetworkFailPolicy) Unmarshal(dAtA []byte) error
type NetworkFailPolicy_FailPolicy ¶
type NetworkFailPolicy_FailPolicy int32
Describes the policy.
const ( // If network connection fails, request is allowed and delivered to the // service. FAIL_OPEN NetworkFailPolicy_FailPolicy = 0 // If network connection fails, request is rejected. FAIL_CLOSE NetworkFailPolicy_FailPolicy = 1 )
func (NetworkFailPolicy_FailPolicy) EnumDescriptor ¶
func (NetworkFailPolicy_FailPolicy) EnumDescriptor() ([]byte, []int)
func (NetworkFailPolicy_FailPolicy) String ¶
func (x NetworkFailPolicy_FailPolicy) String() string
type Quota ¶
type Quota struct { // The quota name to charge Quota string `protobuf:"bytes,1,opt,name=quota,proto3" json:"quota,omitempty"` // The quota amount to charge Charge int64 `protobuf:"varint,2,opt,name=charge,proto3" json:"charge,omitempty"` }
Specifies a quota to use with quota name and amount.
func (*Quota) Descriptor ¶
func (*Quota) ProtoMessage ¶
func (*Quota) ProtoMessage()
type QuotaRule ¶
type QuotaRule struct { // If empty, match all request. // If any of match is true, it is matched. Match []*AttributeMatch `protobuf:"bytes,1,rep,name=match" json:"match,omitempty"` // The list of quotas to charge. Quotas []*Quota `protobuf:"bytes,2,rep,name=quotas" json:"quotas,omitempty"` }
Specifies a rule with list of matches and list of quotas. If any clause matched, the list of quotas will be used.
func (*QuotaRule) Descriptor ¶
func (*QuotaRule) ProtoMessage ¶
func (*QuotaRule) ProtoMessage()
type QuotaSpec ¶
type QuotaSpec struct { // A list of Quota rules. Rules []*QuotaRule `protobuf:"bytes,1,rep,name=rules" json:"rules,omitempty"` }
Determines the quotas used for individual requests.
func (*QuotaSpec) Descriptor ¶
func (*QuotaSpec) ProtoMessage ¶
func (*QuotaSpec) ProtoMessage()
type QuotaSpecBinding ¶
type QuotaSpecBinding struct { // REQUIRED. One or more services to map the listed QuotaSpec onto. Services []*IstioService `protobuf:"bytes,1,rep,name=services" json:"services,omitempty"` // REQUIRED. One or more QuotaSpec references that should be mapped to // the specified service(s). The aggregate collection of match // conditions defined in the QuotaSpecs should not overlap. QuotaSpecs []*QuotaSpecBinding_QuotaSpecReference `protobuf:"bytes,2,rep,name=quota_specs,json=quotaSpecs" json:"quota_specs,omitempty"` }
QuotaSpecBinding defines the binding between QuotaSpecs and one or more IstioService.
func (*QuotaSpecBinding) Descriptor ¶
func (*QuotaSpecBinding) Descriptor() ([]byte, []int)
func (*QuotaSpecBinding) Marshal ¶
func (m *QuotaSpecBinding) Marshal() (dAtA []byte, err error)
func (*QuotaSpecBinding) ProtoMessage ¶
func (*QuotaSpecBinding) ProtoMessage()
func (*QuotaSpecBinding) Reset ¶
func (m *QuotaSpecBinding) Reset()
func (*QuotaSpecBinding) Size ¶
func (m *QuotaSpecBinding) Size() (n int)
func (*QuotaSpecBinding) String ¶
func (this *QuotaSpecBinding) String() string
func (*QuotaSpecBinding) Unmarshal ¶
func (m *QuotaSpecBinding) Unmarshal(dAtA []byte) error
type QuotaSpecBinding_QuotaSpecReference ¶
type QuotaSpecBinding_QuotaSpecReference struct { // REQUIRED. The short name of the QuotaSpec. This is the resource // name defined by the metadata name field. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Optional namespace of the QuotaSpec. Defaults to the value of the // metadata namespace field. Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"` }
QuotaSpecReference uniquely identifies the QuotaSpec used in the Binding.
func (*QuotaSpecBinding_QuotaSpecReference) Descriptor ¶
func (*QuotaSpecBinding_QuotaSpecReference) Descriptor() ([]byte, []int)
func (*QuotaSpecBinding_QuotaSpecReference) Marshal ¶
func (m *QuotaSpecBinding_QuotaSpecReference) Marshal() (dAtA []byte, err error)
func (*QuotaSpecBinding_QuotaSpecReference) MarshalTo ¶
func (m *QuotaSpecBinding_QuotaSpecReference) MarshalTo(dAtA []byte) (int, error)
func (*QuotaSpecBinding_QuotaSpecReference) ProtoMessage ¶
func (*QuotaSpecBinding_QuotaSpecReference) ProtoMessage()
func (*QuotaSpecBinding_QuotaSpecReference) Reset ¶
func (m *QuotaSpecBinding_QuotaSpecReference) Reset()
func (*QuotaSpecBinding_QuotaSpecReference) Size ¶
func (m *QuotaSpecBinding_QuotaSpecReference) Size() (n int)
func (*QuotaSpecBinding_QuotaSpecReference) String ¶
func (this *QuotaSpecBinding_QuotaSpecReference) String() string
func (*QuotaSpecBinding_QuotaSpecReference) Unmarshal ¶
func (m *QuotaSpecBinding_QuotaSpecReference) Unmarshal(dAtA []byte) error
type ServiceConfig ¶
type ServiceConfig struct { // If true, do not call Mixer Check. DisableCheckCalls bool `protobuf:"varint,1,opt,name=disable_check_calls,json=disableCheckCalls,proto3" json:"disable_check_calls,omitempty"` // If true, do not call Mixer Report. DisableReportCalls bool `protobuf:"varint,2,opt,name=disable_report_calls,json=disableReportCalls,proto3" json:"disable_report_calls,omitempty"` // Send these attributes to Mixer in both Check and Report. This // typically includes the "destination.service" attribute. // In case of a per-route override, per-route attributes take precedence // over the attributes supplied in the client configuration. MixerAttributes *istio_mixer_v1.Attributes `protobuf:"bytes,3,opt,name=mixer_attributes,json=mixerAttributes" json:"mixer_attributes,omitempty"` // HTTP API specifications to generate API attributes. HttpApiSpec []*HTTPAPISpec `protobuf:"bytes,4,rep,name=http_api_spec,json=httpApiSpec" json:"http_api_spec,omitempty"` // Quota specifications to generate quota requirements. QuotaSpec []*QuotaSpec `protobuf:"bytes,5,rep,name=quota_spec,json=quotaSpec" json:"quota_spec,omitempty"` // Specifies the behavior when the client is unable to connect to Mixer. // This is the service-level policy. It overrides // [mesh-level // policy][istio.mixer.v1.config.client.TransportConfig.network_fail_policy]. NetworkFailPolicy *NetworkFailPolicy `protobuf:"bytes,7,opt,name=network_fail_policy,json=networkFailPolicy" json:"network_fail_policy,omitempty"` // Default attributes to forward to upstream. This typically // includes the "source.ip" and "source.uid" attributes. // In case of a per-route override, per-route attributes take precedence // over the attributes supplied in the client configuration. // // Forwarded attributes take precedence over the static Mixer attributes. // The full order of application is as follows: // 1. static Mixer attributes from the filter config; // 2. static Mixer attributes from the route config; // 3. forwarded attributes from the source filter config (if any); // 4. forwarded attributes from the source route config (if any); // 5. derived attributes from the request metadata. ForwardAttributes *istio_mixer_v1.Attributes `protobuf:"bytes,8,opt,name=forward_attributes,json=forwardAttributes" json:"forward_attributes,omitempty"` }
Defines the per-service client configuration.
func (*ServiceConfig) Descriptor ¶
func (*ServiceConfig) Descriptor() ([]byte, []int)
func (*ServiceConfig) Marshal ¶
func (m *ServiceConfig) Marshal() (dAtA []byte, err error)
func (*ServiceConfig) ProtoMessage ¶
func (*ServiceConfig) ProtoMessage()
func (*ServiceConfig) Reset ¶
func (m *ServiceConfig) Reset()
func (*ServiceConfig) Size ¶
func (m *ServiceConfig) Size() (n int)
func (*ServiceConfig) String ¶
func (this *ServiceConfig) String() string
func (*ServiceConfig) Unmarshal ¶
func (m *ServiceConfig) Unmarshal(dAtA []byte) error
type StringMatch ¶
type StringMatch struct { // Types that are valid to be assigned to MatchType: // *StringMatch_Exact // *StringMatch_Prefix // *StringMatch_Regex MatchType isStringMatch_MatchType `protobuf_oneof:"match_type"` }
Describes how to match a given string in HTTP headers. Match is case-sensitive.
func (*StringMatch) Descriptor ¶
func (*StringMatch) Descriptor() ([]byte, []int)
func (*StringMatch) GetExact ¶
func (m *StringMatch) GetExact() string
func (*StringMatch) GetMatchType ¶
func (m *StringMatch) GetMatchType() isStringMatch_MatchType
func (*StringMatch) GetPrefix ¶
func (m *StringMatch) GetPrefix() string
func (*StringMatch) GetRegex ¶
func (m *StringMatch) GetRegex() string
func (*StringMatch) Marshal ¶
func (m *StringMatch) Marshal() (dAtA []byte, err error)
func (*StringMatch) ProtoMessage ¶
func (*StringMatch) ProtoMessage()
func (*StringMatch) Reset ¶
func (m *StringMatch) Reset()
func (*StringMatch) Size ¶
func (m *StringMatch) Size() (n int)
func (*StringMatch) String ¶
func (this *StringMatch) String() string
func (*StringMatch) Unmarshal ¶
func (m *StringMatch) Unmarshal(dAtA []byte) error
func (*StringMatch) XXX_OneofFuncs ¶
func (*StringMatch) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type StringMatch_Exact ¶
type StringMatch_Exact struct {
Exact string `protobuf:"bytes,1,opt,name=exact,proto3,oneof"`
}
func (*StringMatch_Exact) MarshalTo ¶
func (m *StringMatch_Exact) MarshalTo(dAtA []byte) (int, error)
func (*StringMatch_Exact) Size ¶
func (m *StringMatch_Exact) Size() (n int)
func (*StringMatch_Exact) String ¶
func (this *StringMatch_Exact) String() string
type StringMatch_Prefix ¶
type StringMatch_Prefix struct {
Prefix string `protobuf:"bytes,2,opt,name=prefix,proto3,oneof"`
}
func (*StringMatch_Prefix) MarshalTo ¶
func (m *StringMatch_Prefix) MarshalTo(dAtA []byte) (int, error)
func (*StringMatch_Prefix) Size ¶
func (m *StringMatch_Prefix) Size() (n int)
func (*StringMatch_Prefix) String ¶
func (this *StringMatch_Prefix) String() string
type StringMatch_Regex ¶
type StringMatch_Regex struct {
Regex string `protobuf:"bytes,3,opt,name=regex,proto3,oneof"`
}
func (*StringMatch_Regex) MarshalTo ¶
func (m *StringMatch_Regex) MarshalTo(dAtA []byte) (int, error)
func (*StringMatch_Regex) Size ¶
func (m *StringMatch_Regex) Size() (n int)
func (*StringMatch_Regex) String ¶
func (this *StringMatch_Regex) String() string
type TcpClientConfig ¶
type TcpClientConfig struct { // The transport config. Transport *TransportConfig `protobuf:"bytes,1,opt,name=transport" json:"transport,omitempty"` // Default attributes to send to Mixer in both Check and // Report. This typically includes "destination.ip" and // "destination.uid" attributes. MixerAttributes *istio_mixer_v1.Attributes `protobuf:"bytes,2,opt,name=mixer_attributes,json=mixerAttributes" json:"mixer_attributes,omitempty"` // If set to true, disables mixer check calls. DisableCheckCalls bool `protobuf:"varint,3,opt,name=disable_check_calls,json=disableCheckCalls,proto3" json:"disable_check_calls,omitempty"` // If set to true, disables mixer check calls. DisableReportCalls bool `protobuf:"varint,4,opt,name=disable_report_calls,json=disableReportCalls,proto3" json:"disable_report_calls,omitempty"` // Quota specifications to generate quota requirements. // It applies on the new TCP connections. ConnectionQuotaSpec *QuotaSpec `protobuf:"bytes,5,opt,name=connection_quota_spec,json=connectionQuotaSpec" json:"connection_quota_spec,omitempty"` // Specify report interval to send periodical reports for long TCP // connections. If not specified, the interval is 10 seconds. This interval // should not be less than 1 second, otherwise it will be reset to 1 second. ReportInterval *google_protobuf1.Duration `protobuf:"bytes,6,opt,name=report_interval,json=reportInterval" json:"report_interval,omitempty"` }
Defines the client config for TCP.
func (*TcpClientConfig) Descriptor ¶
func (*TcpClientConfig) Descriptor() ([]byte, []int)
func (*TcpClientConfig) Marshal ¶
func (m *TcpClientConfig) Marshal() (dAtA []byte, err error)
func (*TcpClientConfig) ProtoMessage ¶
func (*TcpClientConfig) ProtoMessage()
func (*TcpClientConfig) Reset ¶
func (m *TcpClientConfig) Reset()
func (*TcpClientConfig) Size ¶
func (m *TcpClientConfig) Size() (n int)
func (*TcpClientConfig) String ¶
func (this *TcpClientConfig) String() string
func (*TcpClientConfig) Unmarshal ¶
func (m *TcpClientConfig) Unmarshal(dAtA []byte) error
type TransportConfig ¶
type TransportConfig struct { // The flag to disable check cache. DisableCheckCache bool `protobuf:"varint,1,opt,name=disable_check_cache,json=disableCheckCache,proto3" json:"disable_check_cache,omitempty"` // The flag to disable quota cache. DisableQuotaCache bool `protobuf:"varint,2,opt,name=disable_quota_cache,json=disableQuotaCache,proto3" json:"disable_quota_cache,omitempty"` // The flag to disable report batch. DisableReportBatch bool `protobuf:"varint,3,opt,name=disable_report_batch,json=disableReportBatch,proto3" json:"disable_report_batch,omitempty"` // Specifies the behavior when the client is unable to connect to Mixer. // This is the mesh level policy. The default value for policy is FAIL_OPEN. NetworkFailPolicy *NetworkFailPolicy `protobuf:"bytes,4,opt,name=network_fail_policy,json=networkFailPolicy" json:"network_fail_policy,omitempty"` // Specify refresh interval to write mixer client statistics to Envoy share // memory. If not specified, the interval is 10 seconds. StatsUpdateInterval *google_protobuf1.Duration `protobuf:"bytes,5,opt,name=stats_update_interval,json=statsUpdateInterval" json:"stats_update_interval,omitempty"` // Name of the cluster that will forward check calls to a pool of mixer // servers. Defaults to "mixer_server". By using different names for // checkCluster and reportCluster, it is possible to have one set of // mixer servers handle check calls, while another set of mixer servers // handle report calls. // // NOTE: Any value other than the default "mixer_server" will require the // Istio Grafana dashboards to be reconfigured to use the new name. CheckCluster string `protobuf:"bytes,6,opt,name=check_cluster,json=checkCluster,proto3" json:"check_cluster,omitempty"` // Name of the cluster that will forward report calls to a pool of mixer // servers. Defaults to "mixer_server". By using different names for // checkCluster and reportCluster, it is possible to have one set of // mixer servers handle check calls, while another set of mixer servers // handle report calls. // // NOTE: Any value other than the default "mixer_server" will require the // Istio Grafana dashboards to be reconfigured to use the new name. ReportCluster string `protobuf:"bytes,7,opt,name=report_cluster,json=reportCluster,proto3" json:"report_cluster,omitempty"` // Default attributes to forward to mixer upstream. This typically // includes the "source.ip" and "source.uid" attributes. These // attributes are consumed by the proxy in front of mixer. AttributesForMixerProxy *istio_mixer_v1.Attributes `` /* 127-byte string literal not displayed */ }
Defines the transport config on how to call Mixer.
func (*TransportConfig) Descriptor ¶
func (*TransportConfig) Descriptor() ([]byte, []int)
func (*TransportConfig) Marshal ¶
func (m *TransportConfig) Marshal() (dAtA []byte, err error)
func (*TransportConfig) ProtoMessage ¶
func (*TransportConfig) ProtoMessage()
func (*TransportConfig) Reset ¶
func (m *TransportConfig) Reset()
func (*TransportConfig) Size ¶
func (m *TransportConfig) Size() (n int)
func (*TransportConfig) String ¶
func (this *TransportConfig) String() string
func (*TransportConfig) Unmarshal ¶
func (m *TransportConfig) Unmarshal(dAtA []byte) error