unversioned

package
v1.5.6 Latest Latest
Warning

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

 Go to latest Published: Mar 28, 2017 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview 

Package unversioned is a generated protocol buffer package.

It is generated from these files:
	k8s.io/kubernetes/pkg/api/unversioned/generated.proto

It has these top-level messages:
	APIGroup
	APIGroupList
	APIResource
	APIResourceList
	APIVersions
	Duration
	ExportOptions
	GroupKind
	GroupResource
	GroupVersion
	GroupVersionForDiscovery
	GroupVersionKind
	GroupVersionResource
	LabelSelector
	LabelSelectorRequirement
	ListMeta
	RootPaths
	ServerAddressByClientCIDR
	Status
	StatusCause
	StatusDetails
	Time
	Timestamp
	TypeMeta

Package unversioned contains API types that are common to all versions.

The package contains two categories of types:

  • external (serialized) types that lack their own version (e.g TypeMeta)
  • internal (never-serialized) types that are needed by several different api groups, and so live here, to avoid duplication and/or import loops (e.g. LabelSelector).

In the future, we will probably move these categories of objects into separate packages.

Index

Constants

View Source 
const (
	StatusSuccess = "Success"
	StatusFailure = "Failure"
)

Values of Status.Status

View Source 
const (
	// If you add a new topology domain here, also consider adding it to the set of default values
	// for the scheduler's --failure-domain command-line argument.
	LabelHostname          = "kubernetes.io/hostname"
	LabelZoneFailureDomain = "failure-domain.beta.kubernetes.io/zone"
	LabelZoneRegion        = "failure-domain.beta.kubernetes.io/region"

	LabelInstanceType = "beta.kubernetes.io/instance-type"

	LabelOS   = "beta.kubernetes.io/os"
	LabelArch = "beta.kubernetes.io/arch"
)
View Source 
const (
	// NodeLabelRole is the preferred label applied to a Node as a hint that it has a particular purpose (defined by the value).
	NodeLabelRole = "kubernetes.io/role"

	// NodeLabelKubeadmAlphaRole is a label that kubeadm applies to a Node as a hint that it has a particular purpose.
	// Use of NodeLabelRole is preferred.
	NodeLabelKubeadmAlphaRole = "kubeadm.alpha.kubernetes.io/role"

	// NodeLabelRoleMaster is the value of a NodeLabelRole or NodeLabelKubeadmAlphaRole label, indicating a master node.
	// A master node typically runs kubernetes system components and will not typically run user workloads.
	NodeLabelRoleMaster = "master"

	// NodeLabelRoleNode is the value of a NodeLabelRole or NodeLabelKubeadmAlphaRole label, indicating a "normal" node,
	// as opposed to a RoleMaster node.
	NodeLabelRoleNode = "node"
)

Variables

View Source 
var (
	ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
)
View Source 
var EmptyObjectKind = emptyObjectKind{}

EmptyObjectKind implements the ObjectKind interface as a noop TODO: this belongs in pkg/runtime, move unversioned.GVK into runtime.

View Source 
var SchemeGroupVersion = GroupVersion{Group: "", Version: ""}

SchemeGroupVersion is group version used to register these objects

Functions

func DeepCopy_unversioned_APIGroup added in v1.3.0 

