pbcommon

package
v1.16.109 Latest Latest
Warning

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

 Go to latest Published: Aug 14, 2023 License: MPL-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DefaultEnterpriseMeta = &EnterpriseMeta{}
View Source 
var File_private_pbcommon_common_proto protoreflect.FileDescriptor

Functions

func EnterpriseMetaFromStructs 

func EnterpriseMetaFromStructs(t *acl.EnterpriseMeta, s *EnterpriseMeta)

func EnterpriseMetaToStructs 

func EnterpriseMetaToStructs(s *EnterpriseMeta, t *acl.EnterpriseMeta)

func EnvoyExtensionFromStructs 

func EnvoyExtensionFromStructs(t *structs.EnvoyExtension, s *EnvoyExtension)

func EnvoyExtensionToStructs 

func EnvoyExtensionToStructs(s *EnvoyExtension, t *structs.EnvoyExtension)

func EnvoyExtensionsToStructs 

func EnvoyExtensionsToStructs(args []*EnvoyExtension) []structs.EnvoyExtension

EnvoyExtensionsToStructs takes a protobuf EnvoyExtension argument and converts it to the structs EnvoyExtension

func LocalityFromProto 

func LocalityFromProto(l *Locality) *structs.Locality

LocalityFromProto converts a protobuf Locality to a struct Locality.

func LocalityFromStructs 

func LocalityFromStructs(t *structs.Locality, s *Locality)

func LocalityToStructs 

func LocalityToStructs(s *Locality, t *structs.Locality)

func MapStringInterfaceToProtobufTypesStruct 

func MapStringInterfaceToProtobufTypesStruct(m map[string]interface{}) *structpb.Struct

MapStringInterfaceToProtobufTypesStruct converts a map[string]interface{} into a proto.Struct

func ProtobufTypesStructToMapStringInterface 

func ProtobufTypesStructToMapStringInterface(s *structpb.Struct) map[string]interface{}

ProtobufTypesStructToMapStringInterface converts a protobuf/structpb.Struct into a map[string]interface{}.

func QueryMetaFromStructs 

func QueryMetaFromStructs(t *structs.QueryMeta, s *QueryMeta)

func QueryMetaToStructs 

func QueryMetaToStructs(s *QueryMeta, t *structs.QueryMeta)

func QueryOptionsFromStructs 

func QueryOptionsFromStructs(t *structs.QueryOptions, s *QueryOptions)

func QueryOptionsToStructs 

func QueryOptionsToStructs(s *QueryOptions, t *structs.QueryOptions)

func RaftIndexFromStructs 

func RaftIndexFromStructs(t *structs.RaftIndex, s *RaftIndex)

func RaftIndexToStructs 

func RaftIndexToStructs(s *RaftIndex, t *structs.RaftIndex)

func SliceToPBListValue 

func SliceToPBListValue(s []interface{}) *structpb.ListValue

SliceToPBListValue converts a []interface{} into a proto.ListValue. It's used internally by MapStringInterfaceToProtobufTypesStruct when it encouters slices. TODO (remove usage of this struct in favor of structpb.NewListValue)

func WriteRequestFromStructs 

func WriteRequestFromStructs(t *structs.WriteRequest, s *WriteRequest)

func WriteRequestToStructs 

func WriteRequestToStructs(s *WriteRequest, t *structs.WriteRequest)

Types

type EnterpriseMeta 

type EnterpriseMeta struct {

	// Namespace in which the entity exists.
	Namespace string `protobuf:"bytes,1,opt,name=Namespace,proto3" json:"Namespace,omitempty"`
	// Partition in which the entity exists.
	Partition string `protobuf:"bytes,2,opt,name=Partition,proto3" json:"Partition,omitempty"`
	// contains filtered or unexported fields
}

EnterpriseMeta contains metadata that is only used by the Enterprise version of Consul.

func NewEnterpriseMetaFromStructs 

func NewEnterpriseMetaFromStructs(_ acl.EnterpriseMeta) *EnterpriseMeta

func (*EnterpriseMeta) Descriptor deprecated 

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

Deprecated: Use EnterpriseMeta.ProtoReflect.Descriptor instead.

func (*EnterpriseMeta) GetNamespace 

