v1

package
v1.6.7 Latest Latest
Warning

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

Go to latest
Published: Jul 5, 2017 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Overview

+groupName=meta.k8s.io

Package v1 is a generated protocol buffer package.

It is generated from these files:
	k8s.io/kubernetes/vendor/k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto

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

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 (
	FinalizerOrphanDependents string = "orphan"
	FinalizerDeleteDependents string = "foregroundDeletion"
)

These are internal finalizer values for Kubernetes-like APIs, must be qualified name unless defined here

View Source
const (
	// NamespaceDefault means the object is in the default namespace which is applied when not specified by clients
	NamespaceDefault string = "default"
	// NamespaceAll is the default argument to specify on a context when you want to list or filter resources across all namespaces
	NamespaceAll string = ""
	// NamespaceNone is the argument for a context when there is no namespace.
	NamespaceNone string = ""
	// NamespaceSystem is the system namespace where we place system components.
	NamespaceSystem string = "kube-system"
	// NamespacePublic is the namespace where we place public info (ConfigMaps)
	NamespacePublic string = "kube-public"
)
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"

	// Historically fluentd was a manifest pod the was migrated to DaemonSet.
	// To avoid situation during cluster upgrade when there are two instances
	// of fluentd running on a node, kubelet need to mark node on which
	// fluentd in not running as a manifest pod with LabelFluentdDsReady.
	LabelFluentdDsReady = "alpha.kubernetes.io/fluentd-ds-ready"

	// When feature-gate for TaintBasedEvictions=true flag is enabled,
	// TaintNodeNotReady would be automatically added by node controller
	// when node is not ready, and removed when node becomes ready.
	TaintNodeNotReady = "node.alpha.kubernetes.io/notReady"

	// When feature-gate for TaintBasedEvictions=true flag is enabled,
	// TaintNodeUnreachable would be automatically added by node controller
	// when node becomes unreachable (corresponding to NodeReady status ConditionUnknown)
	// and removed when node becomes reachable (NodeReady status ConditionTrue).
	TaintNodeUnreachable = "node.alpha.kubernetes.io/unreachable"
)
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"
)
View Source
const GroupName = "meta.k8s.io"

GroupName is the group name for this API.

View Source
const WatchEventKind = "WatchEvent"

WatchEventKind is name reserved for serializing watch events.

Variables

View Source
var (
	ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
)
View Source
var ParameterCodec = runtime.NewParameterCodec(scheme)

ParameterCodec knows about query parameters used with the meta v1 API spec.

View Source
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func AddConversionFuncs

func AddConversionFuncs(scheme *runtime.Scheme) error

func AddToGroupVersion

func AddToGroupVersion(scheme *runtime.Scheme, groupVersion schema.GroupVersion)

AddToGroupVersion registers common meta types into schemas.

func Convert_Pointer_bool_To_bool

func Convert_Pointer_bool_To_bool(in **bool, out *bool, s conversion.Scope) error

func Convert_Pointer_float64_To_float64

func Convert_Pointer_float64_To_float64(in **float64, out *float64, s conversion.Scope) error

func Convert_Pointer_int32_To_int32

func Convert_Pointer_int32_To_int32(in **int32, out *int32, s conversion.Scope) error

func Convert_Pointer_int64_To_int

func Convert_Pointer_int64_To_int(in **int64, out *int, s conversion.Scope) error

func Convert_Pointer_string_To_string

func Convert_Pointer_string_To_string(in **string, out *string, s conversion.Scope) error

func Convert_Slice_string_To_Slice_int32

func Convert_Slice_string_To_Slice_int32(in *[]string, out *[]int32, s conversion.Scope) error

Convert_Slice_string_To_Slice_int32 converts multiple query parameters or a single query parameter with a comma delimited value to multiple int32. This is used for port forwarding which needs the ports as int32.

func Convert_Slice_string_To_unversioned_Time

func Convert_Slice_string_To_unversioned_Time(input *[]string, out *Time, s conversion.Scope) error

Convert_Slice_string_To_unversioned_Time allows converting a URL query parameter value

func Convert_bool_To_Pointer_bool

func Convert_bool_To_Pointer_bool(in *bool, out **bool, s conversion.Scope) error

func Convert_fields_Selector_To_string

func Convert_fields_Selector_To_string(in *fields.Selector, out *string, s conversion.Scope) error

func Convert_float64_To_Pointer_float64

func Convert_float64_To_Pointer_float64(in *float64, out **float64, s conversion.Scope) error

func Convert_int32_To_Pointer_int32

func Convert_int32_To_Pointer_int32(in *int32, out **int32, s conversion.Scope) error

func Convert_int_To_Pointer_int64

func Convert_int_To_Pointer_int64(in *int, out **int64, s conversion.Scope) error

func Convert_intstr_IntOrString_To_intstr_IntOrString

func Convert_intstr_IntOrString_To_intstr_IntOrString(in, out *intstr.IntOrString, s conversion.Scope) error

+k8s:conversion-fn=copy-only

func Convert_labels_Selector_To_string

func Convert_labels_Selector_To_string(in *labels.Selector, out *string, s conversion.Scope) error

func Convert_map_to_unversioned_LabelSelector

func Convert_map_to_unversioned_LabelSelector(in *map[string]string, out *LabelSelector, s conversion.Scope) error

func Convert_resource_Quantity_To_resource_Quantity

func Convert_resource_Quantity_To_resource_Quantity(in *resource.Quantity, out *resource.Quantity, s conversion.Scope) error

+k8s:conversion-fn=copy-only

func Convert_string_To_Pointer_string

func Convert_string_To_Pointer_string(in *string, out **string, s conversion.Scope) error

func Convert_string_To_fields_Selector

func Convert_string_To_fields_Selector(in *string, out *fields.Selector, s conversion.Scope) error

func Convert_string_To_labels_Selector

