Documentation ¶
Index ¶
- Variables
- type EnterpriseMeta
- func (*EnterpriseMeta) Descriptor() ([]byte, []int)
- func (m *EnterpriseMeta) Marshal() (dAtA []byte, err error)
- func (msg *EnterpriseMeta) MarshalBinary() ([]byte, error)
- func (m *EnterpriseMeta) MarshalTo(dAtA []byte) (int, error)
- func (m *EnterpriseMeta) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*EnterpriseMeta) ProtoMessage()
- func (m *EnterpriseMeta) Reset()
- func (m *EnterpriseMeta) Size() (n int)
- func (m *EnterpriseMeta) String() string
- func (m *EnterpriseMeta) Unmarshal(dAtA []byte) error
- func (msg *EnterpriseMeta) UnmarshalBinary(b []byte) error
- func (m *EnterpriseMeta) XXX_DiscardUnknown()
- func (m *EnterpriseMeta) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *EnterpriseMeta) XXX_Merge(src proto.Message)
- func (m *EnterpriseMeta) XXX_Size() int
- func (m *EnterpriseMeta) XXX_Unmarshal(b []byte) error
- type QueryMeta
- func (*QueryMeta) Descriptor() ([]byte, []int)
- func (q *QueryMeta) GetBackend() structs.QueryBackend
- func (m *QueryMeta) GetConsistencyLevel() string
- func (m *QueryMeta) GetIndex() uint64
- func (m *QueryMeta) GetKnownLeader() bool
- func (m *QueryMeta) GetLastContact() time.Duration
- func (m *QueryMeta) GetResultsFilteredByACLs() bool
- func (m *QueryMeta) Marshal() (dAtA []byte, err error)
- func (msg *QueryMeta) MarshalBinary() ([]byte, error)
- func (m *QueryMeta) MarshalTo(dAtA []byte) (int, error)
- func (m *QueryMeta) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*QueryMeta) ProtoMessage()
- func (m *QueryMeta) Reset()
- func (q *QueryMeta) SetConsistencyLevel(consistencyLevel string)
- func (q *QueryMeta) SetIndex(index uint64)
- func (q *QueryMeta) SetKnownLeader(knownLeader bool)
- func (q *QueryMeta) SetLastContact(lastContact time.Duration)
- func (m *QueryMeta) Size() (n int)
- func (m *QueryMeta) String() string
- func (m *QueryMeta) Unmarshal(dAtA []byte) error
- func (msg *QueryMeta) UnmarshalBinary(b []byte) error
- func (m *QueryMeta) XXX_DiscardUnknown()
- func (m *QueryMeta) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *QueryMeta) XXX_Merge(src proto.Message)
- func (m *QueryMeta) XXX_Size() int
- func (m *QueryMeta) XXX_Unmarshal(b []byte) error
- type QueryOptions
- func (q *QueryOptions) AllowStaleRead() bool
- func (*QueryOptions) Descriptor() ([]byte, []int)
- func (m *QueryOptions) GetAllowStale() bool
- func (m *QueryOptions) GetFilter() string
- func (m *QueryOptions) GetMaxAge() time.Duration
- func (m *QueryOptions) GetMaxQueryTime() time.Duration
- func (m *QueryOptions) GetMaxStaleDuration() time.Duration
- func (m *QueryOptions) GetMinQueryIndex() uint64
- func (m *QueryOptions) GetMustRevalidate() bool
- func (m *QueryOptions) GetRequireConsistent() bool
- func (m *QueryOptions) GetStaleIfError() time.Duration
- func (m *QueryOptions) GetToken() string
- func (m *QueryOptions) GetUseCache() bool
- func (q QueryOptions) HasTimedOut(start time.Time, rpcHoldTimeout, maxQueryTime, defaultQueryTime time.Duration) bool
- func (q *QueryOptions) IsRead() bool
- func (m *QueryOptions) Marshal() (dAtA []byte, err error)
- func (msg *QueryOptions) MarshalBinary() ([]byte, error)
- func (m *QueryOptions) MarshalTo(dAtA []byte) (int, error)
- func (m *QueryOptions) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*QueryOptions) ProtoMessage()
- func (m *QueryOptions) Reset()
- func (q *QueryOptions) SetAllowStale(allowStale bool)
- func (q *QueryOptions) SetFilter(filter string)
- func (q *QueryOptions) SetMaxAge(maxAge time.Duration)
- func (q *QueryOptions) SetMaxQueryTime(maxQueryTime time.Duration)
- func (q *QueryOptions) SetMaxStaleDuration(maxStaleDuration time.Duration)
- func (q *QueryOptions) SetMinQueryIndex(minQueryIndex uint64)
- func (q *QueryOptions) SetMustRevalidate(mustRevalidate bool)
- func (q *QueryOptions) SetRequireConsistent(requireConsistent bool)
- func (q *QueryOptions) SetStaleIfError(staleIfError time.Duration)
- func (q *QueryOptions) SetToken(token string)
- func (q *QueryOptions) SetTokenSecret(s string)
- func (q *QueryOptions) SetUseCache(useCache bool)
- func (m *QueryOptions) Size() (n int)
- func (m *QueryOptions) String() string
- func (q *QueryOptions) TokenSecret() string
- func (m *QueryOptions) Unmarshal(dAtA []byte) error
- func (msg *QueryOptions) UnmarshalBinary(b []byte) error
- func (m *QueryOptions) XXX_DiscardUnknown()
- func (m *QueryOptions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *QueryOptions) XXX_Merge(src proto.Message)
- func (m *QueryOptions) XXX_Size() int
- func (m *QueryOptions) XXX_Unmarshal(b []byte) error
- type RaftIndex
- func (*RaftIndex) Descriptor() ([]byte, []int)
- func (m *RaftIndex) Marshal() (dAtA []byte, err error)
- func (msg *RaftIndex) MarshalBinary() ([]byte, error)
- func (m *RaftIndex) MarshalTo(dAtA []byte) (int, error)
- func (m *RaftIndex) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*RaftIndex) ProtoMessage()
- func (m *RaftIndex) Reset()
- func (m *RaftIndex) Size() (n int)
- func (m *RaftIndex) String() string
- func (m *RaftIndex) Unmarshal(dAtA []byte) error
- func (msg *RaftIndex) UnmarshalBinary(b []byte) error
- func (m *RaftIndex) XXX_DiscardUnknown()
- func (m *RaftIndex) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RaftIndex) XXX_Merge(src proto.Message)
- func (m *RaftIndex) XXX_Size() int
- func (m *RaftIndex) XXX_Unmarshal(b []byte) error
- type ReadRequest
- func (r *ReadRequest) AllowStaleRead() bool
- func (*ReadRequest) Descriptor() ([]byte, []int)
- func (m *ReadRequest) GetRequireConsistent() bool
- func (m *ReadRequest) GetToken() string
- func (r *ReadRequest) HasTimedOut(start time.Time, rpcHoldTimeout, maxQueryTime, defaultQueryTime time.Duration) bool
- func (r *ReadRequest) IsRead() bool
- func (m *ReadRequest) Marshal() (dAtA []byte, err error)
- func (msg *ReadRequest) MarshalBinary() ([]byte, error)
- func (m *ReadRequest) MarshalTo(dAtA []byte) (int, error)
- func (m *ReadRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*ReadRequest) ProtoMessage()
- func (m *ReadRequest) Reset()
- func (r *ReadRequest) SetTokenSecret(token string)
- func (m *ReadRequest) Size() (n int)
- func (m *ReadRequest) String() string
- func (r *ReadRequest) TokenSecret() string
- func (m *ReadRequest) Unmarshal(dAtA []byte) error
- func (msg *ReadRequest) UnmarshalBinary(b []byte) error
- func (m *ReadRequest) XXX_DiscardUnknown()
- func (m *ReadRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ReadRequest) XXX_Merge(src proto.Message)
- func (m *ReadRequest) XXX_Size() int
- func (m *ReadRequest) XXX_Unmarshal(b []byte) error
- type TargetDatacenter
- func (*TargetDatacenter) Descriptor() ([]byte, []int)
- func (m *TargetDatacenter) Marshal() (dAtA []byte, err error)
- func (msg *TargetDatacenter) MarshalBinary() ([]byte, error)
- func (m *TargetDatacenter) MarshalTo(dAtA []byte) (int, error)
- func (m *TargetDatacenter) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*TargetDatacenter) ProtoMessage()
- func (td TargetDatacenter) RequestDatacenter() string
- func (m *TargetDatacenter) Reset()
- func (m *TargetDatacenter) Size() (n int)
- func (m *TargetDatacenter) String() string
- func (m *TargetDatacenter) Unmarshal(dAtA []byte) error
- func (msg *TargetDatacenter) UnmarshalBinary(b []byte) error
- func (m *TargetDatacenter) XXX_DiscardUnknown()
- func (m *TargetDatacenter) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *TargetDatacenter) XXX_Merge(src proto.Message)
- func (m *TargetDatacenter) XXX_Size() int
- func (m *TargetDatacenter) XXX_Unmarshal(b []byte) error
- type WriteRequest
- func (w WriteRequest) AllowStaleRead() bool
- func (*WriteRequest) Descriptor() ([]byte, []int)
- func (m *WriteRequest) GetToken() string
- func (w WriteRequest) HasTimedOut(start time.Time, rpcHoldTimeout, _, _ time.Duration) bool
- func (w WriteRequest) IsRead() bool
- func (m *WriteRequest) Marshal() (dAtA []byte, err error)
- func (msg *WriteRequest) MarshalBinary() ([]byte, error)
- func (m *WriteRequest) MarshalTo(dAtA []byte) (int, error)
- func (m *WriteRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*WriteRequest) ProtoMessage()
- func (m *WriteRequest) Reset()
- func (w *WriteRequest) SetTokenSecret(s string)
- func (m *WriteRequest) Size() (n int)
- func (m *WriteRequest) String() string
- func (w WriteRequest) TokenSecret() string
- func (m *WriteRequest) Unmarshal(dAtA []byte) error
- func (msg *WriteRequest) UnmarshalBinary(b []byte) error
- func (m *WriteRequest) XXX_DiscardUnknown()
- func (m *WriteRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *WriteRequest) XXX_Merge(src proto.Message)
- func (m *WriteRequest) XXX_Size() int
- func (m *WriteRequest) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidLengthCommon = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowCommon = fmt.Errorf("proto: integer overflow") ErrUnexpectedEndOfGroupCommon = fmt.Errorf("proto: unexpected end of group") )
var DefaultEnterpriseMeta = EnterpriseMeta{}
Functions ¶
This section is empty.
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"` }
EnterpriseMeta contains metadata that is only used by the Enterprise version of Consul.
func (*EnterpriseMeta) Descriptor ¶
func (*EnterpriseMeta) Descriptor() ([]byte, []int)
func (*EnterpriseMeta) Marshal ¶
func (m *EnterpriseMeta) Marshal() (dAtA []byte, err error)
func (*EnterpriseMeta) MarshalBinary ¶
func (msg *EnterpriseMeta) MarshalBinary() ([]byte, error)
MarshalBinary implements encoding.BinaryMarshaler
func (*EnterpriseMeta) MarshalToSizedBuffer ¶ added in v1.8.2
func (m *EnterpriseMeta) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*EnterpriseMeta) ProtoMessage ¶
func (*EnterpriseMeta) ProtoMessage()
func (*EnterpriseMeta) Reset ¶
func (m *EnterpriseMeta) Reset()
func (*EnterpriseMeta) Size ¶
func (m *EnterpriseMeta) Size() (n int)
func (*EnterpriseMeta) String ¶
func (m *EnterpriseMeta) String() string
func (*EnterpriseMeta) Unmarshal ¶
func (m *EnterpriseMeta) Unmarshal(dAtA []byte) error
func (*EnterpriseMeta) UnmarshalBinary ¶
func (msg *EnterpriseMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary implements encoding.BinaryUnmarshaler
func (*EnterpriseMeta) XXX_DiscardUnknown ¶
func (m *EnterpriseMeta) XXX_DiscardUnknown()
func (*EnterpriseMeta) XXX_Marshal ¶
func (m *EnterpriseMeta) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*EnterpriseMeta) XXX_Merge ¶
func (m *EnterpriseMeta) XXX_Merge(src proto.Message)
func (*EnterpriseMeta) XXX_Size ¶
func (m *EnterpriseMeta) XXX_Size() int
func (*EnterpriseMeta) XXX_Unmarshal ¶
func (m *EnterpriseMeta) XXX_Unmarshal(b []byte) error
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. LastContact time.Duration `protobuf:"bytes,2,opt,name=LastContact,proto3,stdduration" json:"LastContact"` // 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"` }
QueryMeta allows a query response to include potentially useful metadata about a query
func (*QueryMeta) Descriptor ¶
func (*QueryMeta) GetBackend ¶ added in v1.10.1
func (q *QueryMeta) GetBackend() structs.QueryBackend
func (*QueryMeta) GetConsistencyLevel ¶
func (*QueryMeta) GetKnownLeader ¶
func (*QueryMeta) GetLastContact ¶
func (*QueryMeta) GetResultsFilteredByACLs ¶ added in v1.11.0
func (*QueryMeta) MarshalBinary ¶
MarshalBinary implements encoding.BinaryMarshaler
func (*QueryMeta) MarshalToSizedBuffer ¶ added in v1.8.2
func (*QueryMeta) ProtoMessage ¶
func (*QueryMeta) ProtoMessage()
func (*QueryMeta) SetConsistencyLevel ¶
SetConsistencyLevel is needed to implement the structs.QueryMetaCompat interface
func (*QueryMeta) SetKnownLeader ¶
SetKnownLeader is needed to implement the structs.QueryMetaCompat interface
func (*QueryMeta) SetLastContact ¶
SetLastContact is needed to implement the structs.QueryMetaCompat interface
func (*QueryMeta) UnmarshalBinary ¶
UnmarshalBinary implements encoding.BinaryUnmarshaler
func (*QueryMeta) XXX_DiscardUnknown ¶
func (m *QueryMeta) XXX_DiscardUnknown()
func (*QueryMeta) XXX_Marshal ¶
func (*QueryMeta) XXX_Unmarshal ¶
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. MaxQueryTime time.Duration `protobuf:"bytes,3,opt,name=MaxQueryTime,proto3,stdduration" json:"MaxQueryTime"` // 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. MaxStaleDuration time.Duration `protobuf:"bytes,7,opt,name=MaxStaleDuration,proto3,stdduration" json:"MaxStaleDuration"` // 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. MaxAge time.Duration `protobuf:"bytes,8,opt,name=MaxAge,proto3,stdduration" json:"MaxAge"` // 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 time.Duration `protobuf:"bytes,10,opt,name=StaleIfError,proto3,stdduration" json:"StaleIfError"` // 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"` }
QueryOptions is used to specify various flags for read queries
func (*QueryOptions) AllowStaleRead ¶
func (q *QueryOptions) AllowStaleRead() bool
AllowStaleRead returns whether a stale read should be allowed
func (*QueryOptions) Descriptor ¶
func (*QueryOptions) Descriptor() ([]byte, []int)
func (*QueryOptions) GetAllowStale ¶
func (m *QueryOptions) GetAllowStale() bool
func (*QueryOptions) GetFilter ¶
func (m *QueryOptions) GetFilter() string
func (*QueryOptions) GetMaxAge ¶
func (m *QueryOptions) GetMaxAge() time.Duration
func (*QueryOptions) GetMaxQueryTime ¶
func (m *QueryOptions) GetMaxQueryTime() time.Duration
func (*QueryOptions) GetMaxStaleDuration ¶
func (m *QueryOptions) GetMaxStaleDuration() time.Duration
func (*QueryOptions) GetMinQueryIndex ¶
func (m *QueryOptions) GetMinQueryIndex() uint64
func (*QueryOptions) GetMustRevalidate ¶
func (m *QueryOptions) GetMustRevalidate() bool
func (*QueryOptions) GetRequireConsistent ¶
func (m *QueryOptions) GetRequireConsistent() bool
func (*QueryOptions) GetStaleIfError ¶
func (m *QueryOptions) GetStaleIfError() time.Duration
func (*QueryOptions) GetToken ¶
func (m *QueryOptions) GetToken() string
func (*QueryOptions) GetUseCache ¶
func (m *QueryOptions) GetUseCache() bool
func (QueryOptions) HasTimedOut ¶ added in v1.11.0
func (*QueryOptions) IsRead ¶
func (q *QueryOptions) IsRead() bool
IsRead is always true for QueryOption
func (*QueryOptions) Marshal ¶
func (m *QueryOptions) Marshal() (dAtA []byte, err error)
func (*QueryOptions) MarshalBinary ¶
func (msg *QueryOptions) MarshalBinary() ([]byte, error)
MarshalBinary implements encoding.BinaryMarshaler
func (*QueryOptions) MarshalToSizedBuffer ¶ added in v1.8.2
func (m *QueryOptions) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*QueryOptions) ProtoMessage ¶
func (*QueryOptions) ProtoMessage()
func (*QueryOptions) Reset ¶
func (m *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) Size ¶
func (m *QueryOptions) Size() (n int)
func (*QueryOptions) String ¶
func (m *QueryOptions) String() string
func (*QueryOptions) TokenSecret ¶
func (q *QueryOptions) TokenSecret() string
func (*QueryOptions) Unmarshal ¶
func (m *QueryOptions) Unmarshal(dAtA []byte) error
func (*QueryOptions) UnmarshalBinary ¶
func (msg *QueryOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary implements encoding.BinaryUnmarshaler
func (*QueryOptions) XXX_DiscardUnknown ¶
func (m *QueryOptions) XXX_DiscardUnknown()
func (*QueryOptions) XXX_Marshal ¶
func (m *QueryOptions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*QueryOptions) XXX_Merge ¶
func (m *QueryOptions) XXX_Merge(src proto.Message)
func (*QueryOptions) XXX_Size ¶
func (m *QueryOptions) XXX_Size() int
func (*QueryOptions) XXX_Unmarshal ¶
func (m *QueryOptions) XXX_Unmarshal(b []byte) error
type RaftIndex ¶
type RaftIndex struct { CreateIndex uint64 `protobuf:"varint,1,opt,name=CreateIndex,proto3" json:"CreateIndex,omitempty" bexpr:"-"` ModifyIndex uint64 `protobuf:"varint,2,opt,name=ModifyIndex,proto3" json:"ModifyIndex,omitempty" bexpr:"-"` }
RaftIndex is used to track the index used while creating or modifying a given struct type.
func (*RaftIndex) Descriptor ¶
func (*RaftIndex) MarshalBinary ¶
MarshalBinary implements encoding.BinaryMarshaler
func (*RaftIndex) MarshalToSizedBuffer ¶ added in v1.8.2
func (*RaftIndex) ProtoMessage ¶
func (*RaftIndex) ProtoMessage()
func (*RaftIndex) UnmarshalBinary ¶
UnmarshalBinary implements encoding.BinaryUnmarshaler
func (*RaftIndex) XXX_DiscardUnknown ¶
func (m *RaftIndex) XXX_DiscardUnknown()
func (*RaftIndex) XXX_Marshal ¶
func (*RaftIndex) XXX_Unmarshal ¶
type ReadRequest ¶ added in v1.11.0
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"` }
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 ¶ added in v1.11.0
func (r *ReadRequest) AllowStaleRead() bool
AllowStaleRead implements structs.RPCInfo
func (*ReadRequest) Descriptor ¶ added in v1.11.0
func (*ReadRequest) Descriptor() ([]byte, []int)
func (*ReadRequest) GetRequireConsistent ¶ added in v1.11.0
func (m *ReadRequest) GetRequireConsistent() bool
func (*ReadRequest) GetToken ¶ added in v1.11.0
func (m *ReadRequest) GetToken() string
func (*ReadRequest) HasTimedOut ¶ added in v1.11.0
func (r *ReadRequest) HasTimedOut(start time.Time, rpcHoldTimeout, maxQueryTime, defaultQueryTime time.Duration) bool
HasTimedOut implements structs.RPCInfo
func (*ReadRequest) IsRead ¶ added in v1.11.0
func (r *ReadRequest) IsRead() bool
IsRead implements structs.RPCInfo
func (*ReadRequest) Marshal ¶ added in v1.11.0
func (m *ReadRequest) Marshal() (dAtA []byte, err error)
func (*ReadRequest) MarshalBinary ¶ added in v1.11.0
func (msg *ReadRequest) MarshalBinary() ([]byte, error)
MarshalBinary implements encoding.BinaryMarshaler
func (*ReadRequest) MarshalTo ¶ added in v1.11.0
func (m *ReadRequest) MarshalTo(dAtA []byte) (int, error)
func (*ReadRequest) MarshalToSizedBuffer ¶ added in v1.11.0
func (m *ReadRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*ReadRequest) ProtoMessage ¶ added in v1.11.0
func (*ReadRequest) ProtoMessage()
func (*ReadRequest) Reset ¶ added in v1.11.0
func (m *ReadRequest) Reset()
func (*ReadRequest) SetTokenSecret ¶ added in v1.11.0
func (r *ReadRequest) SetTokenSecret(token string)
SetTokenSecret implements structs.RPCInfo
func (*ReadRequest) Size ¶ added in v1.11.0
func (m *ReadRequest) Size() (n int)
func (*ReadRequest) String ¶ added in v1.11.0
func (m *ReadRequest) String() string
func (*ReadRequest) TokenSecret ¶ added in v1.11.0
func (r *ReadRequest) TokenSecret() string
TokenSecret implements structs.RPCInfo
func (*ReadRequest) Unmarshal ¶ added in v1.11.0
func (m *ReadRequest) Unmarshal(dAtA []byte) error
func (*ReadRequest) UnmarshalBinary ¶ added in v1.11.0
func (msg *ReadRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary implements encoding.BinaryUnmarshaler
func (*ReadRequest) XXX_DiscardUnknown ¶ added in v1.11.0
func (m *ReadRequest) XXX_DiscardUnknown()
func (*ReadRequest) XXX_Marshal ¶ added in v1.11.0
func (m *ReadRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ReadRequest) XXX_Merge ¶ added in v1.11.0
func (m *ReadRequest) XXX_Merge(src proto.Message)
func (*ReadRequest) XXX_Size ¶ added in v1.11.0
func (m *ReadRequest) XXX_Size() int
func (*ReadRequest) XXX_Unmarshal ¶ added in v1.11.0
func (m *ReadRequest) XXX_Unmarshal(b []byte) error
type TargetDatacenter ¶
type TargetDatacenter struct {
Datacenter string `protobuf:"bytes,1,opt,name=Datacenter,proto3" json:"Datacenter,omitempty"`
}
TargetDatacenter is intended to be used within other messages used for RPC routing amongst the various Consul datacenters
func (*TargetDatacenter) Descriptor ¶
func (*TargetDatacenter) Descriptor() ([]byte, []int)
func (*TargetDatacenter) Marshal ¶
func (m *TargetDatacenter) Marshal() (dAtA []byte, err error)
func (*TargetDatacenter) MarshalBinary ¶
func (msg *TargetDatacenter) MarshalBinary() ([]byte, error)
MarshalBinary implements encoding.BinaryMarshaler
func (*TargetDatacenter) MarshalToSizedBuffer ¶ added in v1.8.2
func (m *TargetDatacenter) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*TargetDatacenter) ProtoMessage ¶
func (*TargetDatacenter) ProtoMessage()
func (TargetDatacenter) RequestDatacenter ¶
func (td TargetDatacenter) RequestDatacenter() string
RequestDatacenter implements structs.RPCInfo
func (*TargetDatacenter) Reset ¶
func (m *TargetDatacenter) Reset()
func (*TargetDatacenter) Size ¶
func (m *TargetDatacenter) Size() (n int)
func (*TargetDatacenter) String ¶
func (m *TargetDatacenter) String() string
func (*TargetDatacenter) Unmarshal ¶
func (m *TargetDatacenter) Unmarshal(dAtA []byte) error
func (*TargetDatacenter) UnmarshalBinary ¶
func (msg *TargetDatacenter) UnmarshalBinary(b []byte) error
UnmarshalBinary implements encoding.BinaryUnmarshaler
func (*TargetDatacenter) XXX_DiscardUnknown ¶
func (m *TargetDatacenter) XXX_DiscardUnknown()
func (*TargetDatacenter) XXX_Marshal ¶
func (m *TargetDatacenter) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*TargetDatacenter) XXX_Merge ¶
func (m *TargetDatacenter) XXX_Merge(src proto.Message)
func (*TargetDatacenter) XXX_Size ¶
func (m *TargetDatacenter) XXX_Size() int
func (*TargetDatacenter) XXX_Unmarshal ¶
func (m *TargetDatacenter) XXX_Unmarshal(b []byte) error
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"` }
func (WriteRequest) AllowStaleRead ¶
func (w WriteRequest) AllowStaleRead() bool
AllowStaleRead returns whether a stale read should be allowed
AllowStaleRead implements structs.RPCInfo
func (*WriteRequest) Descriptor ¶
func (*WriteRequest) Descriptor() ([]byte, []int)
func (*WriteRequest) GetToken ¶
func (m *WriteRequest) GetToken() string
func (WriteRequest) HasTimedOut ¶ added in v1.11.0
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) Marshal ¶
func (m *WriteRequest) Marshal() (dAtA []byte, err error)
func (*WriteRequest) MarshalBinary ¶
func (msg *WriteRequest) MarshalBinary() ([]byte, error)
MarshalBinary implements encoding.BinaryMarshaler
func (*WriteRequest) MarshalToSizedBuffer ¶ added in v1.8.2
func (m *WriteRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*WriteRequest) ProtoMessage ¶
func (*WriteRequest) ProtoMessage()
func (*WriteRequest) Reset ¶
func (m *WriteRequest) Reset()
func (*WriteRequest) SetTokenSecret ¶
func (w *WriteRequest) SetTokenSecret(s string)
SetTokenSecret implements structs.RPCInfo
func (*WriteRequest) Size ¶
func (m *WriteRequest) Size() (n int)
func (*WriteRequest) String ¶
func (m *WriteRequest) String() string
func (WriteRequest) TokenSecret ¶
func (w WriteRequest) TokenSecret() string
SetTokenSecret implements structs.RPCInfo
func (*WriteRequest) Unmarshal ¶
func (m *WriteRequest) Unmarshal(dAtA []byte) error
func (*WriteRequest) UnmarshalBinary ¶
func (msg *WriteRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary implements encoding.BinaryUnmarshaler
func (*WriteRequest) XXX_DiscardUnknown ¶
func (m *WriteRequest) XXX_DiscardUnknown()
func (*WriteRequest) XXX_Marshal ¶
func (m *WriteRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*WriteRequest) XXX_Merge ¶
func (m *WriteRequest) XXX_Merge(src proto.Message)
func (*WriteRequest) XXX_Size ¶
func (m *WriteRequest) XXX_Size() int
func (*WriteRequest) XXX_Unmarshal ¶
func (m *WriteRequest) XXX_Unmarshal(b []byte) error