func DeepCopy_unversioned_APIGroup(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_APIGroupList added in v1.3.0 

func DeepCopy_unversioned_APIGroupList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_APIResource added in v1.3.0 

func DeepCopy_unversioned_APIResource(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_APIResourceList added in v1.3.0 

func DeepCopy_unversioned_APIResourceList(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_APIVersions added in v1.3.0 

func DeepCopy_unversioned_APIVersions(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_Duration added in v1.3.0 

func DeepCopy_unversioned_Duration(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_ExportOptions added in v1.3.0 

func DeepCopy_unversioned_ExportOptions(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_GroupKind added in v1.3.0 

func DeepCopy_unversioned_GroupKind(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_GroupResource added in v1.3.0 

func DeepCopy_unversioned_GroupResource(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_GroupVersion added in v1.3.0 

func DeepCopy_unversioned_GroupVersion(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_GroupVersionForDiscovery added in v1.3.0 

func DeepCopy_unversioned_GroupVersionForDiscovery(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_GroupVersionKind added in v1.3.0 

func DeepCopy_unversioned_GroupVersionKind(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_GroupVersionResource added in v1.3.0 

func DeepCopy_unversioned_GroupVersionResource(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_LabelSelector added in v1.3.0 

func DeepCopy_unversioned_LabelSelector(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_LabelSelectorRequirement added in v1.3.0 

func DeepCopy_unversioned_LabelSelectorRequirement(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_ListMeta added in v1.3.0 

func DeepCopy_unversioned_ListMeta(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_Patch added in v1.3.0 

func DeepCopy_unversioned_Patch(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_RootPaths added in v1.3.0 

func DeepCopy_unversioned_RootPaths(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_ServerAddressByClientCIDR added in v1.3.0 

func DeepCopy_unversioned_ServerAddressByClientCIDR(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_Status added in v1.3.0 

func DeepCopy_unversioned_Status(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_StatusCause added in v1.3.0 

func DeepCopy_unversioned_StatusCause(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_StatusDetails added in v1.3.0 

func DeepCopy_unversioned_StatusDetails(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_Time added in v1.3.0 

func DeepCopy_unversioned_Time(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_Timestamp added in v1.3.0 

func DeepCopy_unversioned_Timestamp(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_unversioned_TypeMeta added in v1.3.0 

func DeepCopy_unversioned_TypeMeta(in interface{}, out interface{}, c *conversion.Cloner) error

func ExtractGroupVersions added in v1.2.0 

func ExtractGroupVersions(l *APIGroupList) []string

func FieldSelectorQueryParam added in v1.2.0 

func FieldSelectorQueryParam(version string) string

TODO: remove me when watch is refactored

func FormatLabelSelector added in v1.2.0 

func FormatLabelSelector(labelSelector *LabelSelector) string

FormatLabelSelector convert labelSelector into plain string

func LabelSelectorAsMap added in v1.4.0 

func LabelSelectorAsMap(ps *LabelSelector) (map[string]string, error)

LabelSelectorAsMap converts the LabelSelector api type into a map of strings, ie. the original structure of a label selector. Operators that cannot be converted into plain labels (Exists, DoesNotExist, NotIn, and In with more than one value) will result in an error.

func LabelSelectorAsSelector added in v1.2.0 

func LabelSelectorAsSelector(ps *LabelSelector) (labels.Selector, error)

LabelSelectorAsSelector converts the LabelSelector api type into a struct that implements labels.Selector Note: This function should be kept in sync with the selector methods in pkg/labels/selector.go

func LabelSelectorQueryParam added in v1.2.0 

func LabelSelectorQueryParam(version string) string

TODO: remove me when watch is refactored

func ParseResourceArg added in v1.2.0 

func ParseResourceArg(arg string) (*GroupVersionResource, GroupResource)

ParseResourceArg takes the common style of string which may be either `resource.group.com` or `resource.version.group.com` and parses it out into both possibilities. This code takes no responsibility for knowing which representation was intended but with a knowledge of all GroupVersions, calling code can take a very good guess. If there are only two segments, then `*GroupVersionResource` is nil. `resource.group.com` -> `group=com, version=group, resource=resource` and `group=group.com, resource=resource`

Types

type APIGroup added in v1.2.0 

type APIGroup struct {
	TypeMeta `json:",inline"`
	// name is the name of the group.
	Name string `json:"name" protobuf:"bytes,1,opt,name=name"`
	// versions are the versions supported in this group.
	Versions []GroupVersionForDiscovery `json:"versions" protobuf:"bytes,2,rep,name=versions"`
	// preferredVersion is the version preferred by the API server, which
	// probably is the storage version.
	// +optional
	PreferredVersion GroupVersionForDiscovery `json:"preferredVersion,omitempty" protobuf:"bytes,3,opt,name=preferredVersion"`
	// a map of client CIDR to server address that is serving this group.
	// This is to help clients reach servers in the most network-efficient way possible.
	// Clients can use the appropriate server address as per the CIDR that they match.
	// In case of multiple matches, clients should use the longest matching CIDR.
	// The server returns only those CIDRs that it thinks that the client can match.
	// For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP.
	// Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
	ServerAddressByClientCIDRs []ServerAddressByClientCIDR `json:"serverAddressByClientCIDRs" protobuf:"bytes,4,rep,name=serverAddressByClientCIDRs"`
}

APIGroup contains the name, the supported versions, and the preferred version of a group.

func (*APIGroup) Descriptor added in v1.4.0 

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

func (*APIGroup) Marshal added in v1.3.0 

func (m *APIGroup) Marshal() (data []byte, err error)

func (*APIGroup) MarshalTo added in v1.3.0 

func (m *APIGroup) MarshalTo(data []byte) (int, error)

func (*APIGroup) ProtoMessage added in v1.3.0 

func (*APIGroup) ProtoMessage()

func (*APIGroup) Reset added in v1.3.0 

func (m *APIGroup) Reset()

func (*APIGroup) Size added in v1.3.0 

func (m *APIGroup) Size() (n int)

func (*APIGroup) String added in v1.3.0 

func (this *APIGroup) String() string

func (APIGroup) SwaggerDoc added in v1.2.0 

func (APIGroup) SwaggerDoc() map[string]string

func (*APIGroup) Unmarshal added in v1.3.0 

func (m *APIGroup) Unmarshal(data []byte) error

type APIGroupList added in v1.2.0 

type APIGroupList struct {
	TypeMeta `json:",inline"`
	// groups is a list of APIGroup.
	Groups []APIGroup `json:"groups" protobuf:"bytes,1,rep,name=groups"`
}

APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.

func (*APIGroupList) Descriptor added in v1.4.0 

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

func (*APIGroupList) Marshal added in v1.3.0 

func (m *APIGroupList) Marshal() (data []byte, err error)

func (*APIGroupList) MarshalTo added in v1.3.0 

func (m *APIGroupList) MarshalTo(data []byte) (int, error)

func (*APIGroupList) ProtoMessage added in v1.3.0 

func (*APIGroupList) ProtoMessage()

func (*APIGroupList) Reset added in v1.3.0 

func (m *APIGroupList) Reset()

func (*APIGroupList) Size added in v1.3.0 

func (m *APIGroupList) Size() (n int)

func (*APIGroupList) String added in v1.3.0 

func (this *APIGroupList) String() string

func (APIGroupList) SwaggerDoc added in v1.2.0 

func (APIGroupList) SwaggerDoc() map[string]string

func (*APIGroupList) Unmarshal added in v1.3.0 

func (m *APIGroupList) Unmarshal(data []byte) error

type APIResource added in v1.2.0 

type APIResource struct {
	// name is the name of the resource.
	Name string `json:"name" protobuf:"bytes,1,opt,name=name"`
	// namespaced indicates if a resource is namespaced or not.
	Namespaced bool `json:"namespaced" protobuf:"varint,2,opt,name=namespaced"`
	// kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
	Kind string `json:"kind" protobuf:"bytes,3,opt,name=kind"`
}

APIResource specifies the name of a resource and whether it is namespaced.

func (*APIResource) Descriptor added in v1.4.0 

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

func (*APIResource) Marshal added in v1.3.0 

func (m *APIResource) Marshal() (data []byte, err error)

func (*APIResource) MarshalTo added in v1.3.0 

func (m *APIResource) MarshalTo(data []byte) (int, error)

func (*APIResource) ProtoMessage added in v1.3.0 

func (*APIResource) ProtoMessage()

func (*APIResource) Reset added in v1.3.0 

func (m *APIResource) Reset()

func (*APIResource) Size added in v1.3.0 

func (m *APIResource) Size() (n int)

func (*APIResource) String added in v1.3.0 

func (this *APIResource) String() string

func (APIResource) SwaggerDoc added in v1.2.0 

func (APIResource) SwaggerDoc() map[string]string

func (*APIResource) Unmarshal added in v1.3.0 

func (m *APIResource) Unmarshal(data []byte) error

type APIResourceList added in v1.2.0 

type APIResourceList struct {
	TypeMeta `json:",inline"`
	// groupVersion is the group and version this APIResourceList is for.
	GroupVersion string `json:"groupVersion" protobuf:"bytes,1,opt,name=groupVersion"`
	// resources contains the name of the resources and if they are namespaced.
	APIResources []APIResource `json:"resources" protobuf:"bytes,2,rep,name=resources"`
}

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

func (*APIResourceList) Descriptor added in v1.4.0 

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

func (*APIResourceList) Marshal added in v1.3.0 

func (m *APIResourceList) Marshal() (data []byte, err error)

func (*APIResourceList) MarshalTo added in v1.3.0 

func (m *APIResourceList) MarshalTo(data []byte) (int, error)

func (*APIResourceList) ProtoMessage added in v1.3.0 

func (*APIResourceList) ProtoMessage()

func (*APIResourceList) Reset added in v1.3.0 

func (m *APIResourceList) Reset()

func (*APIResourceList) Size added in v1.3.0 

func (m *APIResourceList) Size() (n int)

func (*APIResourceList) String added in v1.3.0 

func (this *APIResourceList) String() string

func (APIResourceList) SwaggerDoc added in v1.2.0 

func (APIResourceList) SwaggerDoc() map[string]string

func (*APIResourceList) Unmarshal added in v1.3.0 

func (m *APIResourceList) Unmarshal(data []byte) error

type APIVersions added in v1.2.0 

type APIVersions struct {
	TypeMeta `json:",inline"`
	// versions are the api versions that are available.
	Versions []string `json:"versions" protobuf:"bytes,1,rep,name=versions"`
	// a map of client CIDR to server address that is serving this group.
	// This is to help clients reach servers in the most network-efficient way possible.
	// Clients can use the appropriate server address as per the CIDR that they match.
	// In case of multiple matches, clients should use the longest matching CIDR.
	// The server returns only those CIDRs that it thinks that the client can match.
	// For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP.
	// Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
	ServerAddressByClientCIDRs []ServerAddressByClientCIDR `json:"serverAddressByClientCIDRs" protobuf:"bytes,2,rep,name=serverAddressByClientCIDRs"`
}

APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.

+protobuf.options.(gogoproto.goproto_stringer)=false

func (*APIVersions) Descriptor added in v1.4.0 

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

func (APIVersions) GoString added in v1.2.0 

func (apiVersions APIVersions) GoString() string

func (*APIVersions) Marshal added in v1.3.0 

func (m *APIVersions) Marshal() (data []byte, err error)

func (*APIVersions) MarshalTo added in v1.3.0 

func (m *APIVersions) MarshalTo(data []byte) (int, error)

func (*APIVersions) ProtoMessage added in v1.3.0 

func (*APIVersions) ProtoMessage()

func (*APIVersions) Reset added in v1.3.0 

func (m *APIVersions) Reset()

func (*APIVersions) Size added in v1.3.0 

func (m *APIVersions) Size() (n int)

func (APIVersions) String added in v1.2.0 

func (apiVersions APIVersions) String() string

String returns available api versions as a human-friendly version string.

func (APIVersions) SwaggerDoc added in v1.2.0 

func (APIVersions) SwaggerDoc() map[string]string

func (*APIVersions) Unmarshal added in v1.3.0 

func (m *APIVersions) Unmarshal(data []byte) error

type CauseType 

type CauseType string

CauseType is a machine readable value providing more detail about what occurred in a status response. An operation may have multiple causes for a status (whether Failure or Success). 

const (
	// CauseTypeFieldValueNotFound is used to report failure to find a requested value
	// (e.g. looking up an ID).
	CauseTypeFieldValueNotFound CauseType = "FieldValueNotFound"
	// CauseTypeFieldValueRequired is used to report required values that are not
	// provided (e.g. empty strings, null values, or empty arrays).
	CauseTypeFieldValueRequired CauseType = "FieldValueRequired"
	// CauseTypeFieldValueDuplicate is used to report collisions of values that must be
	// unique (e.g. unique IDs).
	CauseTypeFieldValueDuplicate CauseType = "FieldValueDuplicate"
	// CauseTypeFieldValueInvalid is used to report malformed values (e.g. failed regex
	// match).
	CauseTypeFieldValueInvalid CauseType = "FieldValueInvalid"
	// CauseTypeFieldValueNotSupported is used to report valid (as per formatting rules)
	// values that can not be handled (e.g. an enumerated string).
	CauseTypeFieldValueNotSupported CauseType = "FieldValueNotSupported"
	// CauseTypeUnexpectedServerResponse is used to report when the server responded to the client
	// without the expected return type. The presence of this cause indicates the error may be
	// due to an intervening proxy or the server software malfunctioning.
	CauseTypeUnexpectedServerResponse CauseType = "UnexpectedServerResponse"
)

type Duration 

type Duration struct {
	time.Duration `protobuf:"varint,1,opt,name=duration,casttype=time.Duration"`
}

Duration is a wrapper around time.Duration which supports correct marshaling to YAML and JSON. In particular, it marshals into strings, which can be used as map keys in json.

func (*Duration) Descriptor added in v1.4.0 

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

func (*Duration) Marshal added in v1.3.0 

func (m *Duration) Marshal() (data []byte, err error)

func (Duration) MarshalJSON 

func (d Duration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*Duration) MarshalTo added in v1.3.0 

func (m *Duration) MarshalTo(data []byte) (int, error)

func (*Duration) ProtoMessage added in v1.3.0 

func (*Duration) ProtoMessage()

func (*Duration) Reset added in v1.3.0 

func (m *Duration) Reset()

func (*Duration) Size added in v1.3.0 

func (m *Duration) Size() (n int)

func (*Duration) String added in v1.3.0 

func (this *Duration) String() string

func (*Duration) Unmarshal added in v1.3.0 

func (m *Duration) Unmarshal(data []byte) error

func (*Duration) UnmarshalJSON 

func (d *Duration) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the json.Unmarshaller interface.

type ExportOptions added in v1.2.0 

type ExportOptions struct {
	TypeMeta `json:",inline"`
	// Should this value be exported.  Export strips fields that a user can not specify.`
	Export bool `json:"export" protobuf:"varint,1,opt,name=export"`
	// Should the export be exact.  Exact export maintains cluster-specific fields like 'Namespace'
	Exact bool `json:"exact" protobuf:"varint,2,opt,name=exact"`
}

ExportOptions is the query options to the standard REST get call.

func (*ExportOptions) Descriptor added in v1.4.0 

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

func (*ExportOptions) Marshal added in v1.3.0 

func (m *ExportOptions) Marshal() (data []byte, err error)

func (*ExportOptions) MarshalTo added in v1.3.0 

func (m *ExportOptions) MarshalTo(data []byte) (int, error)

func (*ExportOptions) ProtoMessage added in v1.3.0 

func (*ExportOptions) ProtoMessage()

func (*ExportOptions) Reset added in v1.3.0 

func (m *ExportOptions) Reset()

func (*ExportOptions) Size added in v1.3.0 

func (m *ExportOptions) Size() (n int)

func (*ExportOptions) String added in v1.3.0 

func (this *ExportOptions) String() string

func (ExportOptions) SwaggerDoc added in v1.2.0 

func (ExportOptions) SwaggerDoc() map[string]string

func (*ExportOptions) Unmarshal added in v1.3.0 

func (m *ExportOptions) Unmarshal(data []byte) error

type GroupKind added in v1.2.0 

type GroupKind struct {
	Group string `protobuf:"bytes,1,opt,name=group"`
	Kind  string `protobuf:"bytes,2,opt,name=kind"`
}

GroupKind specifies a Group and a Kind, but does not force a version. This is useful for identifying concepts during lookup stages without having partially valid types

+protobuf.options.(gogoproto.goproto_stringer)=false

func Kind added in v1.2.0 

func Kind(kind string) GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func (*GroupKind) Descriptor added in v1.4.0 

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

func (GroupKind) Empty added in v1.4.0 

func (gk GroupKind) Empty() bool

func (*GroupKind) Marshal added in v1.3.0 

func (m *GroupKind) Marshal() (data []byte, err error)

func (*GroupKind) MarshalTo added in v1.3.0 

func (m *GroupKind) MarshalTo(data []byte) (int, error)

func (*GroupKind) ProtoMessage added in v1.3.0 

func (*GroupKind) ProtoMessage()

func (*GroupKind) Reset added in v1.3.0 

func (m *GroupKind) Reset()

func (*GroupKind) Size added in v1.3.0 

func (m *GroupKind) Size() (n int)

func (*GroupKind) String added in v1.2.0 

func (gk *GroupKind) String() string

func (*GroupKind) Unmarshal added in v1.3.0 

func (m *GroupKind) Unmarshal(data []byte) error

func (GroupKind) WithVersion added in v1.2.0 

func (gk GroupKind) WithVersion(version string) GroupVersionKind

type GroupResource added in v1.2.0 

type GroupResource struct {
	Group    string `protobuf:"bytes,1,opt,name=group"`
	Resource string `protobuf:"bytes,2,opt,name=resource"`
}

GroupResource specifies a Group and a Resource, but does not force a version. This is useful for identifying concepts during lookup stages without having partially valid types

+protobuf.options.(gogoproto.goproto_stringer)=false

func ParseGroupResource added in v1.2.0 

func ParseGroupResource(gr string) GroupResource

ParseGroupResource turns "resource.group" string into a GroupResource struct. Empty strings are allowed for each field.

func (*GroupResource) Descriptor added in v1.4.0 

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

func (GroupResource) Empty added in v1.4.0 

func (gr GroupResource) Empty() bool

func (*GroupResource) Marshal added in v1.3.0 

func (m *GroupResource) Marshal() (data []byte, err error)

func (*GroupResource) MarshalTo added in v1.3.0 

func (m *GroupResource) MarshalTo(data []byte) (int, error)

func (*GroupResource) ProtoMessage added in v1.3.0 

func (*GroupResource) ProtoMessage()

func (*GroupResource) Reset added in v1.3.0 

func (m *GroupResource) Reset()

func (*GroupResource) Size added in v1.3.0 

func (m *GroupResource) Size() (n int)

func (*GroupResource) String added in v1.2.0 

func (gr *GroupResource) String() string

func (*GroupResource) Unmarshal added in v1.3.0 

func (m *GroupResource) Unmarshal(data []byte) error

func (GroupResource) WithVersion added in v1.2.0 

func (gr GroupResource) WithVersion(version string) GroupVersionResource

type GroupVersion added in v1.2.0 

type GroupVersion struct {
	Group   string `protobuf:"bytes,1,opt,name=group"`
	Version string `protobuf:"bytes,2,opt,name=version"`
}

GroupVersion contains the "group" and the "version", which uniquely identifies the API.

+protobuf.options.(gogoproto.goproto_stringer)=false

func ParseGroupVersion added in v1.2.0 

func ParseGroupVersion(gv string) (GroupVersion, error)

ParseGroupVersion turns "group/version" string into a GroupVersion struct. It reports error if it cannot parse the string.

func (*GroupVersion) Descriptor added in v1.4.0 

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

func (GroupVersion) Empty added in v1.4.0 

func (gv GroupVersion) Empty() bool

Empty returns true if group and version are empty

func (GroupVersion) KindForGroupVersionKinds added in v1.4.0 

func (gv GroupVersion) KindForGroupVersionKinds(kinds []GroupVersionKind) (target GroupVersionKind, ok bool)

KindForGroupVersionKinds identifies the preferred GroupVersionKind out of a list. It returns ok false if none of the options match the group. It prefers a match to group and version over just group. TODO: Move GroupVersion to a package under pkg/runtime, since it's used by scheme. TODO: Introduce an adapter type between GroupVersion and runtime.GroupVersioner, and use LegacyCodec(GroupVersion) 

in fewer places.

func (*GroupVersion) Marshal added in v1.3.0 

func (m *GroupVersion) Marshal() (data []byte, err error)

func (GroupVersion) MarshalJSON added in v1.2.0 

func (gv GroupVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface.

func (*GroupVersion) MarshalTo added in v1.3.0 

func (m *GroupVersion) MarshalTo(data []byte) (int, error)

func (*GroupVersion) ProtoMessage added in v1.3.0 

func (*GroupVersion) ProtoMessage()

func (*GroupVersion) Reset added in v1.3.0 

func (m *GroupVersion) Reset()

func (*GroupVersion) Size added in v1.3.0 

func (m *GroupVersion) Size() (n int)

func (GroupVersion) String added in v1.2.0 

func (gv GroupVersion) String() string

String puts "group" and "version" into a single "group/version" string. For the legacy v1 it returns "v1".

func (*GroupVersion) Unmarshal added in v1.3.0 

func (m *GroupVersion) Unmarshal(data []byte) error

func (*GroupVersion) UnmarshalJSON added in v1.2.0 

func (gv *GroupVersion) UnmarshalJSON(value []byte) error

UnmarshalJSON implements the json.Unmarshaller interface.

func (*GroupVersion) UnmarshalText added in v1.2.0 

func (gv *GroupVersion) UnmarshalText(value []byte) error

UnmarshalTEXT implements the Ugorji's encoding.TextUnmarshaler interface.

func (GroupVersion) WithKind added in v1.2.0 

func (gv GroupVersion) WithKind(kind string) GroupVersionKind

WithKind creates a GroupVersionKind based on the method receiver's GroupVersion and the passed Kind.

func (GroupVersion) WithResource added in v1.2.0 

func (gv GroupVersion) WithResource(resource string) GroupVersionResource

WithResource creates a GroupVersionResource based on the method receiver's GroupVersion and the passed Resource.

type GroupVersionForDiscovery added in v1.2.0 

type GroupVersionForDiscovery struct {
	// groupVersion specifies the API group and version in the form "group/version"
	GroupVersion string `json:"groupVersion" protobuf:"bytes,1,opt,name=groupVersion"`
	// version specifies the version in the form of "version". This is to save
	// the clients the trouble of splitting the GroupVersion.
	Version string `json:"version" protobuf:"bytes,2,opt,name=version"`
}

GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.

func (*GroupVersionForDiscovery) Descriptor added in v1.4.0 

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

func (*GroupVersionForDiscovery) Marshal added in v1.3.0 

func (m *GroupVersionForDiscovery) Marshal() (data []byte, err error)

func (*GroupVersionForDiscovery) MarshalTo added in v1.3.0 

func (m *GroupVersionForDiscovery) MarshalTo(data []byte) (int, error)

func (*GroupVersionForDiscovery) ProtoMessage added in v1.3.0 

func (*GroupVersionForDiscovery) ProtoMessage()

func (*GroupVersionForDiscovery) Reset added in v1.3.0 

func (m *GroupVersionForDiscovery) Reset()

func (*GroupVersionForDiscovery) Size added in v1.3.0 

func (m *GroupVersionForDiscovery) Size() (n int)

func (*GroupVersionForDiscovery) String added in v1.3.0 

func (this *GroupVersionForDiscovery) String() string

func (GroupVersionForDiscovery) SwaggerDoc added in v1.2.0 

func (GroupVersionForDiscovery) SwaggerDoc() map[string]string

func (*GroupVersionForDiscovery) Unmarshal added in v1.3.0 

func (m *GroupVersionForDiscovery) Unmarshal(data []byte) error

type GroupVersionKind added in v1.2.0 

type GroupVersionKind struct {
	Group   string `protobuf:"bytes,1,opt,name=group"`
	Version string `protobuf:"bytes,2,opt,name=version"`
	Kind    string `protobuf:"bytes,3,opt,name=kind"`
}

GroupVersionKind unambiguously identifies a kind. It doesn't anonymously include GroupVersion to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling

+protobuf.options.(gogoproto.goproto_stringer)=false

func FromAPIVersionAndKind added in v1.2.0 

func FromAPIVersionAndKind(apiVersion, kind string) GroupVersionKind

FromAPIVersionAndKind returns a GVK representing the provided fields for types that do not use TypeMeta. This method exists to support test types and legacy serializations that have a distinct group and kind. TODO: further reduce usage of this method.

func (*GroupVersionKind) Descriptor added in v1.4.0 

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

func (GroupVersionKind) Empty added in v1.4.0 

func (gvk GroupVersionKind) Empty() bool

Empty returns true if group, version, and kind are empty

func (GroupVersionKind) GroupKind added in v1.2.0 

func (gvk GroupVersionKind) GroupKind() GroupKind

func (GroupVersionKind) GroupVersion added in v1.2.0 

func (gvk GroupVersionKind) GroupVersion() GroupVersion

func (*GroupVersionKind) Marshal added in v1.3.0 

func (m *GroupVersionKind) Marshal() (data []byte, err error)

func (*GroupVersionKind) MarshalTo added in v1.3.0 

func (m *GroupVersionKind) MarshalTo(data []byte) (int, error)

func (*GroupVersionKind) ProtoMessage added in v1.3.0 

func (*GroupVersionKind) ProtoMessage()

func (*GroupVersionKind) Reset added in v1.3.0 

func (m *GroupVersionKind) Reset()

func (*GroupVersionKind) Size added in v1.3.0 

func (m *GroupVersionKind) Size() (n int)

func (GroupVersionKind) String added in v1.2.0 

func (gvk GroupVersionKind) String() string

func (*GroupVersionKind) ToAPIVersionAndKind added in v1.2.0 

func (gvk *GroupVersionKind) ToAPIVersionAndKind() (string, string)

ToAPIVersionAndKind is a convenience method for satisfying runtime.Object on types that do not use TypeMeta.

func (*GroupVersionKind) Unmarshal added in v1.3.0 

func (m *GroupVersionKind) Unmarshal(data []byte) error

type GroupVersionResource added in v1.2.0 

type GroupVersionResource struct {
	Group    string `protobuf:"bytes,1,opt,name=group"`
	Version  string `protobuf:"bytes,2,opt,name=version"`
	Resource string `protobuf:"bytes,3,opt,name=resource"`
}

GroupVersionResource unambiguously identifies a resource. It doesn't anonymously include GroupVersion to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling

+protobuf.options.(gogoproto.goproto_stringer)=false

func (*GroupVersionResource) Descriptor added in v1.4.0 

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

func (GroupVersionResource) Empty added in v1.4.0 

func (gvr GroupVersionResource) Empty() bool

func (GroupVersionResource) GroupResource added in v1.2.0 

func (gvr GroupVersionResource) GroupResource() GroupResource

func (GroupVersionResource) GroupVersion added in v1.2.0 

func (gvr GroupVersionResource) GroupVersion() GroupVersion

func (*GroupVersionResource) Marshal added in v1.3.0 

func (m *GroupVersionResource) Marshal() (data []byte, err error)

func (*GroupVersionResource) MarshalTo added in v1.3.0 

func (m *GroupVersionResource) MarshalTo(data []byte) (int, error)

func (*GroupVersionResource) ProtoMessage added in v1.3.0 

func (*GroupVersionResource) ProtoMessage()

func (*GroupVersionResource) Reset added in v1.3.0 

func (m *GroupVersionResource) Reset()

func (*GroupVersionResource) Size added in v1.3.0 

func (m *GroupVersionResource) Size() (n int)

func (*GroupVersionResource) String added in v1.2.0 

func (gvr *GroupVersionResource) String() string

func (*GroupVersionResource) Unmarshal added in v1.3.0 

func (m *GroupVersionResource) Unmarshal(data []byte) error

type GroupVersions added in v1.4.0 

type GroupVersions []GroupVersion

GroupVersions can be used to represent a set of desired group versions. TODO: Move GroupVersions to a package under pkg/runtime, since it's used by scheme. TODO: Introduce an adapter type between GroupVersions and runtime.GroupVersioner, and use LegacyCodec(GroupVersion) 

in fewer places.

func (GroupVersions) KindForGroupVersionKinds added in v1.4.0 

func (gvs GroupVersions) KindForGroupVersionKinds(kinds []GroupVersionKind) (GroupVersionKind, bool)

KindForGroupVersionKinds identifies the preferred GroupVersionKind out of a list. It returns ok false if none of the options match the group.

type LabelSelector added in v1.2.0 

type LabelSelector struct {
	// matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
	// map is equivalent to an element of matchExpressions, whose key field is "key", the
	// operator is "In", and the values array contains only "value". The requirements are ANDed.
	// +optional
	MatchLabels map[string]string `json:"matchLabels,omitempty" protobuf:"bytes,1,rep,name=matchLabels"`
	// matchExpressions is a list of label selector requirements. The requirements are ANDed.
	// +optional
	MatchExpressions []LabelSelectorRequirement `json:"matchExpressions,omitempty" protobuf:"bytes,2,rep,name=matchExpressions"`
}

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

func ParseToLabelSelector added in v1.2.0 

func ParseToLabelSelector(selector string) (*LabelSelector, error)

ParseToLabelSelector parses a string representing a selector into a LabelSelector object. Note: This function should be kept in sync with the parser in pkg/labels/selector.go

func SetAsLabelSelector added in v1.2.0 

func SetAsLabelSelector(ls labels.Set) *LabelSelector

SetAsLabelSelector converts the labels.Set object into a LabelSelector api object.

func (*LabelSelector) Descriptor added in v1.4.0 

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

func (*LabelSelector) Marshal added in v1.3.0 

func (m *LabelSelector) Marshal() (data []byte, err error)

func (*LabelSelector) MarshalTo added in v1.3.0 

func (m *LabelSelector) MarshalTo(data []byte) (int, error)

func (*LabelSelector) ProtoMessage added in v1.3.0 

func (*LabelSelector) ProtoMessage()

func (*LabelSelector) Reset added in v1.3.0 

func (m *LabelSelector) Reset()

func (*LabelSelector) Size added in v1.3.0 

func (m *LabelSelector) Size() (n int)

func (*LabelSelector) String added in v1.3.0 

func (this *LabelSelector) String() string

func (LabelSelector) SwaggerDoc added in v1.2.0 

func (LabelSelector) SwaggerDoc() map[string]string

func (*LabelSelector) Unmarshal added in v1.3.0 

func (m *LabelSelector) Unmarshal(data []byte) error

type LabelSelectorOperator added in v1.2.0 

type LabelSelectorOperator string

A label selector operator is the set of operators that can be used in a selector requirement. 

const (
	LabelSelectorOpIn           LabelSelectorOperator = "In"
	LabelSelectorOpNotIn        LabelSelectorOperator = "NotIn"
	LabelSelectorOpExists       LabelSelectorOperator = "Exists"
	LabelSelectorOpDoesNotExist LabelSelectorOperator = "DoesNotExist"
)

type LabelSelectorRequirement added in v1.2.0 

type LabelSelectorRequirement struct {
	// key is the label key that the selector applies to.
	Key string `json:"key" patchStrategy:"merge" patchMergeKey:"key" protobuf:"bytes,1,opt,name=key"`
	// operator represents a key's relationship to a set of values.
	// Valid operators ard In, NotIn, Exists and DoesNotExist.
	Operator LabelSelectorOperator `json:"operator" protobuf:"bytes,2,opt,name=operator,casttype=LabelSelectorOperator"`
	// values is an array of string values. If the operator is In or NotIn,
	// the values array must be non-empty. If the operator is Exists or DoesNotExist,
	// the values array must be empty. This array is replaced during a strategic
	// merge patch.
	// +optional
	Values []string `json:"values,omitempty" protobuf:"bytes,3,rep,name=values"`
}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

func (*LabelSelectorRequirement) Descriptor added in v1.4.0 

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

func (*LabelSelectorRequirement) Marshal added in v1.3.0 

func (m *LabelSelectorRequirement) Marshal() (data []byte, err error)

func (*LabelSelectorRequirement) MarshalTo added in v1.3.0 

func (m *LabelSelectorRequirement) MarshalTo(data []byte) (int, error)

func (*LabelSelectorRequirement) ProtoMessage added in v1.3.0 

func (*LabelSelectorRequirement) ProtoMessage()

func (*LabelSelectorRequirement) Reset added in v1.3.0 

func (m *LabelSelectorRequirement) Reset()

func (*LabelSelectorRequirement) Size added in v1.3.0 

func (m *LabelSelectorRequirement) Size() (n int)

func (*LabelSelectorRequirement) String added in v1.3.0 

func (this *LabelSelectorRequirement) String() string

func (LabelSelectorRequirement) SwaggerDoc added in v1.2.0 

func (LabelSelectorRequirement) SwaggerDoc() map[string]string

func (*LabelSelectorRequirement) Unmarshal added in v1.3.0 

func (m *LabelSelectorRequirement) Unmarshal(data []byte) error

type List added in v1.3.0 

type List interface {
	GetResourceVersion() string
	SetResourceVersion(version string)
	GetSelfLink() string
	SetSelfLink(selfLink string)
}

List lets you work with list metadata from any of the versioned or internal API objects. Attempting to set or retrieve a field on an object that does not support that field will be a no-op and return a default value. TODO: move this, and TypeMeta and ListMeta, to a different package

type ListMeta 

type ListMeta struct {
	// SelfLink is a URL representing this object.
	// Populated by the system.
	// Read-only.
	// +optional
	SelfLink string `json:"selfLink,omitempty" protobuf:"bytes,1,opt,name=selfLink"`

	// String that identifies the server's internal version of this object that
	// can be used by clients to determine when objects have changed.
	// Value must be treated as opaque by clients and passed unmodified back to the server.
	// Populated by the system.
	// Read-only.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency
	// +optional
	ResourceVersion string `json:"resourceVersion,omitempty" protobuf:"bytes,2,opt,name=resourceVersion"`
}

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

func (*ListMeta) Descriptor added in v1.4.0 

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

func (*ListMeta) GetListMeta added in v1.3.0 

func (obj *ListMeta) GetListMeta() List

func (*ListMeta) GetResourceVersion added in v1.3.0 

func (meta *ListMeta) GetResourceVersion() string
func (meta *ListMeta) GetSelfLink() string

func (*ListMeta) Marshal added in v1.3.0 

func (m *ListMeta) Marshal() (data []byte, err error)

func (*ListMeta) MarshalTo added in v1.3.0 

func (m *ListMeta) MarshalTo(data []byte) (int, error)

func (*ListMeta) ProtoMessage added in v1.3.0 

func (*ListMeta) ProtoMessage()

func (*ListMeta) Reset added in v1.3.0 

func (m *ListMeta) Reset()

func (*ListMeta) SetResourceVersion added in v1.3.0 

func (meta *ListMeta) SetResourceVersion(version string)
func (meta *ListMeta) SetSelfLink(selfLink string)

func (*ListMeta) Size added in v1.3.0 

func (m *ListMeta) Size() (n int)

func (*ListMeta) String added in v1.3.0 

func (this *ListMeta) String() string

func (ListMeta) SwaggerDoc 

func (ListMeta) SwaggerDoc() map[string]string

func (*ListMeta) Unmarshal added in v1.3.0 

func (m *ListMeta) Unmarshal(data []byte) error

type ListMetaAccessor added in v1.3.0 

type ListMetaAccessor interface {
	GetListMeta() List
}

ListMetaAccessor retrieves the list interface from an object TODO: move this, and TypeMeta and ListMeta, to a different package

type ObjectKind added in v1.2.0 

type ObjectKind interface {
	// SetGroupVersionKind sets or clears the intended serialized kind of an object. Passing kind nil
	// should clear the current setting.
	SetGroupVersionKind(kind GroupVersionKind)
	// GroupVersionKind returns the stored group, version, and kind of an object, or nil if the object does
	// not expose or provide these fields.
	GroupVersionKind() GroupVersionKind
}

All objects that are serialized from a Scheme encode their type information. This interface is used by serialization to set type information from the Scheme onto the serialized version of an object. For objects that cannot be serialized or have unique requirements, this interface may be a no-op. TODO: this belongs in pkg/runtime, move unversioned.GVK into runtime.

type Patch added in v1.2.0 

type Patch struct{}

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

func (Patch) SwaggerDoc added in v1.2.0 

func (Patch) SwaggerDoc() map[string]string

type RootPaths added in v1.2.0 

type RootPaths struct {
	// paths are the paths available at root.
	Paths []string `json:"paths" protobuf:"bytes,1,rep,name=paths"`
}

RootPaths lists the paths available at root. For example: "/healthz", "/apis".

func (*RootPaths) Descriptor added in v1.4.0 

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

func (*RootPaths) Marshal added in v1.3.0 

func (m *RootPaths) Marshal() (data []byte, err error)

func (*RootPaths) MarshalTo added in v1.3.0 

func (m *RootPaths) MarshalTo(data []byte) (int, error)

func (*RootPaths) ProtoMessage added in v1.3.0 

func (*RootPaths) ProtoMessage()

func (*RootPaths) Reset added in v1.3.0 

func (m *RootPaths) Reset()

func (*RootPaths) Size added in v1.3.0 

func (m *RootPaths) Size() (n int)

func (*RootPaths) String added in v1.3.0 

func (this *RootPaths) String() string

func (RootPaths) SwaggerDoc added in v1.2.0 

func (RootPaths) SwaggerDoc() map[string]string

func (*RootPaths) Unmarshal added in v1.3.0 

func (m *RootPaths) Unmarshal(data []byte) error

type ServerAddressByClientCIDR added in v1.2.0 

type ServerAddressByClientCIDR struct {
	// The CIDR with which clients can match their IP to figure out the server address that they should use.
	ClientCIDR string `json:"clientCIDR" protobuf:"bytes,1,opt,name=clientCIDR"`
	// Address of this server, suitable for a client that matches the above CIDR.
	// This can be a hostname, hostname:port, IP or IP:port.
	ServerAddress string `json:"serverAddress" protobuf:"bytes,2,opt,name=serverAddress"`
}

ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.

func (*ServerAddressByClientCIDR) Descriptor added in v1.4.0 

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

func (*ServerAddressByClientCIDR) Marshal added in v1.3.0 

func (m *ServerAddressByClientCIDR) Marshal() (data []byte, err error)

func (*ServerAddressByClientCIDR) MarshalTo added in v1.3.0 

func (m *ServerAddressByClientCIDR) MarshalTo(data []byte) (int, error)

func (*ServerAddressByClientCIDR) ProtoMessage added in v1.3.0 

func (*ServerAddressByClientCIDR) ProtoMessage()

func (*ServerAddressByClientCIDR) Reset added in v1.3.0 

func (m *ServerAddressByClientCIDR) Reset()

func (*ServerAddressByClientCIDR) Size added in v1.3.0 

func (m *ServerAddressByClientCIDR) Size() (n int)

func (*ServerAddressByClientCIDR) String added in v1.3.0 

func (this *ServerAddressByClientCIDR) String() string

func (ServerAddressByClientCIDR) SwaggerDoc added in v1.2.0 

func (ServerAddressByClientCIDR) SwaggerDoc() map[string]string

func (*ServerAddressByClientCIDR) Unmarshal added in v1.3.0 

func (m *ServerAddressByClientCIDR) Unmarshal(data []byte) error

type Status 

type Status struct {
	TypeMeta `json:",inline"`
	// Standard list metadata.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
	// +optional
	ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Status of the operation.
	// One of: "Success" or "Failure".
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
	// +optional
	Status string `json:"status,omitempty" protobuf:"bytes,2,opt,name=status"`
	// A human-readable description of the status of this operation.
	// +optional
	Message string `json:"message,omitempty" protobuf:"bytes,3,opt,name=message"`
	// A machine-readable description of why this operation is in the
	// "Failure" status. If this value is empty there
	// is no information available. A Reason clarifies an HTTP status
	// code but does not override it.
	// +optional
	Reason StatusReason `json:"reason,omitempty" protobuf:"bytes,4,opt,name=reason,casttype=StatusReason"`
	// Extended data associated with the reason.  Each reason may define its
	// own extended details. This field is optional and the data returned
	// is not guaranteed to conform to any schema except that defined by
	// the reason type.
	// +optional
	Details *StatusDetails `json:"details,omitempty" protobuf:"bytes,5,opt,name=details"`
	// Suggested HTTP return code for this status, 0 if not set.
	// +optional
	Code int32 `json:"code,omitempty" protobuf:"varint,6,opt,name=code"`
}

Status is a return value for calls that don't return other objects.

func (*Status) Descriptor added in v1.4.0 

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

func (*Status) Marshal added in v1.3.0 

func (m *Status) Marshal() (data []byte, err error)

func (*Status) MarshalTo added in v1.3.0 

func (m *Status) MarshalTo(data []byte) (int, error)

func (*Status) ProtoMessage added in v1.3.0 

func (*Status) ProtoMessage()

func (*Status) Reset added in v1.3.0 

func (m *Status) Reset()

func (*Status) Size added in v1.3.0 

func (m *Status) Size() (n int)

func (*Status) String added in v1.3.0 

func (this *Status) String() string

func (Status) SwaggerDoc 

func (Status) SwaggerDoc() map[string]string

func (*Status) Unmarshal added in v1.3.0 

func (m *Status) Unmarshal(data []byte) error

type StatusCause 

type StatusCause struct {
	// A machine-readable description of the cause of the error. If this value is
	// empty there is no information available.
	// +optional
	Type CauseType `json:"reason,omitempty" protobuf:"bytes,1,opt,name=reason,casttype=CauseType"`
	// A human-readable description of the cause of the error.  This field may be
	// presented as-is to a reader.
	// +optional
	Message string `json:"message,omitempty" protobuf:"bytes,2,opt,name=message"`
	// The field of the resource that has caused this error, as named by its JSON
	// serialization. May include dot and postfix notation for nested attributes.
	// Arrays are zero-indexed.  Fields may appear more than once in an array of
	// causes due to fields having multiple errors.
	// Optional.
	//
	// Examples:
	//   "name" - the field "name" on the current resource
	//   "items[0].name" - the field "name" on the first array entry in "items"
	// +optional
	Field string `json:"field,omitempty" protobuf:"bytes,3,opt,name=field"`
}

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

func (*StatusCause) Descriptor added in v1.4.0 

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

func (*StatusCause) Marshal added in v1.3.0 

func (m *StatusCause) Marshal() (data []byte, err error)

func (*StatusCause) MarshalTo added in v1.3.0 

func (m *StatusCause) MarshalTo(data []byte) (int, error)

func (*StatusCause) ProtoMessage added in v1.3.0 

func (*StatusCause) ProtoMessage()

func (*StatusCause) Reset added in v1.3.0 

func (m *StatusCause) Reset()

func (*StatusCause) Size added in v1.3.0 

func (m *StatusCause) Size() (n int)

func (*StatusCause) String added in v1.3.0 

func (this *StatusCause) String() string

func (StatusCause) SwaggerDoc 

func (StatusCause) SwaggerDoc() map[string]string

func (*StatusCause) Unmarshal added in v1.3.0 

func (m *StatusCause) Unmarshal(data []byte) error

type StatusDetails 

type StatusDetails struct {
	// The name attribute of the resource associated with the status StatusReason
	// (when there is a single name which can be described).
	// +optional
	Name string `json:"name,omitempty" protobuf:"bytes,1,opt,name=name"`
	// The group attribute of the resource associated with the status StatusReason.
	// +optional
	Group string `json:"group,omitempty" protobuf:"bytes,2,opt,name=group"`
	// The kind attribute of the resource associated with the status StatusReason.
	// On some operations may differ from the requested resource Kind.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
	// +optional
	Kind string `json:"kind,omitempty" protobuf:"bytes,3,opt,name=kind"`
	// The Causes array includes more details associated with the StatusReason
	// failure. Not all StatusReasons may provide detailed causes.
	// +optional
	Causes []StatusCause `json:"causes,omitempty" protobuf:"bytes,4,rep,name=causes"`
	// If specified, the time in seconds before the operation should be retried.
	// +optional
	RetryAfterSeconds int32 `json:"retryAfterSeconds,omitempty" protobuf:"varint,5,opt,name=retryAfterSeconds"`
}

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

func (*StatusDetails) Descriptor added in v1.4.0 

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

func (*StatusDetails) Marshal added in v1.3.0 

func (m *StatusDetails) Marshal() (data []byte, err error)

func (*StatusDetails) MarshalTo added in v1.3.0 

func (m *StatusDetails) MarshalTo(data []byte) (int, error)

func (*StatusDetails) ProtoMessage added in v1.3.0 

func (*StatusDetails) ProtoMessage()

func (*StatusDetails) Reset added in v1.3.0 

func (m *StatusDetails) Reset()

func (*StatusDetails) Size added in v1.3.0 

func (m *StatusDetails) Size() (n int)

func (*StatusDetails) String added in v1.3.0 

func (this *StatusDetails) String() string

func (StatusDetails) SwaggerDoc 

func (StatusDetails) SwaggerDoc() map[string]string

func (*StatusDetails) Unmarshal added in v1.3.0 

func (m *StatusDetails) Unmarshal(data []byte) error

type StatusReason 

type StatusReason string

StatusReason is an enumeration of possible failure causes. Each StatusReason must map to a single HTTP status code, but multiple reasons may map to the same HTTP status code. TODO: move to apiserver 

const (
	// StatusReasonUnknown means the server has declined to indicate a specific reason.
	// The details field may contain other information about this error.
	// Status code 500.
	StatusReasonUnknown StatusReason = ""

	// StatusReasonUnauthorized means the server can be reached and understood the request, but requires
	// the user to present appropriate authorization credentials (identified by the WWW-Authenticate header)
	// in order for the action to be completed. If the user has specified credentials on the request, the
	// server considers them insufficient.
	// Status code 401
	StatusReasonUnauthorized StatusReason = "Unauthorized"

	// StatusReasonForbidden means the server can be reached and understood the request, but refuses
	// to take any further action.  It is the result of the server being configured to deny access for some reason
	// to the requested resource by the client.
	// Details (optional):
	//   "kind" string - the kind attribute of the forbidden resource
	//                   on some operations may differ from the requested
	//                   resource.
	//   "id"   string - the identifier of the forbidden resource
	// Status code 403
	StatusReasonForbidden StatusReason = "Forbidden"

	// StatusReasonNotFound means one or more resources required for this operation
	// could not be found.
	// Details (optional):
	//   "kind" string - the kind attribute of the missing resource
	//                   on some operations may differ from the requested
	//                   resource.
	//   "id"   string - the identifier of the missing resource
	// Status code 404
	StatusReasonNotFound StatusReason = "NotFound"

	// StatusReasonAlreadyExists means the resource you are creating already exists.
	// Details (optional):
	//   "kind" string - the kind attribute of the conflicting resource
	//   "id"   string - the identifier of the conflicting resource
	// Status code 409
	StatusReasonAlreadyExists StatusReason = "AlreadyExists"

	// StatusReasonConflict means the requested operation cannot be completed
	// due to a conflict in the operation. The client may need to alter the
	// request. Each resource may define custom details that indicate the
	// nature of the conflict.
	// Status code 409
	StatusReasonConflict StatusReason = "Conflict"

	// StatusReasonGone means the item is no longer available at the server and no
	// forwarding address is known.
	// Status code 410
	StatusReasonGone StatusReason = "Gone"

	// StatusReasonInvalid means the requested create or update operation cannot be
	// completed due to invalid data provided as part of the request. The client may
	// need to alter the request. When set, the client may use the StatusDetails
	// message field as a summary of the issues encountered.
	// Details (optional):
	//   "kind" string - the kind attribute of the invalid resource
	//   "id"   string - the identifier of the invalid resource
	//   "causes"      - one or more StatusCause entries indicating the data in the
	//                   provided resource that was invalid.  The code, message, and
	//                   field attributes will be set.
	// Status code 422
	StatusReasonInvalid StatusReason = "Invalid"

	// StatusReasonServerTimeout means the server can be reached and understood the request,
	// but cannot complete the action in a reasonable time. The client should retry the request.
	// This is may be due to temporary server load or a transient communication issue with
	// another server. Status code 500 is used because the HTTP spec provides no suitable
	// server-requested client retry and the 5xx class represents actionable errors.
	// Details (optional):
	//   "kind" string - the kind attribute of the resource being acted on.
	//   "id"   string - the operation that is being attempted.
	//   "retryAfterSeconds" int32 - the number of seconds before the operation should be retried
	// Status code 500
	StatusReasonServerTimeout StatusReason = "ServerTimeout"

	// StatusReasonTimeout means that the request could not be completed within the given time.
	// Clients can get this response only when they specified a timeout param in the request,
	// or if the server cannot complete the operation within a reasonable amount of time.
	// The request might succeed with an increased value of timeout param. The client *should*
	// wait at least the number of seconds specified by the retryAfterSeconds field.
	// Details (optional):
	//   "retryAfterSeconds" int32 - the number of seconds before the operation should be retried
	// Status code 504
	StatusReasonTimeout StatusReason = "Timeout"

	// StatusReasonBadRequest means that the request itself was invalid, because the request
	// doesn't make any sense, for example deleting a read-only object.  This is different than
	// StatusReasonInvalid above which indicates that the API call could possibly succeed, but the
	// data was invalid.  API calls that return BadRequest can never succeed.
	StatusReasonBadRequest StatusReason = "BadRequest"

	// StatusReasonMethodNotAllowed means that the action the client attempted to perform on the
	// resource was not supported by the code - for instance, attempting to delete a resource that
	// can only be created. API calls that return MethodNotAllowed can never succeed.
	StatusReasonMethodNotAllowed StatusReason = "MethodNotAllowed"

	// StatusReasonInternalError indicates that an internal error occurred, it is unexpected
	// and the outcome of the call is unknown.
	// Details (optional):
	//   "causes" - The original error
	// Status code 500
	StatusReasonInternalError StatusReason = "InternalError"

	// StatusReasonExpired indicates that the request is invalid because the content you are requesting
	// has expired and is no longer available. It is typically associated with watches that can't be
	// serviced.
	// Status code 410 (gone)
	StatusReasonExpired StatusReason = "Expired"

	// StatusReasonServiceUnavailable means that the request itself was valid,
	// but the requested service is unavailable at this time.
	// Retrying the request after some time might succeed.
	// Status code 503
	StatusReasonServiceUnavailable StatusReason = "ServiceUnavailable"
)

type Time 

type Time struct {
	time.Time `protobuf:"-"`
}

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

func Date 

func Date(year int, month time.Month, day, hour, min, sec, nsec int, loc *time.Location) Time

Date returns the Time corresponding to the supplied parameters by wrapping time.Date.

func NewTime 

func NewTime(time time.Time) Time

NewTime returns a wrapped instance of the provided time

func Now 

func Now() Time

Now returns the current local time.

func Unix 

func Unix(sec int64, nsec int64) Time

Unix returns the local time corresponding to the given Unix time by wrapping time.Unix.

func (Time) Before 

func (t Time) Before(u Time) bool

Before reports whether the time instant t is before u.

func (Time) DeepCopy added in v1.4.0 

func (t Time) DeepCopy() Time

DeepCopy returns a deep-copy of the Time value. The underlying time.Time type is effectively immutable in the time API, so it is safe to copy-by-assign, despite the presence of (unexported) Pointer fields.

func (*Time) Descriptor added in v1.4.0 

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

func (Time) Equal 

func (t Time) Equal(u Time) bool

Equal reports whether the time instant t is equal to u.

func (*Time) Fuzz 

func (t *Time) Fuzz(c fuzz.Continue)

Fuzz satisfies fuzz.Interface.

func (*Time) IsZero 

func (t *Time) IsZero() bool

IsZero returns true if the value is nil or time is zero.

func (*Time) Marshal added in v1.3.0 

func (m *Time) Marshal() (data []byte, err error)

Marshal implements the protobuf marshalling interface.

func (Time) MarshalJSON 

func (t Time) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (Time) MarshalQueryParameter added in v1.2.0 

func (t Time) MarshalQueryParameter() (string, error)

MarshalQueryParameter converts to a URL query parameter value

func (*Time) MarshalTo added in v1.3.0 

func (m *Time) MarshalTo(data []byte) (int, error)

MarshalTo implements the protobuf marshalling interface.

func (Time) OpenAPIDefinition added in v1.5.0 

func (_ Time) OpenAPIDefinition() common.OpenAPIDefinition

func (*Time) ProtoMessage added in v1.3.0 

func (*Time) ProtoMessage()

func (*Time) ProtoTime added in v1.3.0 

func (m *Time) ProtoTime() *Timestamp

Timestamp returns the Time as a new Timestamp value.

func (*Time) Reset added in v1.3.0 

func (m *Time) Reset()

func (Time) Rfc3339Copy 

func (t Time) Rfc3339Copy() Time

Rfc3339Copy returns a copy of the Time at second-level precision.

func (*Time) Size added in v1.3.0 

func (m *Time) Size() (n int)

Size implements the protobuf marshalling interface.

func (Time) String added in v1.3.0 

func (t Time) String() string

String returns the representation of the time.

func (*Time) Unmarshal added in v1.3.0 

func (m *Time) Unmarshal(data []byte) error

Reset implements the protobuf marshalling interface.

func (*Time) UnmarshalJSON 

func (t *Time) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the json.Unmarshaller interface.

func (*Time) UnmarshalQueryParameter added in v1.2.0 

func (t *Time) UnmarshalQueryParameter(str string) error

UnmarshalQueryParameter converts from a URL query parameter value to an object

type Timestamp added in v1.3.0 

type Timestamp struct {
	// Represents seconds of UTC time since Unix epoch
	// 1970-01-01T00:00:00Z. Must be from from 0001-01-01T00:00:00Z to
	// 9999-12-31T23:59:59Z inclusive.
	Seconds int64 `json:"seconds" protobuf:"varint,1,opt,name=seconds"`
	// Non-negative fractions of a second at nanosecond resolution. Negative
	// second values with fractions must still have non-negative nanos values
	// that count forward in time. Must be from 0 to 999,999,999
	// inclusive. This field may be limited in precision depending on context.
	Nanos int32 `json:"nanos" protobuf:"varint,2,opt,name=nanos"`
}

Timestamp is a struct that is equivalent to Time, but intended for protobuf marshalling/unmarshalling. It is generated into a serialization that matches Time. Do not use in Go structs.

func (*Timestamp) Descriptor added in v1.4.0 

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

func (*Timestamp) Marshal added in v1.3.0 

func (m *Timestamp) Marshal() (data []byte, err error)

func (*Timestamp) MarshalTo added in v1.3.0 

func (m *Timestamp) MarshalTo(data []byte) (int, error)

func (*Timestamp) ProtoMessage added in v1.3.0 

func (*Timestamp) ProtoMessage()

func (*Timestamp) Reset added in v1.3.0 

func (m *Timestamp) Reset()

func (*Timestamp) Size added in v1.3.0 

func (m *Timestamp) Size() (n int)

func (*Timestamp) String added in v1.3.0 

func (this *Timestamp) String() string

func (*Timestamp) Unmarshal added in v1.3.0 

func (m *Timestamp) Unmarshal(data []byte) error

type Type added in v1.3.0 

type Type interface {
	GetAPIVersion() string
	SetAPIVersion(version string)
	GetKind() string
	SetKind(kind string)
}

Type exposes the type and APIVersion of versioned or internal API objects. TODO: move this, and TypeMeta and ListMeta, to a different package

type TypeMeta 

type TypeMeta struct {
	// Kind is a string value representing the REST resource this object represents.
	// Servers may infer this from the endpoint the client submits requests to.
	// Cannot be updated.
	// In CamelCase.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
	// +optional
	Kind string `json:"kind,omitempty" protobuf:"bytes,1,opt,name=kind"`

	// APIVersion defines the versioned schema of this representation of an object.
	// Servers should convert recognized schemas to the latest internal value, and
	// may reject unrecognized values.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources
	// +optional
	APIVersion string `json:"apiVersion,omitempty" protobuf:"bytes,2,opt,name=apiVersion"`
}

TypeMeta describes an individual object in an API response or request with strings representing the type of the object and its API schema version. Structures that are versioned or persisted should inline TypeMeta.

func (*TypeMeta) Descriptor added in v1.4.0 

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

func (*TypeMeta) GetObjectKind added in v1.3.0 

func (obj *TypeMeta) GetObjectKind() ObjectKind

func (*TypeMeta) GroupVersionKind added in v1.2.0 

func (obj *TypeMeta) GroupVersionKind() GroupVersionKind

GroupVersionKind satisfies the ObjectKind interface for all objects that embed TypeMeta

func (*TypeMeta) Marshal added in v1.3.0 

func (m *TypeMeta) Marshal() (data []byte, err error)

func (*TypeMeta) MarshalTo added in v1.3.0 

func (m *TypeMeta) MarshalTo(data []byte) (int, error)

func (*TypeMeta) ProtoMessage added in v1.3.0 

func (*TypeMeta) ProtoMessage()

func (*TypeMeta) Reset added in v1.3.0 

func (m *TypeMeta) Reset()

func (*TypeMeta) SetGroupVersionKind added in v1.2.0 

func (obj *TypeMeta) SetGroupVersionKind(gvk GroupVersionKind)

SetGroupVersionKind satisfies the ObjectKind interface for all objects that embed TypeMeta

func (*TypeMeta) Size added in v1.3.0 

func (m *TypeMeta) Size() (n int)

func (*TypeMeta) String added in v1.3.0 

func (this *TypeMeta) String() string

func (TypeMeta) SwaggerDoc 

func (TypeMeta) SwaggerDoc() map[string]string

func (*TypeMeta) Unmarshal added in v1.3.0 

func (m *TypeMeta) Unmarshal(data []byte) error

Source Files

View all Source files

Directories

Path Synopsis

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.