Documentation ¶
Index ¶
- Variables
- type FilePerTapSink
- func (*FilePerTapSink) Descriptor() ([]byte, []int)deprecated
- func (x *FilePerTapSink) GetPathPrefix() string
- func (*FilePerTapSink) ProtoMessage()
- func (x *FilePerTapSink) ProtoReflect() protoreflect.Message
- func (x *FilePerTapSink) Reset()
- func (x *FilePerTapSink) String() string
- func (m *FilePerTapSink) Validate() error
- type FilePerTapSinkValidationError
- func (e FilePerTapSinkValidationError) Cause() error
- func (e FilePerTapSinkValidationError) Error() string
- func (e FilePerTapSinkValidationError) ErrorName() string
- func (e FilePerTapSinkValidationError) Field() string
- func (e FilePerTapSinkValidationError) Key() bool
- func (e FilePerTapSinkValidationError) Reason() string
- type HttpGenericBodyMatch
- func (*HttpGenericBodyMatch) Descriptor() ([]byte, []int)deprecated
- func (x *HttpGenericBodyMatch) GetBytesLimit() uint32
- func (x *HttpGenericBodyMatch) GetPatterns() []*HttpGenericBodyMatch_GenericTextMatch
- func (*HttpGenericBodyMatch) ProtoMessage()
- func (x *HttpGenericBodyMatch) ProtoReflect() protoreflect.Message
- func (x *HttpGenericBodyMatch) Reset()
- func (x *HttpGenericBodyMatch) String() string
- func (m *HttpGenericBodyMatch) Validate() error
- type HttpGenericBodyMatchValidationError
- func (e HttpGenericBodyMatchValidationError) Cause() error
- func (e HttpGenericBodyMatchValidationError) Error() string
- func (e HttpGenericBodyMatchValidationError) ErrorName() string
- func (e HttpGenericBodyMatchValidationError) Field() string
- func (e HttpGenericBodyMatchValidationError) Key() bool
- func (e HttpGenericBodyMatchValidationError) Reason() string
- type HttpGenericBodyMatch_GenericTextMatch
- func (*HttpGenericBodyMatch_GenericTextMatch) Descriptor() ([]byte, []int)deprecated
- func (x *HttpGenericBodyMatch_GenericTextMatch) GetBinaryMatch() []byte
- func (m *HttpGenericBodyMatch_GenericTextMatch) GetRule() isHttpGenericBodyMatch_GenericTextMatch_Rule
- func (x *HttpGenericBodyMatch_GenericTextMatch) GetStringMatch() string
- func (*HttpGenericBodyMatch_GenericTextMatch) ProtoMessage()
- func (x *HttpGenericBodyMatch_GenericTextMatch) ProtoReflect() protoreflect.Message
- func (x *HttpGenericBodyMatch_GenericTextMatch) Reset()
- func (x *HttpGenericBodyMatch_GenericTextMatch) String() string
- func (m *HttpGenericBodyMatch_GenericTextMatch) Validate() error
- type HttpGenericBodyMatch_GenericTextMatchValidationError
- func (e HttpGenericBodyMatch_GenericTextMatchValidationError) Cause() error
- func (e HttpGenericBodyMatch_GenericTextMatchValidationError) Error() string
- func (e HttpGenericBodyMatch_GenericTextMatchValidationError) ErrorName() string
- func (e HttpGenericBodyMatch_GenericTextMatchValidationError) Field() string
- func (e HttpGenericBodyMatch_GenericTextMatchValidationError) Key() bool
- func (e HttpGenericBodyMatch_GenericTextMatchValidationError) Reason() string
- type HttpGenericBodyMatch_GenericTextMatch_BinaryMatch
- type HttpGenericBodyMatch_GenericTextMatch_StringMatch
- type HttpHeadersMatch
- func (*HttpHeadersMatch) Descriptor() ([]byte, []int)deprecated
- func (x *HttpHeadersMatch) GetHeaders() []*v4alpha2.HeaderMatcher
- func (*HttpHeadersMatch) ProtoMessage()
- func (x *HttpHeadersMatch) ProtoReflect() protoreflect.Message
- func (x *HttpHeadersMatch) Reset()
- func (x *HttpHeadersMatch) String() string
- func (m *HttpHeadersMatch) Validate() error
- type HttpHeadersMatchValidationError
- func (e HttpHeadersMatchValidationError) Cause() error
- func (e HttpHeadersMatchValidationError) Error() string
- func (e HttpHeadersMatchValidationError) ErrorName() string
- func (e HttpHeadersMatchValidationError) Field() string
- func (e HttpHeadersMatchValidationError) Key() bool
- func (e HttpHeadersMatchValidationError) Reason() string
- type MatchPredicate
- func (*MatchPredicate) Descriptor() ([]byte, []int)deprecated
- func (x *MatchPredicate) GetAndMatch() *MatchPredicate_MatchSet
- func (x *MatchPredicate) GetAnyMatch() bool
- func (x *MatchPredicate) GetHttpRequestGenericBodyMatch() *HttpGenericBodyMatch
- func (x *MatchPredicate) GetHttpRequestHeadersMatch() *HttpHeadersMatch
- func (x *MatchPredicate) GetHttpRequestTrailersMatch() *HttpHeadersMatch
- func (x *MatchPredicate) GetHttpResponseGenericBodyMatch() *HttpGenericBodyMatch
- func (x *MatchPredicate) GetHttpResponseHeadersMatch() *HttpHeadersMatch
- func (x *MatchPredicate) GetHttpResponseTrailersMatch() *HttpHeadersMatch
- func (x *MatchPredicate) GetNotMatch() *MatchPredicate
- func (x *MatchPredicate) GetOrMatch() *MatchPredicate_MatchSet
- func (m *MatchPredicate) GetRule() isMatchPredicate_Rule
- func (*MatchPredicate) ProtoMessage()
- func (x *MatchPredicate) ProtoReflect() protoreflect.Message
- func (x *MatchPredicate) Reset()
- func (x *MatchPredicate) String() string
- func (m *MatchPredicate) Validate() error
- type MatchPredicateValidationError
- func (e MatchPredicateValidationError) Cause() error
- func (e MatchPredicateValidationError) Error() string
- func (e MatchPredicateValidationError) ErrorName() string
- func (e MatchPredicateValidationError) Field() string
- func (e MatchPredicateValidationError) Key() bool
- func (e MatchPredicateValidationError) Reason() string
- type MatchPredicate_AndMatch
- type MatchPredicate_AnyMatch
- type MatchPredicate_HttpRequestGenericBodyMatch
- type MatchPredicate_HttpRequestHeadersMatch
- type MatchPredicate_HttpRequestTrailersMatch
- type MatchPredicate_HttpResponseGenericBodyMatch
- type MatchPredicate_HttpResponseHeadersMatch
- type MatchPredicate_HttpResponseTrailersMatch
- type MatchPredicate_MatchSet
- func (*MatchPredicate_MatchSet) Descriptor() ([]byte, []int)deprecated
- func (x *MatchPredicate_MatchSet) GetRules() []*MatchPredicate
- func (*MatchPredicate_MatchSet) ProtoMessage()
- func (x *MatchPredicate_MatchSet) ProtoReflect() protoreflect.Message
- func (x *MatchPredicate_MatchSet) Reset()
- func (x *MatchPredicate_MatchSet) String() string
- func (m *MatchPredicate_MatchSet) Validate() error
- type MatchPredicate_MatchSetValidationError
- func (e MatchPredicate_MatchSetValidationError) Cause() error
- func (e MatchPredicate_MatchSetValidationError) Error() string
- func (e MatchPredicate_MatchSetValidationError) ErrorName() string
- func (e MatchPredicate_MatchSetValidationError) Field() string
- func (e MatchPredicate_MatchSetValidationError) Key() bool
- func (e MatchPredicate_MatchSetValidationError) Reason() string
- type MatchPredicate_NotMatch
- type MatchPredicate_OrMatch
- type OutputConfig
- func (*OutputConfig) Descriptor() ([]byte, []int)deprecated
- func (x *OutputConfig) GetMaxBufferedRxBytes() *wrappers.UInt32Value
- func (x *OutputConfig) GetMaxBufferedTxBytes() *wrappers.UInt32Value
- func (x *OutputConfig) GetSinks() []*OutputSink
- func (x *OutputConfig) GetStreaming() bool
- func (*OutputConfig) ProtoMessage()
- func (x *OutputConfig) ProtoReflect() protoreflect.Message
- func (x *OutputConfig) Reset()
- func (x *OutputConfig) String() string
- func (m *OutputConfig) Validate() error
- type OutputConfigValidationError
- func (e OutputConfigValidationError) Cause() error
- func (e OutputConfigValidationError) Error() string
- func (e OutputConfigValidationError) ErrorName() string
- func (e OutputConfigValidationError) Field() string
- func (e OutputConfigValidationError) Key() bool
- func (e OutputConfigValidationError) Reason() string
- type OutputSink
- func (*OutputSink) Descriptor() ([]byte, []int)deprecated
- func (x *OutputSink) GetFilePerTap() *FilePerTapSink
- func (x *OutputSink) GetFormat() OutputSink_Format
- func (m *OutputSink) GetOutputSinkType() isOutputSink_OutputSinkType
- func (x *OutputSink) GetStreamingAdmin() *StreamingAdminSink
- func (x *OutputSink) GetStreamingGrpc() *StreamingGrpcSink
- func (*OutputSink) ProtoMessage()
- func (x *OutputSink) ProtoReflect() protoreflect.Message
- func (x *OutputSink) Reset()
- func (x *OutputSink) String() string
- func (m *OutputSink) Validate() error
- type OutputSinkValidationError
- type OutputSink_FilePerTap
- type OutputSink_Format
- func (OutputSink_Format) Descriptor() protoreflect.EnumDescriptor
- func (x OutputSink_Format) Enum() *OutputSink_Format
- func (OutputSink_Format) EnumDescriptor() ([]byte, []int)deprecated
- func (x OutputSink_Format) Number() protoreflect.EnumNumber
- func (x OutputSink_Format) String() string
- func (OutputSink_Format) Type() protoreflect.EnumType
- type OutputSink_StreamingAdmin
- type OutputSink_StreamingGrpc
- type StreamingAdminSink
- func (*StreamingAdminSink) Descriptor() ([]byte, []int)deprecated
- func (*StreamingAdminSink) ProtoMessage()
- func (x *StreamingAdminSink) ProtoReflect() protoreflect.Message
- func (x *StreamingAdminSink) Reset()
- func (x *StreamingAdminSink) String() string
- func (m *StreamingAdminSink) Validate() error
- type StreamingAdminSinkValidationError
- func (e StreamingAdminSinkValidationError) Cause() error
- func (e StreamingAdminSinkValidationError) Error() string
- func (e StreamingAdminSinkValidationError) ErrorName() string
- func (e StreamingAdminSinkValidationError) Field() string
- func (e StreamingAdminSinkValidationError) Key() bool
- func (e StreamingAdminSinkValidationError) Reason() string
- type StreamingGrpcSink
- func (*StreamingGrpcSink) Descriptor() ([]byte, []int)deprecated
- func (x *StreamingGrpcSink) GetGrpcService() *v4alpha1.GrpcService
- func (x *StreamingGrpcSink) GetTapId() string
- func (*StreamingGrpcSink) ProtoMessage()
- func (x *StreamingGrpcSink) ProtoReflect() protoreflect.Message
- func (x *StreamingGrpcSink) Reset()
- func (x *StreamingGrpcSink) String() string
- func (m *StreamingGrpcSink) Validate() error
- type StreamingGrpcSinkValidationError
- func (e StreamingGrpcSinkValidationError) Cause() error
- func (e StreamingGrpcSinkValidationError) Error() string
- func (e StreamingGrpcSinkValidationError) ErrorName() string
- func (e StreamingGrpcSinkValidationError) Field() string
- func (e StreamingGrpcSinkValidationError) Key() bool
- func (e StreamingGrpcSinkValidationError) Reason() string
- type TapConfig
- func (*TapConfig) Descriptor() ([]byte, []int)deprecated
- func (x *TapConfig) GetHiddenEnvoyDeprecatedMatchConfig() *MatchPredicatedeprecated
- func (x *TapConfig) GetMatch() *v4alpha.MatchPredicate
- func (x *TapConfig) GetOutputConfig() *OutputConfig
- func (x *TapConfig) GetTapEnabled() *v4alpha1.RuntimeFractionalPercent
- func (*TapConfig) ProtoMessage()
- func (x *TapConfig) ProtoReflect() protoreflect.Message
- func (x *TapConfig) Reset()
- func (x *TapConfig) String() string
- func (m *TapConfig) Validate() error
- type TapConfigValidationError
Constants ¶
This section is empty.
Variables ¶
var ( OutputSink_Format_name = map[int32]string{ 0: "JSON_BODY_AS_BYTES", 1: "JSON_BODY_AS_STRING", 2: "PROTO_BINARY", 3: "PROTO_BINARY_LENGTH_DELIMITED", 4: "PROTO_TEXT", } OutputSink_Format_value = map[string]int32{ "JSON_BODY_AS_BYTES": 0, "JSON_BODY_AS_STRING": 1, "PROTO_BINARY": 2, "PROTO_BINARY_LENGTH_DELIMITED": 3, "PROTO_TEXT": 4, } )
Enum value maps for OutputSink_Format.
var File_envoy_config_tap_v4alpha_common_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type FilePerTapSink ¶
type FilePerTapSink struct { PathPrefix string `protobuf:"bytes,1,opt,name=path_prefix,json=pathPrefix,proto3" json:"path_prefix,omitempty"` // contains filtered or unexported fields }
func (*FilePerTapSink) Descriptor
deprecated
func (*FilePerTapSink) Descriptor() ([]byte, []int)
Deprecated: Use FilePerTapSink.ProtoReflect.Descriptor instead.
func (*FilePerTapSink) GetPathPrefix ¶
func (x *FilePerTapSink) GetPathPrefix() string
func (*FilePerTapSink) ProtoMessage ¶
func (*FilePerTapSink) ProtoMessage()
func (*FilePerTapSink) ProtoReflect ¶
func (x *FilePerTapSink) ProtoReflect() protoreflect.Message
func (*FilePerTapSink) Reset ¶
func (x *FilePerTapSink) Reset()
func (*FilePerTapSink) String ¶
func (x *FilePerTapSink) String() string
func (*FilePerTapSink) Validate ¶
func (m *FilePerTapSink) Validate() error
Validate checks the field values on FilePerTapSink with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type FilePerTapSinkValidationError ¶
type FilePerTapSinkValidationError struct {
// contains filtered or unexported fields
}
FilePerTapSinkValidationError is the validation error returned by FilePerTapSink.Validate if the designated constraints aren't met.
func (FilePerTapSinkValidationError) Cause ¶
func (e FilePerTapSinkValidationError) Cause() error
Cause function returns cause value.
func (FilePerTapSinkValidationError) Error ¶
func (e FilePerTapSinkValidationError) Error() string
Error satisfies the builtin error interface
func (FilePerTapSinkValidationError) ErrorName ¶
func (e FilePerTapSinkValidationError) ErrorName() string
ErrorName returns error name.
func (FilePerTapSinkValidationError) Field ¶
func (e FilePerTapSinkValidationError) Field() string
Field function returns field value.
func (FilePerTapSinkValidationError) Key ¶
func (e FilePerTapSinkValidationError) Key() bool
Key function returns key value.
func (FilePerTapSinkValidationError) Reason ¶
func (e FilePerTapSinkValidationError) Reason() string
Reason function returns reason value.
type HttpGenericBodyMatch ¶
type HttpGenericBodyMatch struct { BytesLimit uint32 `protobuf:"varint,1,opt,name=bytes_limit,json=bytesLimit,proto3" json:"bytes_limit,omitempty"` Patterns []*HttpGenericBodyMatch_GenericTextMatch `protobuf:"bytes,2,rep,name=patterns,proto3" json:"patterns,omitempty"` // contains filtered or unexported fields }
func (*HttpGenericBodyMatch) Descriptor
deprecated
func (*HttpGenericBodyMatch) Descriptor() ([]byte, []int)
Deprecated: Use HttpGenericBodyMatch.ProtoReflect.Descriptor instead.
func (*HttpGenericBodyMatch) GetBytesLimit ¶
func (x *HttpGenericBodyMatch) GetBytesLimit() uint32
func (*HttpGenericBodyMatch) GetPatterns ¶
func (x *HttpGenericBodyMatch) GetPatterns() []*HttpGenericBodyMatch_GenericTextMatch
func (*HttpGenericBodyMatch) ProtoMessage ¶
func (*HttpGenericBodyMatch) ProtoMessage()
func (*HttpGenericBodyMatch) ProtoReflect ¶
func (x *HttpGenericBodyMatch) ProtoReflect() protoreflect.Message
func (*HttpGenericBodyMatch) Reset ¶
func (x *HttpGenericBodyMatch) Reset()
func (*HttpGenericBodyMatch) String ¶
func (x *HttpGenericBodyMatch) String() string
func (*HttpGenericBodyMatch) Validate ¶
func (m *HttpGenericBodyMatch) Validate() error
Validate checks the field values on HttpGenericBodyMatch with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type HttpGenericBodyMatchValidationError ¶
type HttpGenericBodyMatchValidationError struct {
// contains filtered or unexported fields
}
HttpGenericBodyMatchValidationError is the validation error returned by HttpGenericBodyMatch.Validate if the designated constraints aren't met.
func (HttpGenericBodyMatchValidationError) Cause ¶
func (e HttpGenericBodyMatchValidationError) Cause() error
Cause function returns cause value.
func (HttpGenericBodyMatchValidationError) Error ¶
func (e HttpGenericBodyMatchValidationError) Error() string
Error satisfies the builtin error interface
func (HttpGenericBodyMatchValidationError) ErrorName ¶
func (e HttpGenericBodyMatchValidationError) ErrorName() string
ErrorName returns error name.
func (HttpGenericBodyMatchValidationError) Field ¶
func (e HttpGenericBodyMatchValidationError) Field() string
Field function returns field value.
func (HttpGenericBodyMatchValidationError) Key ¶
func (e HttpGenericBodyMatchValidationError) Key() bool
Key function returns key value.
func (HttpGenericBodyMatchValidationError) Reason ¶
func (e HttpGenericBodyMatchValidationError) Reason() string
Reason function returns reason value.
type HttpGenericBodyMatch_GenericTextMatch ¶
type HttpGenericBodyMatch_GenericTextMatch struct { // Types that are assignable to Rule: // *HttpGenericBodyMatch_GenericTextMatch_StringMatch // *HttpGenericBodyMatch_GenericTextMatch_BinaryMatch Rule isHttpGenericBodyMatch_GenericTextMatch_Rule `protobuf_oneof:"rule"` // contains filtered or unexported fields }
func (*HttpGenericBodyMatch_GenericTextMatch) Descriptor
deprecated
func (*HttpGenericBodyMatch_GenericTextMatch) Descriptor() ([]byte, []int)
Deprecated: Use HttpGenericBodyMatch_GenericTextMatch.ProtoReflect.Descriptor instead.
func (*HttpGenericBodyMatch_GenericTextMatch) GetBinaryMatch ¶
func (x *HttpGenericBodyMatch_GenericTextMatch) GetBinaryMatch() []byte
func (*HttpGenericBodyMatch_GenericTextMatch) GetRule ¶
func (m *HttpGenericBodyMatch_GenericTextMatch) GetRule() isHttpGenericBodyMatch_GenericTextMatch_Rule
func (*HttpGenericBodyMatch_GenericTextMatch) GetStringMatch ¶
func (x *HttpGenericBodyMatch_GenericTextMatch) GetStringMatch() string
func (*HttpGenericBodyMatch_GenericTextMatch) ProtoMessage ¶
func (*HttpGenericBodyMatch_GenericTextMatch) ProtoMessage()
func (*HttpGenericBodyMatch_GenericTextMatch) ProtoReflect ¶
func (x *HttpGenericBodyMatch_GenericTextMatch) ProtoReflect() protoreflect.Message
func (*HttpGenericBodyMatch_GenericTextMatch) Reset ¶
func (x *HttpGenericBodyMatch_GenericTextMatch) Reset()
func (*HttpGenericBodyMatch_GenericTextMatch) String ¶
func (x *HttpGenericBodyMatch_GenericTextMatch) String() string
func (*HttpGenericBodyMatch_GenericTextMatch) Validate ¶
func (m *HttpGenericBodyMatch_GenericTextMatch) Validate() error
Validate checks the field values on HttpGenericBodyMatch_GenericTextMatch with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type HttpGenericBodyMatch_GenericTextMatchValidationError ¶
type HttpGenericBodyMatch_GenericTextMatchValidationError struct {
// contains filtered or unexported fields
}
HttpGenericBodyMatch_GenericTextMatchValidationError is the validation error returned by HttpGenericBodyMatch_GenericTextMatch.Validate if the designated constraints aren't met.
func (HttpGenericBodyMatch_GenericTextMatchValidationError) Cause ¶
func (e HttpGenericBodyMatch_GenericTextMatchValidationError) Cause() error
Cause function returns cause value.
func (HttpGenericBodyMatch_GenericTextMatchValidationError) Error ¶
func (e HttpGenericBodyMatch_GenericTextMatchValidationError) Error() string
Error satisfies the builtin error interface
func (HttpGenericBodyMatch_GenericTextMatchValidationError) ErrorName ¶
func (e HttpGenericBodyMatch_GenericTextMatchValidationError) ErrorName() string
ErrorName returns error name.
func (HttpGenericBodyMatch_GenericTextMatchValidationError) Field ¶
func (e HttpGenericBodyMatch_GenericTextMatchValidationError) Field() string
Field function returns field value.
func (HttpGenericBodyMatch_GenericTextMatchValidationError) Key ¶
func (e HttpGenericBodyMatch_GenericTextMatchValidationError) Key() bool
Key function returns key value.
func (HttpGenericBodyMatch_GenericTextMatchValidationError) Reason ¶
func (e HttpGenericBodyMatch_GenericTextMatchValidationError) Reason() string
Reason function returns reason value.
type HttpGenericBodyMatch_GenericTextMatch_BinaryMatch ¶
type HttpGenericBodyMatch_GenericTextMatch_BinaryMatch struct {
BinaryMatch []byte `protobuf:"bytes,2,opt,name=binary_match,json=binaryMatch,proto3,oneof"`
}
type HttpGenericBodyMatch_GenericTextMatch_StringMatch ¶
type HttpGenericBodyMatch_GenericTextMatch_StringMatch struct {
StringMatch string `protobuf:"bytes,1,opt,name=string_match,json=stringMatch,proto3,oneof"`
}
type HttpHeadersMatch ¶
type HttpHeadersMatch struct { Headers []*v4alpha2.HeaderMatcher `protobuf:"bytes,1,rep,name=headers,proto3" json:"headers,omitempty"` // contains filtered or unexported fields }
func (*HttpHeadersMatch) Descriptor
deprecated
func (*HttpHeadersMatch) Descriptor() ([]byte, []int)
Deprecated: Use HttpHeadersMatch.ProtoReflect.Descriptor instead.
func (*HttpHeadersMatch) GetHeaders ¶
func (x *HttpHeadersMatch) GetHeaders() []*v4alpha2.HeaderMatcher
func (*HttpHeadersMatch) ProtoMessage ¶
func (*HttpHeadersMatch) ProtoMessage()
func (*HttpHeadersMatch) ProtoReflect ¶
func (x *HttpHeadersMatch) ProtoReflect() protoreflect.Message
func (*HttpHeadersMatch) Reset ¶
func (x *HttpHeadersMatch) Reset()
func (*HttpHeadersMatch) String ¶
func (x *HttpHeadersMatch) String() string
func (*HttpHeadersMatch) Validate ¶
func (m *HttpHeadersMatch) Validate() error
Validate checks the field values on HttpHeadersMatch with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type HttpHeadersMatchValidationError ¶
type HttpHeadersMatchValidationError struct {
// contains filtered or unexported fields
}
HttpHeadersMatchValidationError is the validation error returned by HttpHeadersMatch.Validate if the designated constraints aren't met.
func (HttpHeadersMatchValidationError) Cause ¶
func (e HttpHeadersMatchValidationError) Cause() error
Cause function returns cause value.
func (HttpHeadersMatchValidationError) Error ¶
func (e HttpHeadersMatchValidationError) Error() string
Error satisfies the builtin error interface
func (HttpHeadersMatchValidationError) ErrorName ¶
func (e HttpHeadersMatchValidationError) ErrorName() string
ErrorName returns error name.
func (HttpHeadersMatchValidationError) Field ¶
func (e HttpHeadersMatchValidationError) Field() string
Field function returns field value.
func (HttpHeadersMatchValidationError) Key ¶
func (e HttpHeadersMatchValidationError) Key() bool
Key function returns key value.
func (HttpHeadersMatchValidationError) Reason ¶
func (e HttpHeadersMatchValidationError) Reason() string
Reason function returns reason value.
type MatchPredicate ¶
type MatchPredicate struct { // Types that are assignable to Rule: // *MatchPredicate_OrMatch // *MatchPredicate_AndMatch // *MatchPredicate_NotMatch // *MatchPredicate_AnyMatch // *MatchPredicate_HttpRequestHeadersMatch // *MatchPredicate_HttpRequestTrailersMatch // *MatchPredicate_HttpResponseHeadersMatch // *MatchPredicate_HttpResponseTrailersMatch // *MatchPredicate_HttpRequestGenericBodyMatch // *MatchPredicate_HttpResponseGenericBodyMatch Rule isMatchPredicate_Rule `protobuf_oneof:"rule"` // contains filtered or unexported fields }
func (*MatchPredicate) Descriptor
deprecated
func (*MatchPredicate) Descriptor() ([]byte, []int)
Deprecated: Use MatchPredicate.ProtoReflect.Descriptor instead.
func (*MatchPredicate) GetAndMatch ¶
func (x *MatchPredicate) GetAndMatch() *MatchPredicate_MatchSet
func (*MatchPredicate) GetAnyMatch ¶
func (x *MatchPredicate) GetAnyMatch() bool
func (*MatchPredicate) GetHttpRequestGenericBodyMatch ¶
func (x *MatchPredicate) GetHttpRequestGenericBodyMatch() *HttpGenericBodyMatch
func (*MatchPredicate) GetHttpRequestHeadersMatch ¶
func (x *MatchPredicate) GetHttpRequestHeadersMatch() *HttpHeadersMatch
func (*MatchPredicate) GetHttpRequestTrailersMatch ¶
func (x *MatchPredicate) GetHttpRequestTrailersMatch() *HttpHeadersMatch
func (*MatchPredicate) GetHttpResponseGenericBodyMatch ¶
func (x *MatchPredicate) GetHttpResponseGenericBodyMatch() *HttpGenericBodyMatch
func (*MatchPredicate) GetHttpResponseHeadersMatch ¶
func (x *MatchPredicate) GetHttpResponseHeadersMatch() *HttpHeadersMatch
func (*MatchPredicate) GetHttpResponseTrailersMatch ¶
func (x *MatchPredicate) GetHttpResponseTrailersMatch() *HttpHeadersMatch
func (*MatchPredicate) GetNotMatch ¶
func (x *MatchPredicate) GetNotMatch() *MatchPredicate
func (*MatchPredicate) GetOrMatch ¶
func (x *MatchPredicate) GetOrMatch() *MatchPredicate_MatchSet
func (*MatchPredicate) GetRule ¶
func (m *MatchPredicate) GetRule() isMatchPredicate_Rule
func (*MatchPredicate) ProtoMessage ¶
func (*MatchPredicate) ProtoMessage()
func (*MatchPredicate) ProtoReflect ¶
func (x *MatchPredicate) ProtoReflect() protoreflect.Message
func (*MatchPredicate) Reset ¶
func (x *MatchPredicate) Reset()
func (*MatchPredicate) String ¶
func (x *MatchPredicate) String() string
func (*MatchPredicate) Validate ¶
func (m *MatchPredicate) Validate() error
Validate checks the field values on MatchPredicate with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type MatchPredicateValidationError ¶
type MatchPredicateValidationError struct {
// contains filtered or unexported fields
}
MatchPredicateValidationError is the validation error returned by MatchPredicate.Validate if the designated constraints aren't met.
func (MatchPredicateValidationError) Cause ¶
func (e MatchPredicateValidationError) Cause() error
Cause function returns cause value.
func (MatchPredicateValidationError) Error ¶
func (e MatchPredicateValidationError) Error() string
Error satisfies the builtin error interface
func (MatchPredicateValidationError) ErrorName ¶
func (e MatchPredicateValidationError) ErrorName() string
ErrorName returns error name.
func (MatchPredicateValidationError) Field ¶
func (e MatchPredicateValidationError) Field() string
Field function returns field value.
func (MatchPredicateValidationError) Key ¶
func (e MatchPredicateValidationError) Key() bool
Key function returns key value.
func (MatchPredicateValidationError) Reason ¶
func (e MatchPredicateValidationError) Reason() string
Reason function returns reason value.
type MatchPredicate_AndMatch ¶
type MatchPredicate_AndMatch struct {
AndMatch *MatchPredicate_MatchSet `protobuf:"bytes,2,opt,name=and_match,json=andMatch,proto3,oneof"`
}
type MatchPredicate_AnyMatch ¶
type MatchPredicate_AnyMatch struct {
AnyMatch bool `protobuf:"varint,4,opt,name=any_match,json=anyMatch,proto3,oneof"`
}
type MatchPredicate_HttpRequestGenericBodyMatch ¶
type MatchPredicate_HttpRequestGenericBodyMatch struct {
HttpRequestGenericBodyMatch *HttpGenericBodyMatch `protobuf:"bytes,9,opt,name=http_request_generic_body_match,json=httpRequestGenericBodyMatch,proto3,oneof"`
}
type MatchPredicate_HttpRequestHeadersMatch ¶
type MatchPredicate_HttpRequestHeadersMatch struct {
HttpRequestHeadersMatch *HttpHeadersMatch `protobuf:"bytes,5,opt,name=http_request_headers_match,json=httpRequestHeadersMatch,proto3,oneof"`
}
type MatchPredicate_HttpRequestTrailersMatch ¶
type MatchPredicate_HttpRequestTrailersMatch struct {
HttpRequestTrailersMatch *HttpHeadersMatch `protobuf:"bytes,6,opt,name=http_request_trailers_match,json=httpRequestTrailersMatch,proto3,oneof"`
}
type MatchPredicate_HttpResponseGenericBodyMatch ¶
type MatchPredicate_HttpResponseGenericBodyMatch struct {
HttpResponseGenericBodyMatch *HttpGenericBodyMatch `protobuf:"bytes,10,opt,name=http_response_generic_body_match,json=httpResponseGenericBodyMatch,proto3,oneof"`
}
type MatchPredicate_HttpResponseHeadersMatch ¶
type MatchPredicate_HttpResponseHeadersMatch struct {
HttpResponseHeadersMatch *HttpHeadersMatch `protobuf:"bytes,7,opt,name=http_response_headers_match,json=httpResponseHeadersMatch,proto3,oneof"`
}
type MatchPredicate_HttpResponseTrailersMatch ¶
type MatchPredicate_HttpResponseTrailersMatch struct {
HttpResponseTrailersMatch *HttpHeadersMatch `protobuf:"bytes,8,opt,name=http_response_trailers_match,json=httpResponseTrailersMatch,proto3,oneof"`
}
type MatchPredicate_MatchSet ¶
type MatchPredicate_MatchSet struct { Rules []*MatchPredicate `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"` // contains filtered or unexported fields }
func (*MatchPredicate_MatchSet) Descriptor
deprecated
func (*MatchPredicate_MatchSet) Descriptor() ([]byte, []int)
Deprecated: Use MatchPredicate_MatchSet.ProtoReflect.Descriptor instead.
func (*MatchPredicate_MatchSet) GetRules ¶
func (x *MatchPredicate_MatchSet) GetRules() []*MatchPredicate
func (*MatchPredicate_MatchSet) ProtoMessage ¶
func (*MatchPredicate_MatchSet) ProtoMessage()
func (*MatchPredicate_MatchSet) ProtoReflect ¶
func (x *MatchPredicate_MatchSet) ProtoReflect() protoreflect.Message
func (*MatchPredicate_MatchSet) Reset ¶
func (x *MatchPredicate_MatchSet) Reset()
func (*MatchPredicate_MatchSet) String ¶
func (x *MatchPredicate_MatchSet) String() string
func (*MatchPredicate_MatchSet) Validate ¶
func (m *MatchPredicate_MatchSet) Validate() error
Validate checks the field values on MatchPredicate_MatchSet with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type MatchPredicate_MatchSetValidationError ¶
type MatchPredicate_MatchSetValidationError struct {
// contains filtered or unexported fields
}
MatchPredicate_MatchSetValidationError is the validation error returned by MatchPredicate_MatchSet.Validate if the designated constraints aren't met.
func (MatchPredicate_MatchSetValidationError) Cause ¶
func (e MatchPredicate_MatchSetValidationError) Cause() error
Cause function returns cause value.
func (MatchPredicate_MatchSetValidationError) Error ¶
func (e MatchPredicate_MatchSetValidationError) Error() string
Error satisfies the builtin error interface
func (MatchPredicate_MatchSetValidationError) ErrorName ¶
func (e MatchPredicate_MatchSetValidationError) ErrorName() string
ErrorName returns error name.
func (MatchPredicate_MatchSetValidationError) Field ¶
func (e MatchPredicate_MatchSetValidationError) Field() string
Field function returns field value.
func (MatchPredicate_MatchSetValidationError) Key ¶
func (e MatchPredicate_MatchSetValidationError) Key() bool
Key function returns key value.
func (MatchPredicate_MatchSetValidationError) Reason ¶
func (e MatchPredicate_MatchSetValidationError) Reason() string
Reason function returns reason value.
type MatchPredicate_NotMatch ¶
type MatchPredicate_NotMatch struct {
NotMatch *MatchPredicate `protobuf:"bytes,3,opt,name=not_match,json=notMatch,proto3,oneof"`
}
type MatchPredicate_OrMatch ¶
type MatchPredicate_OrMatch struct {
OrMatch *MatchPredicate_MatchSet `protobuf:"bytes,1,opt,name=or_match,json=orMatch,proto3,oneof"`
}
type OutputConfig ¶
type OutputConfig struct { Sinks []*OutputSink `protobuf:"bytes,1,rep,name=sinks,proto3" json:"sinks,omitempty"` MaxBufferedRxBytes *wrappers.UInt32Value `protobuf:"bytes,2,opt,name=max_buffered_rx_bytes,json=maxBufferedRxBytes,proto3" json:"max_buffered_rx_bytes,omitempty"` MaxBufferedTxBytes *wrappers.UInt32Value `protobuf:"bytes,3,opt,name=max_buffered_tx_bytes,json=maxBufferedTxBytes,proto3" json:"max_buffered_tx_bytes,omitempty"` Streaming bool `protobuf:"varint,4,opt,name=streaming,proto3" json:"streaming,omitempty"` // contains filtered or unexported fields }
func (*OutputConfig) Descriptor
deprecated
func (*OutputConfig) Descriptor() ([]byte, []int)
Deprecated: Use OutputConfig.ProtoReflect.Descriptor instead.
func (*OutputConfig) GetMaxBufferedRxBytes ¶
func (x *OutputConfig) GetMaxBufferedRxBytes() *wrappers.UInt32Value
func (*OutputConfig) GetMaxBufferedTxBytes ¶
func (x *OutputConfig) GetMaxBufferedTxBytes() *wrappers.UInt32Value
func (*OutputConfig) GetSinks ¶
func (x *OutputConfig) GetSinks() []*OutputSink
func (*OutputConfig) GetStreaming ¶
func (x *OutputConfig) GetStreaming() bool
func (*OutputConfig) ProtoMessage ¶
func (*OutputConfig) ProtoMessage()
func (*OutputConfig) ProtoReflect ¶
func (x *OutputConfig) ProtoReflect() protoreflect.Message
func (*OutputConfig) Reset ¶
func (x *OutputConfig) Reset()
func (*OutputConfig) String ¶
func (x *OutputConfig) String() string
func (*OutputConfig) Validate ¶
func (m *OutputConfig) Validate() error
Validate checks the field values on OutputConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type OutputConfigValidationError ¶
type OutputConfigValidationError struct {
// contains filtered or unexported fields
}
OutputConfigValidationError is the validation error returned by OutputConfig.Validate if the designated constraints aren't met.
func (OutputConfigValidationError) Cause ¶
func (e OutputConfigValidationError) Cause() error
Cause function returns cause value.
func (OutputConfigValidationError) Error ¶
func (e OutputConfigValidationError) Error() string
Error satisfies the builtin error interface
func (OutputConfigValidationError) ErrorName ¶
func (e OutputConfigValidationError) ErrorName() string
ErrorName returns error name.
func (OutputConfigValidationError) Field ¶
func (e OutputConfigValidationError) Field() string
Field function returns field value.
func (OutputConfigValidationError) Key ¶
func (e OutputConfigValidationError) Key() bool
Key function returns key value.
func (OutputConfigValidationError) Reason ¶
func (e OutputConfigValidationError) Reason() string
Reason function returns reason value.
type OutputSink ¶
type OutputSink struct { Format OutputSink_Format `protobuf:"varint,1,opt,name=format,proto3,enum=envoy.config.tap.v4alpha.OutputSink_Format" json:"format,omitempty"` // Types that are assignable to OutputSinkType: // *OutputSink_StreamingAdmin // *OutputSink_FilePerTap // *OutputSink_StreamingGrpc OutputSinkType isOutputSink_OutputSinkType `protobuf_oneof:"output_sink_type"` // contains filtered or unexported fields }
func (*OutputSink) Descriptor
deprecated
func (*OutputSink) Descriptor() ([]byte, []int)
Deprecated: Use OutputSink.ProtoReflect.Descriptor instead.
func (*OutputSink) GetFilePerTap ¶
func (x *OutputSink) GetFilePerTap() *FilePerTapSink
func (*OutputSink) GetFormat ¶
func (x *OutputSink) GetFormat() OutputSink_Format
func (*OutputSink) GetOutputSinkType ¶
func (m *OutputSink) GetOutputSinkType() isOutputSink_OutputSinkType
func (*OutputSink) GetStreamingAdmin ¶
func (x *OutputSink) GetStreamingAdmin() *StreamingAdminSink
func (*OutputSink) GetStreamingGrpc ¶
func (x *OutputSink) GetStreamingGrpc() *StreamingGrpcSink
func (*OutputSink) ProtoMessage ¶
func (*OutputSink) ProtoMessage()
func (*OutputSink) ProtoReflect ¶
func (x *OutputSink) ProtoReflect() protoreflect.Message
func (*OutputSink) Reset ¶
func (x *OutputSink) Reset()
func (*OutputSink) String ¶
func (x *OutputSink) String() string
func (*OutputSink) Validate ¶
func (m *OutputSink) Validate() error
Validate checks the field values on OutputSink with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type OutputSinkValidationError ¶
type OutputSinkValidationError struct {
// contains filtered or unexported fields
}
OutputSinkValidationError is the validation error returned by OutputSink.Validate if the designated constraints aren't met.
func (OutputSinkValidationError) Cause ¶
func (e OutputSinkValidationError) Cause() error
Cause function returns cause value.
func (OutputSinkValidationError) Error ¶
func (e OutputSinkValidationError) Error() string
Error satisfies the builtin error interface
func (OutputSinkValidationError) ErrorName ¶
func (e OutputSinkValidationError) ErrorName() string
ErrorName returns error name.
func (OutputSinkValidationError) Field ¶
func (e OutputSinkValidationError) Field() string
Field function returns field value.
func (OutputSinkValidationError) Key ¶
func (e OutputSinkValidationError) Key() bool
Key function returns key value.
func (OutputSinkValidationError) Reason ¶
func (e OutputSinkValidationError) Reason() string
Reason function returns reason value.
type OutputSink_FilePerTap ¶
type OutputSink_FilePerTap struct {
FilePerTap *FilePerTapSink `protobuf:"bytes,3,opt,name=file_per_tap,json=filePerTap,proto3,oneof"`
}
type OutputSink_Format ¶
type OutputSink_Format int32
const ( OutputSink_JSON_BODY_AS_BYTES OutputSink_Format = 0 OutputSink_JSON_BODY_AS_STRING OutputSink_Format = 1 OutputSink_PROTO_BINARY OutputSink_Format = 2 OutputSink_PROTO_BINARY_LENGTH_DELIMITED OutputSink_Format = 3 OutputSink_PROTO_TEXT OutputSink_Format = 4 )
func (OutputSink_Format) Descriptor ¶
func (OutputSink_Format) Descriptor() protoreflect.EnumDescriptor
func (OutputSink_Format) Enum ¶
func (x OutputSink_Format) Enum() *OutputSink_Format
func (OutputSink_Format) EnumDescriptor
deprecated
func (OutputSink_Format) EnumDescriptor() ([]byte, []int)
Deprecated: Use OutputSink_Format.Descriptor instead.
func (OutputSink_Format) Number ¶
func (x OutputSink_Format) Number() protoreflect.EnumNumber
func (OutputSink_Format) String ¶
func (x OutputSink_Format) String() string
func (OutputSink_Format) Type ¶
func (OutputSink_Format) Type() protoreflect.EnumType
type OutputSink_StreamingAdmin ¶
type OutputSink_StreamingAdmin struct {
StreamingAdmin *StreamingAdminSink `protobuf:"bytes,2,opt,name=streaming_admin,json=streamingAdmin,proto3,oneof"`
}
type OutputSink_StreamingGrpc ¶
type OutputSink_StreamingGrpc struct {
StreamingGrpc *StreamingGrpcSink `protobuf:"bytes,4,opt,name=streaming_grpc,json=streamingGrpc,proto3,oneof"`
}
type StreamingAdminSink ¶
type StreamingAdminSink struct {
// contains filtered or unexported fields
}
func (*StreamingAdminSink) Descriptor
deprecated
func (*StreamingAdminSink) Descriptor() ([]byte, []int)
Deprecated: Use StreamingAdminSink.ProtoReflect.Descriptor instead.
func (*StreamingAdminSink) ProtoMessage ¶
func (*StreamingAdminSink) ProtoMessage()
func (*StreamingAdminSink) ProtoReflect ¶
func (x *StreamingAdminSink) ProtoReflect() protoreflect.Message
func (*StreamingAdminSink) Reset ¶
func (x *StreamingAdminSink) Reset()
func (*StreamingAdminSink) String ¶
func (x *StreamingAdminSink) String() string
func (*StreamingAdminSink) Validate ¶
func (m *StreamingAdminSink) Validate() error
Validate checks the field values on StreamingAdminSink with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type StreamingAdminSinkValidationError ¶
type StreamingAdminSinkValidationError struct {
// contains filtered or unexported fields
}
StreamingAdminSinkValidationError is the validation error returned by StreamingAdminSink.Validate if the designated constraints aren't met.
func (StreamingAdminSinkValidationError) Cause ¶
func (e StreamingAdminSinkValidationError) Cause() error
Cause function returns cause value.
func (StreamingAdminSinkValidationError) Error ¶
func (e StreamingAdminSinkValidationError) Error() string
Error satisfies the builtin error interface
func (StreamingAdminSinkValidationError) ErrorName ¶
func (e StreamingAdminSinkValidationError) ErrorName() string
ErrorName returns error name.
func (StreamingAdminSinkValidationError) Field ¶
func (e StreamingAdminSinkValidationError) Field() string
Field function returns field value.
func (StreamingAdminSinkValidationError) Key ¶
func (e StreamingAdminSinkValidationError) Key() bool
Key function returns key value.
func (StreamingAdminSinkValidationError) Reason ¶
func (e StreamingAdminSinkValidationError) Reason() string
Reason function returns reason value.
type StreamingGrpcSink ¶
type StreamingGrpcSink struct { TapId string `protobuf:"bytes,1,opt,name=tap_id,json=tapId,proto3" json:"tap_id,omitempty"` GrpcService *v4alpha1.GrpcService `protobuf:"bytes,2,opt,name=grpc_service,json=grpcService,proto3" json:"grpc_service,omitempty"` // contains filtered or unexported fields }
func (*StreamingGrpcSink) Descriptor
deprecated
func (*StreamingGrpcSink) Descriptor() ([]byte, []int)
Deprecated: Use StreamingGrpcSink.ProtoReflect.Descriptor instead.
func (*StreamingGrpcSink) GetGrpcService ¶
func (x *StreamingGrpcSink) GetGrpcService() *v4alpha1.GrpcService
func (*StreamingGrpcSink) GetTapId ¶
func (x *StreamingGrpcSink) GetTapId() string
func (*StreamingGrpcSink) ProtoMessage ¶
func (*StreamingGrpcSink) ProtoMessage()
func (*StreamingGrpcSink) ProtoReflect ¶
func (x *StreamingGrpcSink) ProtoReflect() protoreflect.Message
func (*StreamingGrpcSink) Reset ¶
func (x *StreamingGrpcSink) Reset()
func (*StreamingGrpcSink) String ¶
func (x *StreamingGrpcSink) String() string
func (*StreamingGrpcSink) Validate ¶
func (m *StreamingGrpcSink) Validate() error
Validate checks the field values on StreamingGrpcSink with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type StreamingGrpcSinkValidationError ¶
type StreamingGrpcSinkValidationError struct {
// contains filtered or unexported fields
}
StreamingGrpcSinkValidationError is the validation error returned by StreamingGrpcSink.Validate if the designated constraints aren't met.
func (StreamingGrpcSinkValidationError) Cause ¶
func (e StreamingGrpcSinkValidationError) Cause() error
Cause function returns cause value.
func (StreamingGrpcSinkValidationError) Error ¶
func (e StreamingGrpcSinkValidationError) Error() string
Error satisfies the builtin error interface
func (StreamingGrpcSinkValidationError) ErrorName ¶
func (e StreamingGrpcSinkValidationError) ErrorName() string
ErrorName returns error name.
func (StreamingGrpcSinkValidationError) Field ¶
func (e StreamingGrpcSinkValidationError) Field() string
Field function returns field value.
func (StreamingGrpcSinkValidationError) Key ¶
func (e StreamingGrpcSinkValidationError) Key() bool
Key function returns key value.
func (StreamingGrpcSinkValidationError) Reason ¶
func (e StreamingGrpcSinkValidationError) Reason() string
Reason function returns reason value.
type TapConfig ¶
type TapConfig struct { // Deprecated: Do not use. HiddenEnvoyDeprecatedMatchConfig *MatchPredicate `` /* 163-byte string literal not displayed */ Match *v4alpha.MatchPredicate `protobuf:"bytes,4,opt,name=match,proto3" json:"match,omitempty"` OutputConfig *OutputConfig `protobuf:"bytes,2,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"` TapEnabled *v4alpha1.RuntimeFractionalPercent `protobuf:"bytes,3,opt,name=tap_enabled,json=tapEnabled,proto3" json:"tap_enabled,omitempty"` // contains filtered or unexported fields }
func (*TapConfig) Descriptor
deprecated
func (*TapConfig) GetHiddenEnvoyDeprecatedMatchConfig
deprecated
func (x *TapConfig) GetHiddenEnvoyDeprecatedMatchConfig() *MatchPredicate
Deprecated: Do not use.
func (*TapConfig) GetMatch ¶
func (x *TapConfig) GetMatch() *v4alpha.MatchPredicate
func (*TapConfig) GetOutputConfig ¶
func (x *TapConfig) GetOutputConfig() *OutputConfig
func (*TapConfig) GetTapEnabled ¶
func (x *TapConfig) GetTapEnabled() *v4alpha1.RuntimeFractionalPercent
func (*TapConfig) ProtoMessage ¶
func (*TapConfig) ProtoMessage()
func (*TapConfig) ProtoReflect ¶
func (x *TapConfig) ProtoReflect() protoreflect.Message
type TapConfigValidationError ¶
type TapConfigValidationError struct {
// contains filtered or unexported fields
}
TapConfigValidationError is the validation error returned by TapConfig.Validate if the designated constraints aren't met.
func (TapConfigValidationError) Cause ¶
func (e TapConfigValidationError) Cause() error
Cause function returns cause value.
func (TapConfigValidationError) Error ¶
func (e TapConfigValidationError) Error() string
Error satisfies the builtin error interface
func (TapConfigValidationError) ErrorName ¶
func (e TapConfigValidationError) ErrorName() string
ErrorName returns error name.
func (TapConfigValidationError) Field ¶
func (e TapConfigValidationError) Field() string
Field function returns field value.
func (TapConfigValidationError) Key ¶
func (e TapConfigValidationError) Key() bool
Key function returns key value.
func (TapConfigValidationError) Reason ¶
func (e TapConfigValidationError) Reason() string
Reason function returns reason value.