retries

package
v1.18.0 Latest Latest
Warning

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

Go to latest
Published: Dec 12, 2024 License: Apache-2.0 Imports: 22 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_github_com_solo_io_gloo_projects_gloo_api_v1_options_retries_retries_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type RetryBackOff added in v1.13.0

type RetryBackOff struct {

	// Specifies the base interval for a retry
	BaseInterval *durationpb.Duration `protobuf:"bytes,1,opt,name=base_interval,json=baseInterval,proto3" json:"base_interval,omitempty"`
	// Specifies the max interval for a retry
	MaxInterval *durationpb.Duration `protobuf:"bytes,2,opt,name=max_interval,json=maxInterval,proto3" json:"max_interval,omitempty"`
	// contains filtered or unexported fields
}

This specifies the retry policy interval for backoffs. Note that if the base interval provided is larger than the maximum interval OR if any of the durations passed are <= 0 MS, there will be an error.

func (*RetryBackOff) Clone added in v1.13.0

func (m *RetryBackOff) Clone() proto.Message

Clone function

func (*RetryBackOff) Descriptor deprecated added in v1.13.0

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

Deprecated: Use RetryBackOff.ProtoReflect.Descriptor instead.

func (*RetryBackOff) Equal added in v1.13.0

func (m *RetryBackOff) Equal(that interface{}) bool

Equal function

func (*RetryBackOff) GetBaseInterval added in v1.13.0

func (x *RetryBackOff) GetBaseInterval() *durationpb.Duration

func (*RetryBackOff) GetMaxInterval added in v1.13.0

func (x *RetryBackOff) GetMaxInterval() *durationpb.Duration

func (*RetryBackOff) Hash deprecated added in v1.13.0

func (m *RetryBackOff) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*RetryBackOff) HashUnique added in v1.18.0

func (m *RetryBackOff) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*RetryBackOff) ProtoMessage added in v1.13.0

func (*RetryBackOff) ProtoMessage()

func (*RetryBackOff) ProtoReflect added in v1.13.0

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

func (*RetryBackOff) Reset added in v1.13.0

func (x *RetryBackOff) Reset()

func (*RetryBackOff) String added in v1.13.0

func (x *RetryBackOff) String() string

type RetryPolicy

type RetryPolicy struct {

	// Specifies the conditions under which retry takes place. These are the same
	// conditions [documented for Envoy](https://www.envoyproxy.io/docs/envoy/v1.14.1/configuration/http/http_filters/router_filter#config-http-filters-router-x-envoy-retry-on)
	RetryOn string `protobuf:"bytes,1,opt,name=retry_on,json=retryOn,proto3" json:"retry_on,omitempty"`
	// Specifies the allowed number of retries. This parameter is optional and
	// defaults to 1. These are the same conditions [documented for Envoy](https://www.envoyproxy.io/docs/envoy/v1.14.1/configuration/http/http_filters/router_filter#config-http-filters-router-x-envoy-retry-on)
	NumRetries uint32 `protobuf:"varint,2,opt,name=num_retries,json=numRetries,proto3" json:"num_retries,omitempty"`
	// Specifies a non-zero upstream timeout per retry attempt. This parameter is optional.
	PerTryTimeout *durationpb.Duration `protobuf:"bytes,3,opt,name=per_try_timeout,json=perTryTimeout,proto3" json:"per_try_timeout,omitempty"`
	// Specifies the retry policy interval
	RetryBackOff *RetryBackOff `protobuf:"bytes,4,opt,name=retry_back_off,json=retryBackOff,proto3" json:"retry_back_off,omitempty"`
	// Types that are assignable to PriorityPredicate:
	//
	//	*RetryPolicy_PreviousPriorities_
	PriorityPredicate isRetryPolicy_PriorityPredicate `protobuf_oneof:"priority_predicate"`
	// Optional: HTTP status codes that should trigger a retry in addition to those specified by retry_on.
	// This can be useful if you want to retry on a status code that is not in the retry_on list.
	// Specifically those in the 4xx range.
	RetriableStatusCodes []uint32 `` /* 131-byte string literal not displayed */
	// contains filtered or unexported fields
}

Retry Policy applied at the Route and/or Virtual Hosts levels.

func (*RetryPolicy) Clone added in v1.8.24

func (m *RetryPolicy) Clone() proto.Message

Clone function

func (*RetryPolicy) Descriptor deprecated

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

Deprecated: Use RetryPolicy.ProtoReflect.Descriptor instead.

func (*RetryPolicy) Equal

func (m *RetryPolicy) Equal(that interface{}) bool

Equal function

func (*RetryPolicy) GetNumRetries

func (x *RetryPolicy) GetNumRetries() uint32