func Convert_string_To_labels_Selector(in *string, out *labels.Selector, s conversion.Scope) error

func Convert_unversioned_LabelSelector_to_map

func Convert_unversioned_LabelSelector_to_map(in *LabelSelector, out *map[string]string, s conversion.Scope) error

func Convert_unversioned_ListMeta_To_unversioned_ListMeta

func Convert_unversioned_ListMeta_To_unversioned_ListMeta(in, out *ListMeta, s conversion.Scope) error

+k8s:conversion-fn=copy-only

func Convert_unversioned_Time_To_unversioned_Time

func Convert_unversioned_Time_To_unversioned_Time(in *Time, out *Time, s conversion.Scope) error

+k8s:conversion-fn=copy-only

func Convert_v1_TypeMeta_To_v1_TypeMeta

func Convert_v1_TypeMeta_To_v1_TypeMeta(in, out *TypeMeta, s conversion.Scope) error

+k8s:conversion-fn=drop

func Convert_versioned_Event_to_versioned_InternalEvent

func Convert_versioned_Event_to_versioned_InternalEvent(in *WatchEvent, out *InternalEvent, s conversion.Scope) error

func Convert_versioned_Event_to_watch_Event

func Convert_versioned_Event_to_watch_Event(in *WatchEvent, out *watch.Event, s conversion.Scope) error

func Convert_versioned_InternalEvent_to_versioned_Event

func Convert_versioned_InternalEvent_to_versioned_Event(in *InternalEvent, out *WatchEvent, s conversion.Scope) error

func Convert_watch_Event_to_versioned_Event

func Convert_watch_Event_to_versioned_Event(in *watch.Event, out *WatchEvent, s conversion.Scope) error

func DeepCopy_v1_APIGroup

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

func DeepCopy_v1_APIGroupList

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

func DeepCopy_v1_APIResource

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

func DeepCopy_v1_APIResourceList

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

func DeepCopy_v1_APIVersions

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

func DeepCopy_v1_DeleteOptions

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

func DeepCopy_v1_Duration

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

func DeepCopy_v1_ExportOptions

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

func DeepCopy_v1_GetOptions

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

func DeepCopy_v1_GroupKind

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

func DeepCopy_v1_GroupResource

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

func DeepCopy_v1_GroupVersion

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

func DeepCopy_v1_GroupVersionForDiscovery

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

func DeepCopy_v1_GroupVersionKind

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

func DeepCopy_v1_GroupVersionResource

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

func DeepCopy_v1_InternalEvent

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

func DeepCopy_v1_LabelSelector

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

func DeepCopy_v1_LabelSelectorRequirement

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

func DeepCopy_v1_ListMeta

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

func DeepCopy_v1_ListOptions

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

func DeepCopy_v1_ObjectMeta

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

func DeepCopy_v1_OwnerReference

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

func DeepCopy_v1_Patch

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

func DeepCopy_v1_Preconditions

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

func DeepCopy_v1_RootPaths

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

func DeepCopy_v1_ServerAddressByClientCIDR

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

func DeepCopy_v1_Status

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

func DeepCopy_v1_StatusCause

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

func DeepCopy_v1_StatusDetails

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

func DeepCopy_v1_Time

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

func DeepCopy_v1_Timestamp

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

func DeepCopy_v1_TypeMeta

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

func DeepCopy_v1_WatchEvent

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

func ExtractGroupVersions

func ExtractGroupVersions(l *APIGroupList) []string

func FieldSelectorQueryParam

func FieldSelectorQueryParam(version string) string

TODO: remove me when watch is refactored

func FormatLabelSelector

func FormatLabelSelector(labelSelector *LabelSelector) string

FormatLabelSelector convert labelSelector into plain string

func GetGeneratedDeepCopyFuncs

func GetGeneratedDeepCopyFuncs() []conversion.GeneratedDeepCopyFunc

GetGeneratedDeepCopyFuncs returns the generated funcs, since we aren't registering them.

func HasAnnotation

func HasAnnotation(obj ObjectMeta, ann string) bool

HasAnnotation returns a bool if passed in annotation exists

func HasObjectMetaSystemFieldValues

func HasObjectMetaSystemFieldValues(meta *ObjectMeta) bool

HasObjectMetaSystemFieldValues returns true if fields that are managed by the system on ObjectMeta have values.

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func LabelSelectorAsMap

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

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

func LabelSelectorQueryParam(version string) string

TODO: remove me when watch is refactored

func RegisterDefaults

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func SelectorHasLabel

func SelectorHasLabel(selector *LabelSelector, labelKey string) bool

SelectorHasLabel checks if the given selector contains the given label key in its MatchLabels

func SetMetaDataAnnotation

func SetMetaDataAnnotation(obj *ObjectMeta, ann string, value string)

SetMetaDataAnnotation sets the annotation and value

Types

type APIGroup

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

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

func (*APIGroup) Marshal

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

func (*APIGroup) MarshalTo

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

func (*APIGroup) ProtoMessage

func (*APIGroup) ProtoMessage()

func (*APIGroup) Reset

func (m *APIGroup) Reset()

func (*APIGroup) Size

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

func (*APIGroup) String

func (this *APIGroup) String() string

func (APIGroup) SwaggerDoc

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

func (*APIGroup) Unmarshal

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

type APIGroupList

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

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

func (*APIGroupList) Marshal

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

func (*APIGroupList) MarshalTo

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

func (*APIGroupList) ProtoMessage

func (*APIGroupList) ProtoMessage()

func (*APIGroupList) Reset

func (m *APIGroupList) Reset()

func (*APIGroupList) Size

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

func (*APIGroupList) String

func (this *APIGroupList) String() string

func (APIGroupList) SwaggerDoc

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

func (*APIGroupList) Unmarshal

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

