v1alpha1

package
v0.0.0-...-d94079d Latest Latest
Warning

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

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

Documentation

Overview

+groupName=meta.k8s.io 

Package v1alpha1 is a generated protocol buffer package.

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

It has these top-level messages:
	PartialObjectMetadata
	PartialObjectMetadataList
	TableOptions

package v1alpha1 is alpha objects from meta that will be introduced.

Index

Constants

View Source 
const GroupName = "meta.k8s.io"

GroupName is the group name for this API.

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 v1alpha1 API spec.

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

SchemeGroupVersion is group version used to register these objects

Functions

func DeepCopy_v1alpha1_PartialObjectMetadata 

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

DeepCopy_v1alpha1_PartialObjectMetadata is an autogenerated deepcopy function.

func DeepCopy_v1alpha1_PartialObjectMetadataList 

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

DeepCopy_v1alpha1_PartialObjectMetadataList is an autogenerated deepcopy function.

func DeepCopy_v1alpha1_Table 

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

DeepCopy_v1alpha1_Table is an autogenerated deepcopy function.

func DeepCopy_v1alpha1_TableColumnDefinition 

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

DeepCopy_v1alpha1_TableColumnDefinition is an autogenerated deepcopy function.

func DeepCopy_v1alpha1_TableOptions 

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

DeepCopy_v1alpha1_TableOptions is an autogenerated deepcopy function.

func DeepCopy_v1alpha1_TableRow 

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

DeepCopy_v1alpha1_TableRow is an autogenerated deepcopy function.

func DeepCopy_v1alpha1_TableRowCondition 

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

DeepCopy_v1alpha1_TableRowCondition is an autogenerated deepcopy function.

func GetGeneratedDeepCopyFuncs 

func GetGeneratedDeepCopyFuncs() []conversion.GeneratedDeepCopyFunc

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

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

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.

Types

type ConditionStatus 

type ConditionStatus string
const (
	ConditionTrue    ConditionStatus = "True"
	ConditionFalse   ConditionStatus = "False"
	ConditionUnknown ConditionStatus = "Unknown"
)

These are valid condition statuses. "ConditionTrue" means a resource is in the condition. "ConditionFalse" means a resource is not in the condition. "ConditionUnknown" means kubernetes can't decide if a resource is in the condition or not. In the future, we could add other intermediate conditions, e.g. ConditionDegraded.

type IncludeObjectPolicy 

type IncludeObjectPolicy string

IncludeObjectPolicy controls which portion of the object is returned with a Table. 

const (
	// IncludeNone returns no object.
	IncludeNone IncludeObjectPolicy = "None"
	// IncludeMetadata serializes the object containing only its metadata field.
	IncludeMetadata IncludeObjectPolicy = "Metadata"
	// IncludeObject contains the full object.
	IncludeObject IncludeObjectPolicy = "Object"
)

type PartialObjectMetadata 

type PartialObjectMetadata struct {
	v1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	v1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
}

PartialObjectMetadata is a generic representation of any object with ObjectMeta. It allows clients to get access to a particular ObjectMeta schema without knowing the details of the version.

func (*PartialObjectMetadata) Descriptor 

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

func (*PartialObjectMetadata) Marshal 

func (m *PartialObjectMetadata) Marshal() (dAtA []byte, err error)

func (*PartialObjectMetadata) MarshalTo 

func (m *PartialObjectMetadata) MarshalTo(dAtA []byte) (int, error)

func (*PartialObjectMetadata) ProtoMessage 

func (*PartialObjectMetadata) ProtoMessage()

func (*PartialObjectMetadata) Reset 

func (m *PartialObjectMetadata) Reset()

func (*PartialObjectMetadata) Size 

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

func (*PartialObjectMetadata) String 

func (this *PartialObjectMetadata) String() string

func (PartialObjectMetadata) SwaggerDoc 

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

func (*PartialObjectMetadata) Unmarshal 

func (m *PartialObjectMetadata) Unmarshal(dAtA []byte) error

type PartialObjectMetadataList 

type PartialObjectMetadataList struct {
	v1.TypeMeta `json:",inline"`

	// items contains each of the included items.
	Items []*PartialObjectMetadata `json:"items" protobuf:"bytes,1,rep,name=items"`
}

PartialObjectMetadataList contains a list of objects containing only their metadata

func (*PartialObjectMetadataList) Descriptor 

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

func (*PartialObjectMetadataList) Marshal 

func (m *PartialObjectMetadataList) Marshal() (dAtA []byte, err error)

func (*PartialObjectMetadataList) MarshalTo 

func (m *PartialObjectMetadataList) MarshalTo(dAtA []byte) (int, error)

func (*PartialObjectMetadataList) ProtoMessage 

func (*PartialObjectMetadataList) ProtoMessage()

func (*PartialObjectMetadataList) Reset 