func (*RetryPolicy) GetPerTryTimeout

func (x *RetryPolicy) GetPerTryTimeout() *durationpb.Duration

func (*RetryPolicy) GetPreviousPriorities added in v1.17.0

func (x *RetryPolicy) GetPreviousPriorities() *RetryPolicy_PreviousPriorities

func (*RetryPolicy) GetPriorityPredicate added in v1.17.0

func (m *RetryPolicy) GetPriorityPredicate() isRetryPolicy_PriorityPredicate

func (*RetryPolicy) GetRetriableStatusCodes added in v1.18.0

func (x *RetryPolicy) GetRetriableStatusCodes() []uint32

func (*RetryPolicy) GetRetryBackOff added in v1.13.0

func (x *RetryPolicy) GetRetryBackOff() *RetryBackOff

func (*RetryPolicy) GetRetryOn

func (x *RetryPolicy) GetRetryOn() string

func (*RetryPolicy) Hash deprecated added in v1.2.13

func (m *RetryPolicy) Hash(hasher hash.Hash64) (uint64, error)

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*RetryPolicy) HashUnique added in v1.18.0

func (m *RetryPolicy) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*RetryPolicy) ProtoMessage

func (*RetryPolicy) ProtoMessage()

func (*RetryPolicy) ProtoReflect added in v1.6.0

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

func (*RetryPolicy) Reset

func (x *RetryPolicy) Reset()

func (*RetryPolicy) String

func (x *RetryPolicy) String() string

type RetryPolicy_PreviousPriorities added in v1.17.0

type RetryPolicy_PreviousPriorities struct {

	// Specify the update frequency for the previous priorities. For more information about previous priorities, see the [Envoy docs](https://www.envoyproxy.io/docs/envoy/v1.30.1/api-v3/extensions/retry/priority/previous_priorities/v3/previous_priorities_config.proto#envoy-v3-api-file-envoy-extensions-retry-priority-previous-priorities-v3-previous-priorities-config-proto).
	// This option only works in combination with an Upstream failover policy that enables priorities.
	UpdateFrequency *wrapperspb.UInt32Value `protobuf:"bytes,1,opt,name=update_frequency,json=updateFrequency,proto3" json:"update_frequency,omitempty"`
	// contains filtered or unexported fields
}

func (*RetryPolicy_PreviousPriorities) Clone added in v1.17.0

Clone function

func (*RetryPolicy_PreviousPriorities) Descriptor deprecated added in v1.17.0

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

Deprecated: Use RetryPolicy_PreviousPriorities.ProtoReflect.Descriptor instead.

func (*RetryPolicy_PreviousPriorities) Equal added in v1.17.0

func (m *RetryPolicy_PreviousPriorities) Equal(that interface{}) bool

Equal function

func (*RetryPolicy_PreviousPriorities) GetUpdateFrequency added in v1.17.0

func (x *RetryPolicy_PreviousPriorities) GetUpdateFrequency() *wrapperspb.UInt32Value

func (*RetryPolicy_PreviousPriorities) Hash deprecated added in v1.17.0

Hash function

Deprecated: due to hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions. Prefer the HashUnique function instead.

func (*RetryPolicy_PreviousPriorities) HashUnique added in v1.18.0

func (m *RetryPolicy_PreviousPriorities) HashUnique(hasher hash.Hash64) (uint64, error)

HashUnique function generates a hash of the object that is unique to the object by hashing field name and value pairs. Replaces Hash due to original hashing implemention only using field values. The omission of the field name in the hash calculation can lead to hash collisions.

func (*RetryPolicy_PreviousPriorities) ProtoMessage added in v1.17.0

func (*RetryPolicy_PreviousPriorities) ProtoMessage()

func (*RetryPolicy_PreviousPriorities) ProtoReflect added in v1.17.0

func (*RetryPolicy_PreviousPriorities) Reset added in v1.17.0

func (x *RetryPolicy_PreviousPriorities) Reset()

func (*RetryPolicy_PreviousPriorities) String added in v1.17.0

type RetryPolicy_PreviousPriorities_ added in v1.17.0

type RetryPolicy_PreviousPriorities_ struct {
	// Specify the previous priorities.
	// For more information about previous priorities, see the [Envoy docs](https://www.envoyproxy.io/docs/envoy/v1.30.1/api-v3/extensions/retry/priority/previous_priorities/v3/previous_priorities_config.proto#envoy-v3-api-file-envoy-extensions-retry-priority-previous-priorities-v3-previous-priorities-config-proto).
	PreviousPriorities *RetryPolicy_PreviousPriorities `protobuf:"bytes,5,opt,name=previous_priorities,json=previousPriorities,proto3,oneof"`
}

Jump to

Keyboard shortcuts

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