func (x *EnterpriseMeta) GetNamespace() string

func (*EnterpriseMeta) GetPartition 

func (x *EnterpriseMeta) GetPartition() string

func (*EnterpriseMeta) MarshalBinary 

func (msg *EnterpriseMeta) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*EnterpriseMeta) ProtoMessage 

func (*EnterpriseMeta) ProtoMessage()

func (*EnterpriseMeta) ProtoReflect 

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

func (*EnterpriseMeta) Reset 

func (x *EnterpriseMeta) Reset()

func (*EnterpriseMeta) String 

func (x *EnterpriseMeta) String() string

func (*EnterpriseMeta) UnmarshalBinary 

func (msg *EnterpriseMeta) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type EnvoyExtension 

type EnvoyExtension struct {
	Name     string `protobuf:"bytes,1,opt,name=Name,proto3" json:"Name,omitempty"`
	Required bool   `protobuf:"varint,2,opt,name=Required,proto3" json:"Required,omitempty"`
	// mog: func-to=ProtobufTypesStructToMapStringInterface func-from=MapStringInterfaceToProtobufTypesStruct
	Arguments     *structpb.Struct `protobuf:"bytes,3,opt,name=Arguments,proto3" json:"Arguments,omitempty"`
	ConsulVersion string           `protobuf:"bytes,4,opt,name=ConsulVersion,proto3" json:"ConsulVersion,omitempty"`
	EnvoyVersion  string           `protobuf:"bytes,5,opt,name=EnvoyVersion,proto3" json:"EnvoyVersion,omitempty"`
	// contains filtered or unexported fields
}

mog annotation:

target=github.com/hernad/consul/agent/structs.EnvoyExtension output=common.gen.go name=Structs

func EnvoyExtensionsFromStructs 

func EnvoyExtensionsFromStructs(args []structs.EnvoyExtension) []*EnvoyExtension

EnvoyExtensionsFromStructs takes a structs EnvoyExtension argument and converts it to the protobuf EnvoyExtension

func (*EnvoyExtension) Descriptor deprecated 

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

Deprecated: Use EnvoyExtension.ProtoReflect.Descriptor instead.

func (*EnvoyExtension) GetArguments 

func (x *EnvoyExtension) GetArguments() *structpb.Struct

func (*EnvoyExtension) GetConsulVersion 

func (x *EnvoyExtension) GetConsulVersion() string

func (*EnvoyExtension) GetEnvoyVersion 

func (x *EnvoyExtension) GetEnvoyVersion() string

func (*EnvoyExtension) GetName 

func (x *EnvoyExtension) GetName() string

func (*EnvoyExtension) GetRequired 

func (x *EnvoyExtension) GetRequired() bool

func (*EnvoyExtension) MarshalBinary 

func (msg *EnvoyExtension) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*EnvoyExtension) ProtoMessage 

func (*EnvoyExtension) ProtoMessage()

func (*EnvoyExtension) ProtoReflect 

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

func (*EnvoyExtension) Reset 

func (x *EnvoyExtension) Reset()

func (*EnvoyExtension) String 

func (x *EnvoyExtension) String() string

func (*EnvoyExtension) UnmarshalBinary 

func (msg *EnvoyExtension) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type Locality 

type Locality struct {

	// Region is region the zone belongs to.
	Region string `protobuf:"bytes,1,opt,name=Region,proto3" json:"Region,omitempty"`
	// Zone is the zone the entity is running in.
	Zone string `protobuf:"bytes,2,opt,name=Zone,proto3" json:"Zone,omitempty"`
	// contains filtered or unexported fields
}

mog annotation:

target=github.com/hernad/consul/agent/structs.Locality output=common.gen.go name=Structs

func LocalityToProto 

func LocalityToProto(l *structs.Locality) *Locality

LocalityFromProto converts a struct Locality to a protobuf Locality.

func (*Locality) Descriptor deprecated 

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

Deprecated: Use Locality.ProtoReflect.Descriptor instead.

func (*Locality) GetRegion 

func (x *Locality) GetRegion() string

func (*Locality) GetZone 

func (x *Locality) GetZone() string

func (*Locality) IsEmpty 

func (l *Locality) IsEmpty() bool