type APIResource

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"`
	// verbs is a list of supported kube verbs (this includes get, list, watch, create,
	// update, patch, delete, deletecollection, and proxy)
	Verbs Verbs `json:"verbs" protobuf:"bytes,4,opt,name=verbs"`
	// shortNames is a list of suggested short names of the resource.
	ShortNames []string `json:"shortNames,omitempty" protobuf:"bytes,5,rep,name=shortNames"`
}

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

func (*APIResource) Descriptor

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

func (*APIResource) Marshal

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

func (*APIResource) MarshalTo

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

func (*APIResource) ProtoMessage

func (*APIResource) ProtoMessage()

func (*APIResource) Reset

func (m *APIResource) Reset()

func (*APIResource) Size

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

func (*APIResource) String

func (this *APIResource) String() string

func (APIResource) SwaggerDoc

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

func (*APIResource) Unmarshal

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

type APIResourceList

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

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

func (*APIResourceList) Marshal

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

func (*APIResourceList) MarshalTo

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

func (*APIResourceList) ProtoMessage

func (*APIResourceList) ProtoMessage()

func (*APIResourceList) Reset

func (m *APIResourceList) Reset()

func (*APIResourceList) Size

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

func (*APIResourceList) String

func (this *APIResourceList) String() string

func (APIResourceList) SwaggerDoc

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

func (*APIResourceList) Unmarshal

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

type APIVersions

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

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

func (APIVersions) GoString

func (apiVersions APIVersions) GoString() string

func (*APIVersions) Marshal

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

func (*APIVersions) MarshalTo

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

func (*APIVersions) ProtoMessage

func (*APIVersions) ProtoMessage()

func (*APIVersions) Reset

func (m *APIVersions) Reset()

func (*APIVersions) Size

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

func (APIVersions) String

func (apiVersions APIVersions) String() string

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

func (APIVersions) SwaggerDoc

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

func (*APIVersions) Unmarshal

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 DeleteOptions

type DeleteOptions struct {
	TypeMeta `json:",inline"`

	// The duration in seconds before the object should be deleted. Value must be non-negative integer.
	// The value zero indicates delete immediately. If this value is nil, the default grace period for the
	// specified type will be used.
	// Defaults to a per object value if not specified. zero means delete immediately.
	// +optional
	GracePeriodSeconds *int64 `json:"gracePeriodSeconds,omitempty" protobuf:"varint,1,opt,name=gracePeriodSeconds"`

	// Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be
	// returned.
	// +optional
	Preconditions *Preconditions `json:"preconditions,omitempty" protobuf:"bytes,2,opt,name=preconditions"`

	// Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7.
	// Should the dependent objects be orphaned. If true/false, the "orphan"
	// finalizer will be added to/removed from the object's finalizers list.
	// Either this field or PropagationPolicy may be set, but not both.
	// +optional
	OrphanDependents *bool `json:"orphanDependents,omitempty" protobuf:"varint,3,opt,name=orphanDependents"`

	// Whether and how garbage collection will be performed.
	// Either this field or OrphanDependents may be set, but not both.
	// The default policy is decided by the existing finalizer set in the
	// metadata.finalizers and the resource-specific default policy.
	// +optional
	PropagationPolicy *DeletionPropagation `json:"propagationPolicy,omitempty" protobuf:"varint,4,opt,name=propagationPolicy"`
}

DeleteOptions may be provided when deleting an API object.

func NewDeleteOptions

func NewDeleteOptions(grace int64) *DeleteOptions

NewDeleteOptions returns a DeleteOptions indicating the resource should be deleted within the specified grace period. Use zero to indicate immediate deletion. If you would prefer to use the default grace period, use &metav1.DeleteOptions{} directly.

func NewPreconditionDeleteOptions

func NewPreconditionDeleteOptions(uid string) *DeleteOptions

NewPreconditionDeleteOptions returns a DeleteOptions with a UID precondition set.

func (*DeleteOptions) Descriptor

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

func (*DeleteOptions) Marshal

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

func (*DeleteOptions) MarshalTo

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

func (*DeleteOptions) ProtoMessage

func (*DeleteOptions) ProtoMessage()

func (*DeleteOptions) Reset

func (m *DeleteOptions) Reset()

func (*DeleteOptions) Size

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

func (*DeleteOptions) String

func (this *DeleteOptions) String() string

func (DeleteOptions) SwaggerDoc

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

func (*DeleteOptions) Unmarshal

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

type DeletionPropagation

type DeletionPropagation string

DeletionPropagation decides if a deletion will propagate to the dependents of the object, and how the garbage collector will handle the propagation.

const (
	// Orphans the dependents.
	DeletePropagationOrphan DeletionPropagation = "Orphan"
	// Deletes the object from the key-value store, the garbage collector will
	// delete the dependents in the background.
	DeletePropagationBackground DeletionPropagation = "Background"
	// The object exists in the key-value store until the garbage collector
	// deletes all the dependents whose ownerReference.blockOwnerDeletion=true
	// from the key-value store.  API sever will put the "foregroundDeletion"
	// finalizer on the object, and sets its deletionTimestamp.  This policy is
	// cascading, i.e., the dependents will be deleted with Foreground.
	DeletePropagationForeground DeletionPropagation = "Foreground"
)

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

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

func (*Duration) Marshal

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

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

func (*Duration) ProtoMessage

func (*Duration) ProtoMessage()

func (*Duration) Reset

func (m *Duration) Reset()

func (*Duration) Size

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

func (*Duration) String

func (this *Duration) String() string

func (*Duration) Unmarshal

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

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

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

func (*ExportOptions) Marshal

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

func (*ExportOptions) MarshalTo

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

func (*ExportOptions) ProtoMessage

func (*ExportOptions) ProtoMessage()

func (*ExportOptions) Reset

func (m *ExportOptions) Reset()

func (*ExportOptions) Size

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

func (*ExportOptions) String

func (this *ExportOptions) String() string

func (ExportOptions) SwaggerDoc

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

func (*ExportOptions) Unmarshal

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

type GetOptions

