Version: v0.10.1 Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Nov 15, 2021 License: Apache-2.0 Imports: 21 Imported by: 4




This section is empty.


View Source
var File_envoy_config_filter_http_squash_v2_squash_proto protoreflect.FileDescriptor


This section is empty.


type Squash

type Squash struct {

	// The name of the cluster that hosts the Squash server.
	Cluster string `protobuf:"bytes,1,opt,name=cluster,proto3" json:"cluster,omitempty"`
	// When the filter requests the Squash server to create a DebugAttachment, it will use this
	// structure as template for the body of the request. It can contain reference to environment
	// variables in the form of '{{ ENV_VAR_NAME }}'. These can be used to provide the Squash server
	// with more information to find the process to attach the debugger to. For example, in a
	// Istio/k8s environment, this will contain information on the pod:
	// .. code-block:: json
	//  {
	//    "spec": {
	//      "attachment": {
	//        "pod": "{{ POD_NAME }}",
	//        "namespace": "{{ POD_NAMESPACE }}"
	//      },
	//      "match_request": true
	//    }
	//  }
	// (where POD_NAME, POD_NAMESPACE are configured in the pod via the Downward API)
	AttachmentTemplate *_struct.Struct `protobuf:"bytes,2,opt,name=attachment_template,json=attachmentTemplate,proto3" json:"attachment_template,omitempty"`
	// The timeout for individual requests sent to the Squash cluster. Defaults to 1 second.
	RequestTimeout *duration.Duration `protobuf:"bytes,3,opt,name=request_timeout,json=requestTimeout,proto3" json:"request_timeout,omitempty"`
	// The total timeout Squash will delay a request and wait for it to be attached. Defaults to 60
	// seconds.
	AttachmentTimeout *duration.Duration `protobuf:"bytes,4,opt,name=attachment_timeout,json=attachmentTimeout,proto3" json:"attachment_timeout,omitempty"`
	// Amount of time to poll for the status of the attachment object in the Squash server
	// (to check if has been attached). Defaults to 1 second.
	AttachmentPollPeriod *duration.Duration `protobuf:"bytes,5,opt,name=attachment_poll_period,json=attachmentPollPeriod,proto3" json:"attachment_poll_period,omitempty"`
	// contains filtered or unexported fields

[#next-free-field: 6]

func (*Squash) Descriptor deprecated

func (*Squash) Descriptor() ([]byte, []int)

Deprecated: Use Squash.ProtoReflect.Descriptor instead.

func (*Squash) GetAttachmentPollPeriod

func (x *Squash) GetAttachmentPollPeriod() *duration.Duration

func (*Squash) GetAttachmentTemplate

func (x *Squash) GetAttachmentTemplate() *_struct.Struct

func (*Squash) GetAttachmentTimeout

func (x *Squash) GetAttachmentTimeout() *duration.Duration

func (*Squash) GetCluster

func (x *Squash) GetCluster() string

func (*Squash) GetRequestTimeout

func (x *Squash) GetRequestTimeout() *duration.Duration

func (*Squash) ProtoMessage

func (*Squash) ProtoMessage()

func (*Squash) ProtoReflect added in v0.9.6

func (x *Squash) ProtoReflect() protoreflect.Message

func (*Squash) Reset

func (x *Squash) Reset()

func (*Squash) String

func (x *Squash) String() string

func (*Squash) Validate

func (m *Squash) Validate() error

Validate checks the field values on Squash 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 (*Squash) ValidateAll added in v0.10.0

func (m *Squash) ValidateAll() error

ValidateAll checks the field values on Squash 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 SquashMultiError, or nil if none found.

type SquashMultiError added in v0.10.0

type SquashMultiError []error

SquashMultiError is an error wrapping multiple validation errors returned by Squash.ValidateAll() if the designated constraints aren't met.

func (SquashMultiError) AllErrors added in v0.10.0

func (m SquashMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (SquashMultiError) Error added in v0.10.0

func (m SquashMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type SquashValidationError

type SquashValidationError struct {
	// contains filtered or unexported fields

SquashValidationError is the validation error returned by Squash.Validate if the designated constraints aren't met.

func (SquashValidationError) Cause

func (e SquashValidationError) Cause() error

Cause function returns cause value.

func (SquashValidationError) Error

func (e SquashValidationError) Error() string

Error satisfies the builtin error interface

func (SquashValidationError) ErrorName added in v0.7.0

func (e SquashValidationError) ErrorName() string

ErrorName returns error name.

func (SquashValidationError) Field

func (e SquashValidationError) Field() string

Field function returns field value.

func (SquashValidationError) Key

func (e SquashValidationError) Key() bool

Key function returns key value.

func (SquashValidationError) Reason

func (e SquashValidationError) Reason() string

Reason function returns reason value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL