Skip to content

K
k3s
Commit 69bb0fce authored by Wojciech Tyczynski's avatar Wojciech Tyczynski
Browse files
Options

Update comments for ListOptions

parent 0bea8ca3
Hide whitespace changes
Inline Side-by-side
Showing with 8 additions and 3 deletions
pkg/api/types.go
View file @ 69bb0fce
...@@ -2797,11 +2797,12 @@ type ListOptions struct { ...@@ -2797,11 +2797,12 @@ type ListOptions struct {
FieldSelector fields.Selector FieldSelector fields.Selector
// If true, watch for changes to this list // If true, watch for changes to this list
Watch bool Watch bool
// For watch, it's the resource version to watch. // When specified with a watch call, shows changes that occur after that particular version of a resource.
// For list, // Defaults to changes from the beginning of history.
// When specified for list:
// - if unset, then the result is returned from remote storage based on quorum-read flag; // - if unset, then the result is returned from remote storage based on quorum-read flag;
// - if it's 0, then we simply return what we currently have in cache, no guarantee; // - if it's 0, then we simply return what we currently have in cache, no guarantee;
// - if set to non zero, then the result is as fresh as given rv. // - if set to non zero, then the result is at least as fresh as given rv.
ResourceVersion string ResourceVersion string
// Timeout for the list/watch call. // Timeout for the list/watch call.
TimeoutSeconds *int64 TimeoutSeconds *int64
......
pkg/api/v1/types.go
View file @ 69bb0fce
...@@ -3233,6 +3233,10 @@ type ListOptions struct { ...@@ -3233,6 +3233,10 @@ type ListOptions struct {
Watch bool `json:"watch,omitempty" protobuf:"varint,3,opt,name=watch"` Watch bool `json:"watch,omitempty" protobuf:"varint,3,opt,name=watch"`
// When specified with a watch call, shows changes that occur after that particular version of a resource. // When specified with a watch call, shows changes that occur after that particular version of a resource.
// Defaults to changes from the beginning of history. // Defaults to changes from the beginning of history.
// When specified for list:
// - if unset, then the result is returned from remote storage based on quorum-read flag;
// - if it's 0, then we simply return what we currently have in cache, no guarantee;
// - if set to non zero, then the result is at least as fresh as given rv.
// +optional // +optional
ResourceVersion string `json:"resourceVersion,omitempty" protobuf:"bytes,4,opt,name=resourceVersion"` ResourceVersion string `json:"resourceVersion,omitempty" protobuf:"bytes,4,opt,name=resourceVersion"`
// Timeout for the list/watch call. // Timeout for the list/watch call.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment