github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Lister codegen: Clarify that returned objects are read-only

Browse Source
This commit is contained in:
Alvaro Aleman
2020-03-22 12:33:14 -04:00
parent d3df233d9c
commit 36c15371eb
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
staging/src/k8s.io/code-generator/cmd/lister-gen/generators/lister.go
View File

@@ -258,8 +258,10 @@ func (g *listerGenerator) GenerateType(c *generator.Context, t *types.Type, w io
var typeListerInterface = ` var typeListerInterface = `
// $.type|public$Lister helps list $.type|publicPlural$. // $.type|public$Lister helps list $.type|publicPlural$.
// All objects returned here must be treated as read-only.
type $.type|public$Lister interface { type $.type|public$Lister interface {
// List lists all $.type|publicPlural$ in the indexer. // List lists all $.type|publicPlural$ in the indexer.
// Objects returned here must be treated as read-only.
List(selector labels.Selector) (ret []*$.type|raw$, err error) List(selector labels.Selector) (ret []*$.type|raw$, err error)
// $.type|publicPlural$ returns an object that can list and get $.type|publicPlural$. // $.type|publicPlural$ returns an object that can list and get $.type|publicPlural$.
$.type|publicPlural$(namespace string) $.type|public$NamespaceLister $.type|publicPlural$(namespace string) $.type|public$NamespaceLister
@@ -269,10 +271,13 @@ type $.type|public$Lister interface {
var typeListerInterface_NonNamespaced = ` var typeListerInterface_NonNamespaced = `
// $.type|public$Lister helps list $.type|publicPlural$. // $.type|public$Lister helps list $.type|publicPlural$.
// All objects returned here must be treated as read-only.
type $.type|public$Lister interface { type $.type|public$Lister interface {
// List lists all $.type|publicPlural$ in the indexer. // List lists all $.type|publicPlural$ in the indexer.
// Objects returned here must be treated as read-only.
List(selector labels.Selector) (ret []*$.type|raw$, err error) List(selector labels.Selector) (ret []*$.type|raw$, err error)
// Get retrieves the $.type|public$ from the index for a given name. // Get retrieves the $.type|public$ from the index for a given name.
// Objects returned here must be treated as read-only.
Get(name string) (*$.type|raw$, error) Get(name string) (*$.type|raw$, error)
$.type|public$ListerExpansion $.type|public$ListerExpansion
} }
@@ -325,10 +330,13 @@ func (s *$.type|private$Lister) Get(name string) (*$.type|raw$, error) {
var namespaceListerInterface = ` var namespaceListerInterface = `
// $.type|public$NamespaceLister helps list and get $.type|publicPlural$. // $.type|public$NamespaceLister helps list and get $.type|publicPlural$.
// All objects returned here must be treated as read-only.
type $.type|public$NamespaceLister interface { type $.type|public$NamespaceLister interface {
// List lists all $.type|publicPlural$ in the indexer for a given namespace. // List lists all $.type|publicPlural$ in the indexer for a given namespace.
// Objects returned here must be treated as read-only.
List(selector labels.Selector) (ret []*$.type|raw$, err error) List(selector labels.Selector) (ret []*$.type|raw$, err error)
// Get retrieves the $.type|public$ from the indexer for a given namespace and name. // Get retrieves the $.type|public$ from the indexer for a given namespace and name.
// Objects returned here must be treated as read-only.
Get(name string) (*$.type|raw$, error) Get(name string) (*$.type|raw$, error)
$.type|public$NamespaceListerExpansion $.type|public$NamespaceListerExpansion
} }