IsEmpty returns true if the Locality is unset or contains an empty region and zone.

func (*Locality) MarshalBinary 

func (msg *Locality) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*Locality) ProtoMessage 

func (*Locality) ProtoMessage()

func (*Locality) ProtoReflect 

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

func (*Locality) Reset 

func (x *Locality) Reset()

func (*Locality) String 

func (x *Locality) String() string

func (*Locality) UnmarshalBinary 

func (msg *Locality) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type QueryMeta 

type QueryMeta struct {

	// This is the index associated with the read
	Index uint64 `protobuf:"varint,1,opt,name=Index,proto3" json:"Index,omitempty"`
	// If AllowStale is used, this is time elapsed since
	// last contact between the follower and leader. This
	// can be used to gauge staleness.
	// mog: func-to=structs.DurationFromProto func-from=structs.DurationToProto
	LastContact *durationpb.Duration `protobuf:"bytes,2,opt,name=LastContact,proto3" json:"LastContact,omitempty"`
	// Used to indicate if there is a known leader node
	KnownLeader bool `protobuf:"varint,3,opt,name=KnownLeader,proto3" json:"KnownLeader,omitempty"`
	// Consistencylevel returns the consistency used to serve the query
	// Having `discovery_max_stale` on the agent can affect whether
	// the request was served by a leader.
	ConsistencyLevel string `protobuf:"bytes,4,opt,name=ConsistencyLevel,proto3" json:"ConsistencyLevel,omitempty"`
	// ResultsFilteredByACLs is true when some of the query's results were
	// filtered out by enforcing ACLs. It may be false because nothing was
	// removed, or because the endpoint does not yet support this flag.
	ResultsFilteredByACLs bool `protobuf:"varint,7,opt,name=ResultsFilteredByACLs,proto3" json:"ResultsFilteredByACLs,omitempty"`
	// contains filtered or unexported fields
}

QueryMeta allows a query response to include potentially useful metadata about a query

mog annotation:

target=github.com/hernad/consul/agent/structs.QueryMeta output=common.gen.go name=Structs ignore-fields=NotModified,Backend,state,sizeCache,unknownFields

func (*QueryMeta) Descriptor deprecated 

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

Deprecated: Use QueryMeta.ProtoReflect.Descriptor instead.

func (*QueryMeta) GetBackend 

func (q *QueryMeta) GetBackend() structs.QueryBackend

func (*QueryMeta) GetConsistencyLevel 

func (x *QueryMeta) GetConsistencyLevel() string

func (*QueryMeta) GetIndex 

func (x *QueryMeta) GetIndex() uint64

func (*QueryMeta) GetKnownLeader 

func (x *QueryMeta) GetKnownLeader() bool

func (*QueryMeta) GetLastContact 

func (x *QueryMeta) GetLastContact() *durationpb.Duration

func (*QueryMeta) GetResultsFilteredByACLs 

func (x *QueryMeta) GetResultsFilteredByACLs() bool

func (*QueryMeta) MarshalBinary 

func (msg *QueryMeta) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*QueryMeta) ProtoMessage 

func (*QueryMeta) ProtoMessage()

func (*QueryMeta) ProtoReflect 

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

func (*QueryMeta) Reset 

func (x *QueryMeta) Reset()

func (*QueryMeta) SetConsistencyLevel 

func (q *QueryMeta) SetConsistencyLevel(consistencyLevel string)

SetConsistencyLevel is needed to implement the structs.QueryMetaCompat interface

func (*QueryMeta) SetIndex 

func (q *QueryMeta) SetIndex(index uint64)

SetIndex is needed to implement the structs.QueryMetaCompat interface

func (*QueryMeta) SetKnownLeader 

func (q *QueryMeta) SetKnownLeader(knownLeader bool)

SetKnownLeader is needed to implement the structs.QueryMetaCompat interface

func (*QueryMeta) SetLastContact 

func (q *QueryMeta) SetLastContact(lastContact time.Duration)

SetLastContact is needed to implement the structs.QueryMetaCompat interface

func (*QueryMeta) SetResultsFilteredByACLs 

func (q *QueryMeta) SetResultsFilteredByACLs(v bool)

SetResultsFilteredByACLs is needed to implement the structs.QueryMetaCompat interface