func (m *PartialObjectMetadataList) Reset()

func (*PartialObjectMetadataList) Size 

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

func (*PartialObjectMetadataList) String 

func (this *PartialObjectMetadataList) String() string

func (PartialObjectMetadataList) SwaggerDoc 

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

func (*PartialObjectMetadataList) Unmarshal 

func (m *PartialObjectMetadataList) Unmarshal(dAtA []byte) error

type RowConditionType 

type RowConditionType string
const (
	// RowCompleted means the underlying resource has reached completion and may be given less
	// visual priority than other resources.
	RowCompleted RowConditionType = "Completed"
)

These are valid conditions of a row. This list is not exhaustive and new conditions may be inculded by other resources.

type Table 

type Table struct {
	v1.TypeMeta `json:",inline"`
	// Standard list metadata.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
	// +optional
	v1.ListMeta `json:"metadata,omitempty"`

	// columnDefinitions describes each column in the returned items array. The number of cells per row
	// will always match the number of column definitions.
	ColumnDefinitions []TableColumnDefinition `json:"columnDefinitions"`
	// rows is the list of items in the table.
	Rows []TableRow `json:"rows"`
}

Table is a tabular representation of a set of API resources. The server transforms the object into a set of preferred columns for quickly reviewing the objects. +protobuf=false

func (Table) SwaggerDoc 

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

type TableColumnDefinition 

type TableColumnDefinition struct {
	// name is a human readable name for the column.
	Name string `json:"name"`
	// type is an OpenAPI type definition for this column.
	// See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more.
	Type string `json:"type"`
	// format is an optional OpenAPI type definition for this column. The 'name' format is applied
	// to the primary identifier column to assist in clients identifying column is the resource name.
	// See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more.
	Format string `json:"format"`
	// description is a human readable description of this column.
	Description string `json:"description"`
	// priority is an integer defining the relative importance of this column compared to others. Lower
	// numbers are considered higher priority. Columns that may be omitted in limited space scenarios
	// should be given a higher priority.
	Priority int32 `json:"priority"`
}

TableColumnDefinition contains information about a column returned in the Table. +protobuf=false

func (TableColumnDefinition) SwaggerDoc 

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

type TableOptions 

type TableOptions struct {
	v1.TypeMeta `json:",inline"`
	// includeObject decides whether to include each object along with its columnar information.
	// Specifying "None" will return no object, specifying "Object" will return the full object contents, and
	// specifying "Metadata" (the default) will return the object's metadata in the PartialObjectMetadata kind
	// in version v1alpha1 of the meta.k8s.io API group.
	IncludeObject IncludeObjectPolicy `json:"includeObject,omitempty" protobuf:"bytes,1,opt,name=includeObject,casttype=IncludeObjectPolicy"`
}

TableOptions are used when a Table is requested by the caller.

func (*TableOptions) Descriptor 

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

func (*TableOptions) Marshal 

func (m *TableOptions) Marshal() (dAtA []byte, err error)

func (*TableOptions) MarshalTo 

func (m *TableOptions) MarshalTo(dAtA []byte) (int, error)

func (*TableOptions) ProtoMessage 

func (*TableOptions) ProtoMessage()

func (*TableOptions) Reset 

func (m *TableOptions) Reset()

func (*TableOptions) Size 

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

func (*TableOptions) String 

func (this *TableOptions) String() string

func (TableOptions) SwaggerDoc 

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

func (*TableOptions) Unmarshal 

func (m *TableOptions) Unmarshal(dAtA []byte) error

type TableRow 

type TableRow struct {
	// cells will be as wide as headers and may contain strings, numbers, booleans, simple maps, or lists, or
	// null. See the type field of the column definition for a more detailed description.
	Cells []interface{} `json:"cells"`
	// conditions describe additional status of a row that are relevant for a human user.
	// +optional
	Conditions []TableRowCondition `json:"conditions,omitempty"`
	// This field contains the requested additional information about each object based on the includeObject
	// policy when requesting the Table. If "None", this field is empty, if "Object" this will be the
	// default serialization of the object for the current API version, and if "Metadata" (the default) will
	// contain the object metadata. Check the returned kind and apiVersion of the object before parsing.
	// +optional
	Object runtime.RawExtension `json:"object,omitempty"`
}

TableRow is an individual row in a table. +protobuf=false

func (TableRow) SwaggerDoc 

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

type TableRowCondition 

type TableRowCondition struct {
	// Type of row condition.
	Type RowConditionType `json:"type"`
	// Status of the condition, one of True, False, Unknown.
	Status ConditionStatus `json:"status"`
	// (brief) machine readable reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`
	// Human readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty"`
}

TableRowCondition allows a row to be marked with additional information. +protobuf=false

func (TableRowCondition) SwaggerDoc 

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

Source Files

View all Source files

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.