type GetOptions struct {
	TypeMeta `json:",inline"`
	// When specified:
	// - 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.
	ResourceVersion string `json:"resourceVersion,omitempty" protobuf:"bytes,1,opt,name=resourceVersion"`
}

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

func (*GetOptions) Descriptor

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

func (*GetOptions) Marshal

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

func (*GetOptions) MarshalTo

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

func (*GetOptions) ProtoMessage

func (*GetOptions) ProtoMessage()

func (*GetOptions) Reset

func (m *GetOptions) Reset()

func (*GetOptions) Size

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

func (*GetOptions) String

func (this *GetOptions) String() string

func (GetOptions) SwaggerDoc

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

func (*GetOptions) Unmarshal

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

type GroupKind

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 (*GroupKind) Descriptor

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

func (*GroupKind) Marshal

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

func (*GroupKind) MarshalTo

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

func (*GroupKind) ProtoMessage

func (*GroupKind) ProtoMessage()

func (*GroupKind) Reset

func (m *GroupKind) Reset()

func (*GroupKind) Size

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

func (*GroupKind) String

func (gk *GroupKind) String() string

func (*GroupKind) Unmarshal

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

type GroupResource

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 (*GroupResource) Descriptor

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

func (*GroupResource) Marshal

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

func (*GroupResource) MarshalTo

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

func (*GroupResource) ProtoMessage

func (*GroupResource) ProtoMessage()

func (*GroupResource) Reset

func (m *GroupResource) Reset()

func (*GroupResource) Size

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

func (*GroupResource) String

func (gr *GroupResource) String() string

func (*GroupResource) Unmarshal

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

type GroupVersion

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 (*GroupVersion) Descriptor

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

func (GroupVersion) Empty

func (gv GroupVersion) Empty() bool

Empty returns true if group and version are empty

func (*GroupVersion) Marshal

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

func (GroupVersion) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface.

func (*GroupVersion) MarshalTo

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

func (*GroupVersion) ProtoMessage

func (*GroupVersion) ProtoMessage()

func (*GroupVersion) Reset

func (m *GroupVersion) Reset()

func (*GroupVersion) Size

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

func (GroupVersion) String

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

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

func (*GroupVersion) UnmarshalJSON

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

UnmarshalJSON implements the json.Unmarshaller interface.

func (*GroupVersion) UnmarshalText

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

UnmarshalTEXT implements the Ugorji's encoding.TextUnmarshaler interface.

type GroupVersionForDiscovery

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

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

func (*GroupVersionForDiscovery) Marshal

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

func (*GroupVersionForDiscovery) MarshalTo

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

func (*GroupVersionForDiscovery) ProtoMessage

func (*GroupVersionForDiscovery) ProtoMessage()

func (*GroupVersionForDiscovery) Reset

func (m *GroupVersionForDiscovery) Reset()

func (*GroupVersionForDiscovery) Size

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

func (*GroupVersionForDiscovery) String

func (this *GroupVersionForDiscovery) String() string

func (GroupVersionForDiscovery) SwaggerDoc

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

func (*GroupVersionForDiscovery) Unmarshal

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

type GroupVersionKind

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 (*GroupVersionKind) Descriptor

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

func (*GroupVersionKind) Marshal

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

func (*GroupVersionKind) MarshalTo

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

func (*GroupVersionKind) ProtoMessage

func (*GroupVersionKind) ProtoMessage()

func (*GroupVersionKind) Reset

func (m *GroupVersionKind) Reset()

func (*GroupVersionKind) Size

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

func (GroupVersionKind) String

func (gvk GroupVersionKind) String() string

func (*GroupVersionKind) Unmarshal

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

type GroupVersionResource

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

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

func (*GroupVersionResource) Marshal

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

func (*GroupVersionResource) MarshalTo

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

func (*GroupVersionResource) ProtoMessage

func (*GroupVersionResource) ProtoMessage()

func (*GroupVersionResource) Reset

func (m *GroupVersionResource) Reset()

func (*GroupVersionResource) Size

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

func (*GroupVersionResource) String

func (gvr *GroupVersionResource) String() string

func (*GroupVersionResource) Unmarshal

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

type InternalEvent

type InternalEvent watch.Event

InternalEvent makes watch.Event versioned +protobuf=false

func (*InternalEvent) GetObjectKind

func (e *InternalEvent) GetObjectKind() schema.ObjectKind

type LabelSelector

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 AddLabelToSelector

func AddLabelToSelector(selector *LabelSelector, labelKey, labelValue string) *LabelSelector

AddLabelToSelector returns a selector with the given key and value added to the given selector's MatchLabels.

func CloneSelectorAndAddLabel

func CloneSelectorAndAddLabel(selector *LabelSelector, labelKey, labelValue string) *LabelSelector

Clones the given selector and returns a new selector with the given key and value added. Returns the given selector, if labelKey is empty.

func ParseToLabelSelector

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

func SetAsLabelSelector(ls labels.Set) *LabelSelector

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

func (*LabelSelector) Descriptor

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

func (*LabelSelector) Marshal

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

func (*LabelSelector) MarshalTo

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

func (*LabelSelector) ProtoMessage

func (*LabelSelector) ProtoMessage()

func (*LabelSelector) Reset

func (m *LabelSelector) Reset()

func (*LabelSelector) Size

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

func (*LabelSelector) String

func (this *LabelSelector) String() string

func (LabelSelector) SwaggerDoc

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

func (*LabelSelector) Unmarshal

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

type LabelSelectorOperator

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

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

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

func (*LabelSelectorRequirement) Marshal

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

func (*LabelSelectorRequirement) MarshalTo

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

func (*LabelSelectorRequirement) ProtoMessage

func (*LabelSelectorRequirement) ProtoMessage()

func (*LabelSelectorRequirement) Reset

func (m *LabelSelectorRequirement) Reset()

func (*LabelSelectorRequirement) Size

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