func (*QueryMeta) String 

func (x *QueryMeta) String() string

func (*QueryMeta) UnmarshalBinary 

func (msg *QueryMeta) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type QueryOptions 

type QueryOptions struct {

	// Token is the ACL token ID. If not provided, the 'anonymous'
	// token is assumed for backwards compatibility.
	Token string `protobuf:"bytes,1,opt,name=Token,proto3" json:"Token,omitempty"`
	// If set, wait until query exceeds given index. Must be provided
	// with MaxQueryTime.
	MinQueryIndex uint64 `protobuf:"varint,2,opt,name=MinQueryIndex,proto3" json:"MinQueryIndex,omitempty"`
	// Provided with MinQueryIndex to wait for change.
	// mog: func-to=structs.DurationFromProto func-from=structs.DurationToProto
	MaxQueryTime *durationpb.Duration `protobuf:"bytes,3,opt,name=MaxQueryTime,proto3" json:"MaxQueryTime,omitempty"`
	// If set, any follower can service the request. Results
	// may be arbitrarily stale.
	AllowStale bool `protobuf:"varint,4,opt,name=AllowStale,proto3" json:"AllowStale,omitempty"`
	// If set, the leader must verify leadership prior to
	// servicing the request. Prevents a stale read.
	RequireConsistent bool `protobuf:"varint,5,opt,name=RequireConsistent,proto3" json:"RequireConsistent,omitempty"`
	// If set, the local agent may respond with an arbitrarily stale locally
	// cached response. The semantics differ from AllowStale since the agent may
	// be entirely partitioned from the servers and still considered "healthy" by
	// operators. Stale responses from Servers are also arbitrarily stale, but can
	// provide additional bounds on the last contact time from the leader. It's
	// expected that servers that are partitioned are noticed and replaced in a
	// timely way by operators while the same may not be true for client agents.
	UseCache bool `protobuf:"varint,6,opt,name=UseCache,proto3" json:"UseCache,omitempty"`
	// If set and AllowStale is true, will try first a stale
	// read, and then will perform a consistent read if stale
	// read is older than value.
	// mog: func-to=structs.DurationFromProto func-from=structs.DurationToProto
	MaxStaleDuration *durationpb.Duration `protobuf:"bytes,7,opt,name=MaxStaleDuration,proto3" json:"MaxStaleDuration,omitempty"`
	// MaxAge limits how old a cached value will be returned if UseCache is true.
	// If there is a cached response that is older than the MaxAge, it is treated
	// as a cache miss and a new fetch invoked. If the fetch fails, the error is
	// returned. Clients that wish to allow for stale results on error can set
	// StaleIfError to a longer duration to change this behavior. It is ignored
	// if the endpoint supports background refresh caching. See
	// https://www.consul.io/api/index.html#agent-caching for more details.
	// mog: func-to=structs.DurationFromProto func-from=structs.DurationToProto
	MaxAge *durationpb.Duration `protobuf:"bytes,8,opt,name=MaxAge,proto3" json:"MaxAge,omitempty"`
	// MustRevalidate forces the agent to fetch a fresh version of a cached
	// resource or at least validate that the cached version is still fresh. It is
	// implied by either max-age=0 or must-revalidate Cache-Control headers. It
	// only makes sense when UseCache is true. We store it since MaxAge = 0 is the
	// default unset value.
	MustRevalidate bool `protobuf:"varint,9,opt,name=MustRevalidate,proto3" json:"MustRevalidate,omitempty"`
	// StaleIfError specifies how stale the client will accept a cached response
	// if the servers are unavailable to fetch a fresh one. Only makes sense when
	// UseCache is true and MaxAge is set to a lower, non-zero value. It is
	// ignored if the endpoint supports background refresh caching. See
	// https://www.consul.io/api/index.html#agent-caching for more details.
	StaleIfError *durationpb.Duration `protobuf:"bytes,10,opt,name=StaleIfError,proto3" json:"StaleIfError,omitempty"`
	// Filter specifies the go-bexpr filter expression to be used for
	// filtering the data prior to returning a response
	Filter string `protobuf:"bytes,11,opt,name=Filter,proto3" json:"Filter,omitempty"`
	// contains filtered or unexported fields
}