func (*LabelSelectorRequirement) String

func (this *LabelSelectorRequirement) String() string

func (LabelSelectorRequirement) SwaggerDoc

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

func (*LabelSelectorRequirement) Unmarshal

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

type List

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 ListMetaFor

func ListMetaFor(obj runtime.Object) (*ListMeta, error)

ListMetaFor returns a pointer to a provided object's ListMeta, or an error if the object does not have that pointer. TODO: allow runtime.Unknown to extract this object TODO: Remove this function and use meta.ObjectMetaAccessor() instead.

func (*ListMeta) Descriptor

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

func (*ListMeta) GetListMeta

func (obj *ListMeta) GetListMeta() List

func (*ListMeta) GetResourceVersion

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

func (*ListMeta) Marshal

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

func (*ListMeta) MarshalTo

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

func (*ListMeta) ProtoMessage

func (*ListMeta) ProtoMessage()

func (*ListMeta) Reset

func (m *ListMeta) Reset()

func (*ListMeta) SetResourceVersion

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

func (*ListMeta) Size

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

func (*ListMeta) String

func (this *ListMeta) String() string

func (ListMeta) SwaggerDoc

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

func (*ListMeta) Unmarshal

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

type ListMetaAccessor

type ListMetaAccessor interface {
	GetListMeta() List
}

ListMetaAccessor retrieves the list interface from an object

type ListOptions

type ListOptions struct {
	TypeMeta `json:",inline"`

	// A selector to restrict the list of returned objects by their labels.
	// Defaults to everything.
	// +optional
	LabelSelector string `json:"labelSelector,omitempty" protobuf:"bytes,1,opt,name=labelSelector"`
	// A selector to restrict the list of returned objects by their fields.
	// Defaults to everything.
	// +optional
	FieldSelector string `json:"fieldSelector,omitempty" protobuf:"bytes,2,opt,name=fieldSelector"`
	// Watch for changes to the described resources and return them as a stream of
	// add, update, and remove notifications. Specify resourceVersion.
	// +optional
	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.
	// 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
	ResourceVersion string `json:"resourceVersion,omitempty" protobuf:"bytes,4,opt,name=resourceVersion"`
	// Timeout for the list/watch call.
	// +optional
	TimeoutSeconds *int64 `json:"timeoutSeconds,omitempty" protobuf:"varint,5,opt,name=timeoutSeconds"`
}

ListOptions is the query options to a standard REST list call.

func SingleObject

func SingleObject(meta ObjectMeta) ListOptions

SingleObject returns a ListOptions for watching a single object.

func (*ListOptions) Descriptor

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

func (*ListOptions) Marshal

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

func (*ListOptions) MarshalTo

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

func (*ListOptions) ProtoMessage

func (*ListOptions) ProtoMessage()

func (*ListOptions) Reset

func (m *ListOptions) Reset()

func (*ListOptions) Size

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

func (*ListOptions) String

func (this *ListOptions) String() string

func (ListOptions) SwaggerDoc

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

func (*ListOptions) Unmarshal

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

type Object

type Object interface {
	GetNamespace() string
	SetNamespace(namespace string)
	GetName() string
	SetName(name string)
	GetGenerateName() string
	SetGenerateName(name string)
	GetUID() types.UID
	SetUID(uid types.UID)
	GetResourceVersion() string
	SetResourceVersion(version string)
	GetSelfLink() string
	SetSelfLink(selfLink string)
	GetCreationTimestamp() Time
	SetCreationTimestamp(timestamp Time)
	GetDeletionTimestamp() *Time
	SetDeletionTimestamp(timestamp *Time)
	GetLabels() map[string]string
	SetLabels(labels map[string]string)
	GetAnnotations() map[string]string
	SetAnnotations(annotations map[string]string)
	GetFinalizers() []string
	SetFinalizers(finalizers []string)
	GetOwnerReferences() []OwnerReference
	SetOwnerReferences([]OwnerReference)
	GetClusterName() string
	SetClusterName(clusterName string)
}

Object lets you work with object 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 (Name, UID, Namespace on lists) will be a no-op and return a default value.

type ObjectMeta