QueryOptions is used to specify various flags for read queries

mog annotation:

target=github.com/hernad/consul/agent/structs.QueryOptions output=common.gen.go name=Structs ignore-fields=StaleIfError,AllowNotModifiedResponse,state,sizeCache,unknownFields

func (*QueryOptions) AllowStaleRead 

func (q *QueryOptions) AllowStaleRead() bool

AllowStaleRead returns whether a stale read should be allowed

func (*QueryOptions) BlockingTimeout 

func (q *QueryOptions) BlockingTimeout(maxQueryTime, defaultQueryTime time.Duration) time.Duration

BlockingTimeout implements pool.BlockableQuery

func (*QueryOptions) Descriptor deprecated 

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

Deprecated: Use QueryOptions.ProtoReflect.Descriptor instead.

func (*QueryOptions) GetAllowStale 

func (x *QueryOptions) GetAllowStale() bool

func (*QueryOptions) GetFilter 

func (x *QueryOptions) GetFilter() string

func (*QueryOptions) GetMaxAge 

func (x *QueryOptions) GetMaxAge() *durationpb.Duration

func (*QueryOptions) GetMaxQueryTime 

func (x *QueryOptions) GetMaxQueryTime() *durationpb.Duration

func (*QueryOptions) GetMaxStaleDuration 

func (x *QueryOptions) GetMaxStaleDuration() *durationpb.Duration

func (*QueryOptions) GetMinQueryIndex 

func (x *QueryOptions) GetMinQueryIndex() uint64

func (*QueryOptions) GetMustRevalidate 

func (x *QueryOptions) GetMustRevalidate() bool

func (*QueryOptions) GetRequireConsistent 

func (x *QueryOptions) GetRequireConsistent() bool

func (*QueryOptions) GetStaleIfError 

func (x *QueryOptions) GetStaleIfError() *durationpb.Duration

func (*QueryOptions) GetToken 

func (x *QueryOptions) GetToken() string

func (*QueryOptions) GetUseCache 

func (x *QueryOptions) GetUseCache() bool

func (*QueryOptions) HasTimedOut 

func (q *QueryOptions) HasTimedOut(start time.Time, rpcHoldTimeout, maxQueryTime, defaultQueryTime time.Duration) (bool, error)

func (*QueryOptions) IsRead 

func (q *QueryOptions) IsRead() bool

IsRead is always true for QueryOption

func (*QueryOptions) MarshalBinary 

func (msg *QueryOptions) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*QueryOptions) ProtoMessage 

func (*QueryOptions) ProtoMessage()

func (*QueryOptions) ProtoReflect 

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

func (*QueryOptions) Reset 

func (x *QueryOptions) Reset()

func (*QueryOptions) SetAllowStale 

func (q *QueryOptions) SetAllowStale(allowStale bool)

SetAllowStale is needed to implement the structs.QueryOptionsCompat interface

func (*QueryOptions) SetFilter 

func (q *QueryOptions) SetFilter(filter string)

SetFilter is needed to implement the structs.QueryOptionsCompat interface

func (*QueryOptions) SetMaxAge 

func (q *QueryOptions) SetMaxAge(maxAge time.Duration)

SetMaxAge is needed to implement the structs.QueryOptionsCompat interface

func (*QueryOptions) SetMaxQueryTime 

func (q *QueryOptions) SetMaxQueryTime(maxQueryTime time.Duration)

SetMaxQueryTime is needed to implement the structs.QueryOptionsCompat interface

func (*QueryOptions) SetMaxStaleDuration 

func (q *QueryOptions) SetMaxStaleDuration(maxStaleDuration time.Duration)

SetMaxStaleDuration is needed to implement the structs.QueryOptionsCompat interface

func (*QueryOptions) SetMinQueryIndex 

func (q *QueryOptions) SetMinQueryIndex(minQueryIndex uint64)

SetMinQueryIndex is needed to implement the structs.QueryOptionsCompat interface

func (*QueryOptions) SetMustRevalidate 

func (q *QueryOptions) SetMustRevalidate(mustRevalidate bool)

SetMustRevalidate is needed to implement the structs.QueryOptionsCompat interface

func (*QueryOptions) SetRequireConsistent 

func (q *QueryOptions) SetRequireConsistent(requireConsistent bool)

SetRequireConsistent is needed to implement the structs.QueryOptionsCompat interface

func (*QueryOptions) SetStaleIfError 

func (q *QueryOptions) SetStaleIfError(staleIfError time.Duration)

SetStaleIfError is needed to implement the structs.QueryOptionsCompat interface

func (*QueryOptions) SetToken 

func (q *QueryOptions) SetToken(token string)

SetToken is needed to implement the structs.QueryOptionsCompat interface

func (*QueryOptions) SetTokenSecret 

func (q *QueryOptions) SetTokenSecret(s string)

func (*QueryOptions) SetUseCache 

func (q *QueryOptions) SetUseCache(useCache bool)

SetUseCache is needed to implement the structs.QueryOptionsCompat interface

func (*QueryOptions) String 

func (x *QueryOptions) String() string

func (*QueryOptions) TokenSecret 

func (q *QueryOptions) TokenSecret() string

func (*QueryOptions) UnmarshalBinary 

func (msg *QueryOptions) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type RaftIndex 

type RaftIndex struct {

	// @gotags: bexpr:"-"
	CreateIndex uint64 `protobuf:"varint,1,opt,name=CreateIndex,proto3" json:"CreateIndex,omitempty" bexpr:"-"`
	// @gotags: bexpr:"-"
	ModifyIndex uint64 `protobuf:"varint,2,opt,name=ModifyIndex,proto3" json:"ModifyIndex,omitempty" bexpr:"-"`
	// contains filtered or unexported fields
}

RaftIndex is used to track the index used while creating or modifying a given struct type.

mog annotation:

target=github.com/hernad/consul/agent/structs.RaftIndex output=common.gen.go name=Structs ignore-fields=state,sizeCache,unknownFields

func (*RaftIndex) Descriptor deprecated 

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

Deprecated: Use RaftIndex.ProtoReflect.Descriptor instead.

func (*RaftIndex) GetCreateIndex 

func (x *RaftIndex) GetCreateIndex() uint64

func (*RaftIndex) GetModifyIndex 

func (x *RaftIndex) GetModifyIndex() uint64

func (*RaftIndex) MarshalBinary 

func (msg *RaftIndex) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*RaftIndex) ProtoMessage 

func (*RaftIndex) ProtoMessage()

func (*RaftIndex) ProtoReflect 

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

func (*RaftIndex) Reset 

func (x *RaftIndex) Reset()

func (*RaftIndex) String 

func (x *RaftIndex) String() string

func (*RaftIndex) UnmarshalBinary 

func (msg *RaftIndex) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type ReadRequest 

type ReadRequest struct {

	// Token is the ACL token ID. If not provided, the 'anonymous'
	// token is assumed for backwards compatibility.
	Token string `protobuf:"bytes,1,opt,name=Token,proto3" json:"Token,omitempty"`
	// RequireConsistent indicates that the request must be sent to the leader.
	RequireConsistent bool `protobuf:"varint,2,opt,name=RequireConsistent,proto3" json:"RequireConsistent,omitempty"`
	// contains filtered or unexported fields
}

ReadRequest is a type that may be embedded into any requests for read operations. It is a replacement for QueryOptions now that we no longer need any of those fields because we are moving away from using blocking queries. It is also similar to WriteRequest. It is a separate type so that in the future we can introduce fields that may only be relevant for reads.

func (*ReadRequest) AllowStaleRead 

func (r *ReadRequest) AllowStaleRead() bool

AllowStaleRead implements structs.RPCInfo

func (*ReadRequest) Descriptor deprecated 

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

Deprecated: Use ReadRequest.ProtoReflect.Descriptor instead.

func (*ReadRequest) GetRequireConsistent 

func (x *ReadRequest) GetRequireConsistent() bool

func (*ReadRequest) GetToken 

func (x *ReadRequest) GetToken() string

func (*ReadRequest) HasTimedOut 

func (r *ReadRequest) HasTimedOut(start time.Time, rpcHoldTimeout, _, _ time.Duration) (bool, error)

HasTimedOut implements structs.RPCInfo

func (*ReadRequest) IsRead 