type ObjectMeta struct {
	// Name must be unique within a namespace. Is required when creating resources, although
	// some resources may allow a client to request the generation of an appropriate name
	// automatically. Name is primarily intended for creation idempotence and configuration
	// definition.
	// Cannot be updated.
	// More info: http://kubernetes.io/docs/user-guide/identifiers#names
	// +optional
	Name string `json:"name,omitempty" protobuf:"bytes,1,opt,name=name"`

	// GenerateName is an optional prefix, used by the server, to generate a unique
	// name ONLY IF the Name field has not been provided.
	// If this field is used, the name returned to the client will be different
	// than the name passed. This value will also be combined with a unique suffix.
	// The provided value has the same validation rules as the Name field,
	// and may be truncated by the length of the suffix required to make the value
	// unique on the server.
	//
	// If this field is specified and the generated name exists, the server will
	// NOT return a 409 - instead, it will either return 201 Created or 500 with Reason
	// ServerTimeout indicating a unique name could not be found in the time allotted, and the client
	// should retry (optionally after the time indicated in the Retry-After header).
	//
	// Applied only if Name is not specified.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency
	// +optional
	GenerateName string `json:"generateName,omitempty" protobuf:"bytes,2,opt,name=generateName"`

	// Namespace defines the space within each name must be unique. An empty namespace is
	// equivalent to the "default" namespace, but "default" is the canonical representation.
	// Not all objects are required to be scoped to a namespace - the value of this field for
	// those objects will be empty.
	//
	// Must be a DNS_LABEL.
	// Cannot be updated.
	// More info: http://kubernetes.io/docs/user-guide/namespaces
	// +optional
	Namespace string `json:"namespace,omitempty" protobuf:"bytes,3,opt,name=namespace"`

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

	// UID is the unique in time and space value for this object. It is typically generated by
	// the server on successful creation of a resource and is not allowed to change on PUT
	// operations.
	//
	// Populated by the system.
	// Read-only.
	// More info: http://kubernetes.io/docs/user-guide/identifiers#uids
	// +optional
	UID types.UID `json:"uid,omitempty" protobuf:"bytes,5,opt,name=uid,casttype=k8s.io/kubernetes/pkg/types.UID"`

	// An opaque value that represents the internal version of this object that can
	// be used by clients to determine when objects have changed. May be used for optimistic
	// concurrency, change detection, and the watch operation on a resource or set of resources.
	// Clients must treat these values as opaque and passed unmodified back to the server.
	// They may only be valid for a particular resource or set of resources.
	//
	// Populated by the system.
	// Read-only.
	// Value must be treated as opaque by clients and .
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency
	// +optional
	ResourceVersion string `json:"resourceVersion,omitempty" protobuf:"bytes,6,opt,name=resourceVersion"`

	// A sequence number representing a specific generation of the desired state.
	// Populated by the system. Read-only.
	// +optional
	Generation int64 `json:"generation,omitempty" protobuf:"varint,7,opt,name=generation"`

	// CreationTimestamp is a timestamp representing the server time when this object was
	// created. It is not guaranteed to be set in happens-before order across separate operations.
	// Clients may not set this value. It is represented in RFC3339 form and is in UTC.
	//
	// Populated by the system.
	// Read-only.
	// Null for lists.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	// +optional
	CreationTimestamp Time `json:"creationTimestamp,omitempty" protobuf:"bytes,8,opt,name=creationTimestamp"`

	// DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
	// field is set by the server when a graceful deletion is requested by the user, and is not
	// directly settable by a client. The resource is expected to be deleted (no longer visible
	// from resource lists, and not reachable by name) after the time in this field. Once set,
	// this value may not be unset or be set further into the future, although it may be shortened
	// or the resource may be deleted prior to this time. For example, a user may request that
	// a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination
	// signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard
	// termination signal (SIGKILL) to the container and after cleanup, remove the pod from the
	// API. In the presence of network partitions, this object may still exist after this
	// timestamp, until an administrator or automated process can determine the resource is
	// fully terminated.
	// If not set, graceful deletion of the object has not been requested.
	//
	// Populated by the system when a graceful deletion is requested.
	// Read-only.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
	// +optional
	DeletionTimestamp *Time `json:"deletionTimestamp,omitempty" protobuf:"bytes,9,opt,name=deletionTimestamp"`

	// Number of seconds allowed for this object to gracefully terminate before
	// it will be removed from the system. Only set when deletionTimestamp is also set.
	// May only be shortened.
	// Read-only.
	// +optional
	DeletionGracePeriodSeconds *int64 `json:"deletionGracePeriodSeconds,omitempty" protobuf:"varint,10,opt,name=deletionGracePeriodSeconds"`

	// Map of string keys and values that can be used to organize and categorize
	// (scope and select) objects. May match selectors of replication controllers
	// and services.
	// More info: http://kubernetes.io/docs/user-guide/labels
	// +optional
	Labels map[string]string `json:"labels,omitempty" protobuf:"bytes,11,rep,name=labels"`

	// Annotations is an unstructured key value map stored with a resource that may be
	// set by external tools to store and retrieve arbitrary metadata. They are not
	// queryable and should be preserved when modifying objects.
	// More info: http://kubernetes.io/docs/user-guide/annotations
	// +optional
	Annotations map[string]string `json:"annotations,omitempty" protobuf:"bytes,12,rep,name=annotations"`

	// List of objects depended by this object. If ALL objects in the list have
	// been deleted, this object will be garbage collected. If this object is managed by a controller,
	// then an entry in this list will point to this controller, with the controller field set to true.
	// There cannot be more than one managing controller.
	// +optional
	OwnerReferences []OwnerReference `json:"ownerReferences,omitempty" patchStrategy:"merge" patchMergeKey:"uid" protobuf:"bytes,13,rep,name=ownerReferences"`

	// Must be empty before the object is deleted from the registry. Each entry
	// is an identifier for the responsible component that will remove the entry
	// from the list. If the deletionTimestamp of the object is non-nil, entries
	// in this list can only be removed.
	// +optional
	Finalizers []string `json:"finalizers,omitempty" patchStrategy:"merge" protobuf:"bytes,14,rep,name=finalizers"`

	// The name of the cluster which the object belongs to.
	// This is used to distinguish resources with same name and namespace in different clusters.
	// This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
	// +optional
	ClusterName string `json:"clusterName,omitempty" protobuf:"bytes,15,opt,name=clusterName"`
}

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

func ObjectMetaFor

func ObjectMetaFor(obj runtime.Object) (*ObjectMeta, error)

ObjectMetaFor returns a pointer to a provided object's ObjectMeta. TODO: allow runtime.Unknown to extract this object TODO: Remove this function and use meta.ObjectMetaAccessor() instead.

func (*ObjectMeta) Descriptor

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

func (*ObjectMeta) GetAnnotations

func (meta *ObjectMeta) GetAnnotations() map[string]string

func (*ObjectMeta) GetClusterName

func (meta *ObjectMeta) GetClusterName() string

func (*ObjectMeta) GetCreationTimestamp

func (meta *ObjectMeta) GetCreationTimestamp() Time

func (*ObjectMeta) GetDeletionTimestamp

func (meta *ObjectMeta) GetDeletionTimestamp() *Time

func (*ObjectMeta) GetFinalizers

func (meta *ObjectMeta) GetFinalizers() []string

func (*ObjectMeta) GetGenerateName

func (meta *ObjectMeta) GetGenerateName() string

func (*ObjectMeta) GetLabels

func (meta *ObjectMeta) GetLabels() map[string]string

func (*ObjectMeta) GetName

func (meta *ObjectMeta) GetName() string

func (*ObjectMeta) GetNamespace

func (meta *ObjectMeta) GetNamespace() string

Namespace implements metav1.Object for any object with an ObjectMeta typed field. Allows fast, direct access to metadata fields for API objects.

func (*ObjectMeta) GetObjectMeta

func (obj *ObjectMeta) GetObjectMeta() Object

func (*ObjectMeta) GetOwnerReferences

func (meta *ObjectMeta) GetOwnerReferences() []OwnerReference

func (*ObjectMeta) GetResourceVersion

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

func (*ObjectMeta) GetUID

func (meta *ObjectMeta) GetUID() types.UID

func (*ObjectMeta) Marshal

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

func (*ObjectMeta) MarshalTo

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

func (*ObjectMeta) ProtoMessage

func (*ObjectMeta) ProtoMessage()

func (*ObjectMeta) Reset

func (m *ObjectMeta) Reset()

func (*ObjectMeta) SetAnnotations

func (meta *ObjectMeta) SetAnnotations(annotations map[string]string)

func (*ObjectMeta) SetClusterName

func (meta *ObjectMeta) SetClusterName(clusterName string)

func (*ObjectMeta) SetCreationTimestamp

func (meta *ObjectMeta) SetCreationTimestamp(creationTimestamp Time)

func (*ObjectMeta) SetDeletionTimestamp

func (meta *ObjectMeta) SetDeletionTimestamp(deletionTimestamp *Time)

func (*ObjectMeta) SetFinalizers

func (meta *ObjectMeta) SetFinalizers(finalizers []string)

func (*ObjectMeta) SetGenerateName

func (meta *ObjectMeta) SetGenerateName(generateName string)

func (*ObjectMeta) SetLabels

func (meta *ObjectMeta) SetLabels(labels map[string]string)

func (*ObjectMeta) SetName

func (meta *ObjectMeta) SetName(name string)

func (*ObjectMeta) SetNamespace

func (meta *ObjectMeta) SetNamespace(namespace string)

func (*ObjectMeta) SetOwnerReferences

func (meta *ObjectMeta) SetOwnerReferences(references []OwnerReference)

func (*ObjectMeta) SetResourceVersion

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

func (*ObjectMeta) SetUID

func (meta *ObjectMeta) SetUID(uid types.UID)

func (*ObjectMeta) Size

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

func (*ObjectMeta) String

func (this *ObjectMeta) String() string

func (ObjectMeta) SwaggerDoc

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

func (*ObjectMeta) Unmarshal

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

type ObjectMetaAccessor

type ObjectMetaAccessor interface {
	GetObjectMeta() Object
}

TODO: move this, Object, List, and Type to a different package

type OwnerReference

type OwnerReference struct {
	// API version of the referent.
	APIVersion string `json:"apiVersion" protobuf:"bytes,5,opt,name=apiVersion"`
	// Kind of the referent.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
	Kind string `json:"kind" protobuf:"bytes,1,opt,name=kind"`
	// Name of the referent.
	// More info: http://kubernetes.io/docs/user-guide/identifiers#names
	Name string `json:"name" protobuf:"bytes,3,opt,name=name"`
	// UID of the referent.
	// More info: http://kubernetes.io/docs/user-guide/identifiers#uids
	UID types.UID `json:"uid" protobuf:"bytes,4,opt,name=uid,casttype=k8s.io/apimachinery/pkg/types.UID"`
	// If true, this reference points to the managing controller.
	// +optional
	Controller *bool `json:"controller,omitempty" protobuf:"varint,6,opt,name=controller"`
	// If true, AND if the owner has the "foregroundDeletion" finalizer, then
	// the owner cannot be deleted from the key-value store until this
	// reference is removed.
	// Defaults to false.
	// To set this field, a user needs "delete" permission of the owner,
	// otherwise 422 (Unprocessable Entity) will be returned.
	// +optional
	BlockOwnerDeletion *bool `json:"blockOwnerDeletion,omitempty" protobuf:"varint,7,opt,name=blockOwnerDeletion"`
}

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

func (*OwnerReference) Descriptor

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

func (*OwnerReference) Marshal

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

func (*OwnerReference) MarshalTo

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

func (*OwnerReference) ProtoMessage

func (*OwnerReference) ProtoMessage()

func (*OwnerReference) Reset

func (m *OwnerReference) Reset()

func (*OwnerReference) Size

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

func (*OwnerReference) String

func (this *OwnerReference) String() string

func (OwnerReference) SwaggerDoc

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

func (*OwnerReference) Unmarshal

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

type Patch

type Patch struct{}

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

func (Patch) SwaggerDoc

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

type Preconditions

type Preconditions struct {
	// Specifies the target UID.
	// +optional
	UID *types.UID `json:"uid,omitempty" protobuf:"bytes,1,opt,name=uid,casttype=k8s.io/apimachinery/pkg/types.UID"`
}

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

func NewUIDPreconditions

func NewUIDPreconditions(uid string) *Preconditions

NewUIDPreconditions returns a Preconditions with UID set.

func (*Preconditions) Descriptor

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

func (*Preconditions) Marshal

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

func (*Preconditions) MarshalTo

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

func (*Preconditions) ProtoMessage

func (*Preconditions) ProtoMessage()

func (*Preconditions) Reset

func (m *Preconditions) Reset()

func (*Preconditions) Size

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

func (*Preconditions) String

func (this *Preconditions) String() string

func (Preconditions) SwaggerDoc

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

func (*Preconditions) Unmarshal

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

type RootPaths

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

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

func (*RootPaths) Marshal

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

func (*RootPaths) MarshalTo

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

func (*RootPaths) ProtoMessage

func (*RootPaths) ProtoMessage()

func (*RootPaths) Reset

func (m *RootPaths) Reset()

func (*RootPaths) Size

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

func (*RootPaths) String

func (this *RootPaths) String() string