func (r *ReadRequest) IsRead() bool

IsRead implements structs.RPCInfo

func (*ReadRequest) MarshalBinary 

func (msg *ReadRequest) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*ReadRequest) ProtoMessage 

func (*ReadRequest) ProtoMessage()

func (*ReadRequest) ProtoReflect 

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

func (*ReadRequest) Reset 

func (x *ReadRequest) Reset()

func (*ReadRequest) SetTokenSecret 

func (r *ReadRequest) SetTokenSecret(token string)

SetTokenSecret implements structs.RPCInfo

func (*ReadRequest) String 

func (x *ReadRequest) String() string

func (*ReadRequest) TokenSecret 

func (r *ReadRequest) TokenSecret() string

TokenSecret implements structs.RPCInfo

func (*ReadRequest) UnmarshalBinary 

func (msg *ReadRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type TargetDatacenter 

type TargetDatacenter struct {
	Datacenter string `protobuf:"bytes,1,opt,name=Datacenter,proto3" json:"Datacenter,omitempty"`
	// contains filtered or unexported fields
}

TargetDatacenter is intended to be used within other messages used for RPC routing amongst the various Consul datacenters

func (*TargetDatacenter) Descriptor deprecated 

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

Deprecated: Use TargetDatacenter.ProtoReflect.Descriptor instead.

func (*TargetDatacenter) GetDatacenter 

func (x *TargetDatacenter) GetDatacenter() string

func (*TargetDatacenter) MarshalBinary 

func (msg *TargetDatacenter) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*TargetDatacenter) ProtoMessage 

func (*TargetDatacenter) ProtoMessage()

func (*TargetDatacenter) ProtoReflect 

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

func (*TargetDatacenter) RequestDatacenter 

func (td *TargetDatacenter) RequestDatacenter() string

RequestDatacenter implements structs.RPCInfo

func (*TargetDatacenter) Reset 

func (x *TargetDatacenter) Reset()

func (*TargetDatacenter) String 

func (x *TargetDatacenter) String() string

func (*TargetDatacenter) UnmarshalBinary 

func (msg *TargetDatacenter) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type WriteRequest 

type WriteRequest struct {

	// Token is the ACL token ID. If not provided, the 'anonymous'
	// token is assumed for backwards compatibility.
	Token string `protobuf:"bytes,1,opt,name=Token,proto3" json:"Token,omitempty"`
	// contains filtered or unexported fields
}

mog annotation:

target=github.com/hernad/consul/agent/structs.WriteRequest output=common.gen.go name=Structs ignore-fields=state,sizeCache,unknownFields

func (*WriteRequest) AllowStaleRead 

func (w *WriteRequest) AllowStaleRead() bool

AllowStaleRead returns whether a stale read should be allowed

AllowStaleRead implements structs.RPCInfo

func (*WriteRequest) Descriptor deprecated 

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

Deprecated: Use WriteRequest.ProtoReflect.Descriptor instead.

func (*WriteRequest) GetToken 

func (x *WriteRequest) GetToken() string

func (*WriteRequest) HasTimedOut 

func (w *WriteRequest) HasTimedOut(start time.Time, rpcHoldTimeout, maxQueryTime, defaultQueryTime time.Duration) (bool, error)

HasTimedOut implements structs.RPCInfo

func (*WriteRequest) IsRead 

func (w *WriteRequest) IsRead() bool

WriteRequest only applies to writes, always false

IsRead implements structs.RPCInfo

func (*WriteRequest) MarshalBinary 

func (msg *WriteRequest) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*WriteRequest) ProtoMessage 

func (*WriteRequest) ProtoMessage()

func (*WriteRequest) ProtoReflect 

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

func (*WriteRequest) Reset 

func (x *WriteRequest) Reset()

func (*WriteRequest) SetTokenSecret 

func (w *WriteRequest) SetTokenSecret(s string)

SetTokenSecret implements structs.RPCInfo

func (*WriteRequest) String 

func (x *WriteRequest) String() string

func (*WriteRequest) TokenSecret 

func (w *WriteRequest) TokenSecret() string

SetTokenSecret implements structs.RPCInfo

func (*WriteRequest) UnmarshalBinary 

func (msg *WriteRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.