func (RootPaths) SwaggerDoc

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

func (*RootPaths) Unmarshal

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

type ServerAddressByClientCIDR

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

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

func (*ServerAddressByClientCIDR) Marshal

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

func (*ServerAddressByClientCIDR) MarshalTo

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

func (*ServerAddressByClientCIDR) ProtoMessage

func (*ServerAddressByClientCIDR) ProtoMessage()

func (*ServerAddressByClientCIDR) Reset

func (m *ServerAddressByClientCIDR) Reset()

func (*ServerAddressByClientCIDR) Size

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

func (*ServerAddressByClientCIDR) String

func (this *ServerAddressByClientCIDR) String() string

func (ServerAddressByClientCIDR) SwaggerDoc

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

func (*ServerAddressByClientCIDR) Unmarshal

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

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

func (*Status) Marshal

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

func (*Status) MarshalTo

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

func (*Status) ProtoMessage

func (*Status) ProtoMessage()

func (*Status) Reset

func (m *Status) Reset()

func (*Status) Size

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

func (*Status) String

func (this *Status) String() string

func (Status) SwaggerDoc

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

func (*Status) Unmarshal

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

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

func (*StatusCause) Marshal

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

func (*StatusCause) MarshalTo

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

func (*StatusCause) ProtoMessage

func (*StatusCause) ProtoMessage()

func (*StatusCause) Reset

func (m *StatusCause) Reset()

func (*StatusCause) Size

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

func (*StatusCause) String

func (this *StatusCause) String() string

func (StatusCause) SwaggerDoc

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

func (*StatusCause) Unmarshal

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

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

func (*StatusDetails) Marshal

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

func (*StatusDetails) MarshalTo

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

func (*StatusDetails) ProtoMessage

func (*StatusDetails) ProtoMessage()

func (*StatusDetails) Reset

func (m *StatusDetails) Reset()

func (*StatusDetails) Size

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

func (*StatusDetails) String

func (this *StatusDetails) String() string

func (StatusDetails) SwaggerDoc

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

func (*StatusDetails) Unmarshal

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

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

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

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

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

MarshalQueryParameter converts to a URL query parameter value

func (*Time) MarshalTo

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

MarshalTo implements the protobuf marshalling interface.

func (Time) OpenAPIDefinition

func (_ Time) OpenAPIDefinition() openapi.OpenAPIDefinition

func (*Time) ProtoMessage

func (*Time) ProtoMessage()

func (*Time) ProtoTime

func (m *Time) ProtoTime() *Timestamp

Timestamp returns the Time as a new Timestamp value.

func (*Time) Reset

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

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

Size implements the protobuf marshalling interface.

func (Time) String

func (t Time) String() string

String returns the representation of the time.

func (*Time) Unmarshal

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

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

UnmarshalQueryParameter converts from a URL query parameter value to an object

type Timestamp

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

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

func (*Timestamp) Marshal

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

func (*Timestamp) MarshalTo

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

func (*Timestamp) ProtoMessage

func (*Timestamp) ProtoMessage()

func (*Timestamp) Reset

func (m *Timestamp) Reset()

func (*Timestamp) Size

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

func (*Timestamp) String

func (this *Timestamp) String() string

func (*Timestamp) Unmarshal

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

type Type

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

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

func (*TypeMeta) GetObjectKind

func (obj *TypeMeta) GetObjectKind() schema.ObjectKind

func (*TypeMeta) GroupVersionKind

func (obj *TypeMeta) GroupVersionKind() schema.GroupVersionKind

GroupVersionKind satisfies the ObjectKind interface for all objects that embed TypeMeta

func (*TypeMeta) Marshal

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

func (*TypeMeta) MarshalTo

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

func (*TypeMeta) ProtoMessage

func (*TypeMeta) ProtoMessage()

func (*TypeMeta) Reset

func (m *TypeMeta) Reset()

func (*TypeMeta) SetGroupVersionKind

func (obj *TypeMeta) SetGroupVersionKind(gvk schema.GroupVersionKind)

SetGroupVersionKind satisfies the ObjectKind interface for all objects that embed TypeMeta

func (*TypeMeta) Size

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

func (*TypeMeta) String

func (this *TypeMeta) String() string

func (TypeMeta) SwaggerDoc

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

func (*TypeMeta) Unmarshal

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

type Verbs

type Verbs []string

Verbs masks the value so protobuf can generate

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

func (*Verbs) Descriptor

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

func (Verbs) Marshal

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

func (Verbs) MarshalTo

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

func (*Verbs) ProtoMessage

func (*Verbs) ProtoMessage()

func (*Verbs) Reset

func (m *Verbs) Reset()

func (Verbs) Size

func (m Verbs) Size() (n int)

func (Verbs) String

func (vs Verbs) String() string

func (*Verbs) Unmarshal

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

type WatchEvent

type WatchEvent struct {
	Type string `json:"type" protobuf:"bytes,1,opt,name=type"`

	// Object is:
	//  * If Type is Added or Modified: the new state of the object.
	//  * If Type is Deleted: the state of the object immediately before deletion.
	//  * If Type is Error: *Status is recommended; other types may make sense
	//    depending on context.
	Object runtime.RawExtension `json:"object" protobuf:"bytes,2,opt,name=object"`
}

Event represents a single event to a watched resource.

+protobuf=true

func (*WatchEvent) Descriptor

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

func (*WatchEvent) GetObjectKind

func (e *WatchEvent) GetObjectKind() schema.ObjectKind

func (*WatchEvent) Marshal

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

func (*WatchEvent) MarshalTo

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

func (*WatchEvent) ProtoMessage

func (*WatchEvent) ProtoMessage()

func (*WatchEvent) Reset

func (m *WatchEvent) Reset()

func (*WatchEvent) Size

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

func (*WatchEvent) String

func (this *WatchEvent) String() string

func (*WatchEvent) Unmarshal

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL