Documentation

Overview

    Package v1 is a generated protocol buffer package.

    It is generated from these files:

    k8s.io/kubernetes/vendor/k8s.io/api/storage/v1/generated.proto
    

    It has these top-level messages:

    StorageClass
    StorageClassList
    VolumeAttachment
    VolumeAttachmentList
    VolumeAttachmentSource
    VolumeAttachmentSpec
    VolumeAttachmentStatus
    VolumeError
    

    Index

    Constants

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

      GroupName is the group name use in this package

      Variables

      View Source
      var (
      	ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
      	ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
      )
      View Source
      var (
      	// TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
      	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
      	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
      
      	AddToScheme = localSchemeBuilder.AddToScheme
      )
      View Source
      var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

        SchemeGroupVersion is group version used to register these objects

        Functions

        func Resource

        func Resource(resource string) schema.GroupResource

          Resource takes an unqualified resource and returns a Group qualified GroupResource

          Types

          type StorageClass

          type StorageClass struct {
          	metav1.TypeMeta `json:",inline"`
          	// Standard object's metadata.
          	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
          	// +optional
          	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
          
          	// Provisioner indicates the type of the provisioner.
          	Provisioner string `json:"provisioner" protobuf:"bytes,2,opt,name=provisioner"`
          
          	// Parameters holds the parameters for the provisioner that should
          	// create volumes of this storage class.
          	// +optional
          	Parameters map[string]string `json:"parameters,omitempty" protobuf:"bytes,3,rep,name=parameters"`
          
          	// Dynamically provisioned PersistentVolumes of this storage class are
          	// created with this reclaimPolicy. Defaults to Delete.
          	// +optional
          	ReclaimPolicy *v1.PersistentVolumeReclaimPolicy `` /* 130-byte string literal not displayed */
          
          	// Dynamically provisioned PersistentVolumes of this storage class are
          	// created with these mountOptions, e.g. ["ro", "soft"]. Not validated -
          	// mount of the PVs will simply fail if one is invalid.
          	// +optional
          	MountOptions []string `json:"mountOptions,omitempty" protobuf:"bytes,5,opt,name=mountOptions"`
          
          	// AllowVolumeExpansion shows whether the storage class allow volume expand
          	// +optional
          	AllowVolumeExpansion *bool `json:"allowVolumeExpansion,omitempty" protobuf:"varint,6,opt,name=allowVolumeExpansion"`
          
          	// VolumeBindingMode indicates how PersistentVolumeClaims should be
          	// provisioned and bound.  When unset, VolumeBindingImmediate is used.
          	// This field is only honored by servers that enable the VolumeScheduling feature.
          	// +optional
          	VolumeBindingMode *VolumeBindingMode `json:"volumeBindingMode,omitempty" protobuf:"bytes,7,opt,name=volumeBindingMode"`
          
          	// Restrict the node topologies where volumes can be dynamically provisioned.
          	// Each volume plugin defines its own supported topology specifications.
          	// An empty TopologySelectorTerm list means there is no topology restriction.
          	// This field is only honored by servers that enable the VolumeScheduling feature.
          	// +optional
          	AllowedTopologies []v1.TopologySelectorTerm `json:"allowedTopologies,omitempty" protobuf:"bytes,8,rep,name=allowedTopologies"`
          }

            StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

            StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

            func (*StorageClass) DeepCopy

            func (in *StorageClass) DeepCopy() *StorageClass

              DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageClass.

              func (*StorageClass) DeepCopyInto

              func (in *StorageClass) DeepCopyInto(out *StorageClass)

                DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                func (*StorageClass) DeepCopyObject

                func (in *StorageClass) DeepCopyObject() runtime.Object

                  DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                  func (*StorageClass) Descriptor

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

                  func (*StorageClass) Marshal

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

                  func (*StorageClass) MarshalTo

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

                  func (*StorageClass) ProtoMessage

                  func (*StorageClass) ProtoMessage()

                  func (*StorageClass) Reset

                  func (m *StorageClass) Reset()

                  func (*StorageClass) Size

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

                  func (*StorageClass) String

                  func (this *StorageClass) String() string

                  func (StorageClass) SwaggerDoc

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

                  func (*StorageClass) Unmarshal

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

                  type StorageClassList

                  type StorageClassList struct {
                  	metav1.TypeMeta `json:",inline"`
                  	// Standard list metadata
                  	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
                  	// +optional
                  	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
                  
                  	// Items is the list of StorageClasses
                  	Items []StorageClass `json:"items" protobuf:"bytes,2,rep,name=items"`
                  }

                    StorageClassList is a collection of storage classes.

                    func (*StorageClassList) DeepCopy

                    func (in *StorageClassList) DeepCopy() *StorageClassList

                      DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageClassList.

                      func (*StorageClassList) DeepCopyInto

                      func (in *StorageClassList) DeepCopyInto(out *StorageClassList)

                        DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                        func (*StorageClassList) DeepCopyObject

                        func (in *StorageClassList) DeepCopyObject() runtime.Object

                          DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                          func (*StorageClassList) Descriptor

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

                          func (*StorageClassList) Marshal

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

                          func (*StorageClassList) MarshalTo

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

                          func (*StorageClassList) ProtoMessage

                          func (*StorageClassList) ProtoMessage()

                          func (*StorageClassList) Reset

                          func (m *StorageClassList) Reset()

                          func (*StorageClassList) Size

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

                          func (*StorageClassList) String

                          func (this *StorageClassList) String() string

                          func (StorageClassList) SwaggerDoc

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

                          func (*StorageClassList) Unmarshal

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

                          type VolumeAttachment

                          type VolumeAttachment struct {
                          	metav1.TypeMeta `json:",inline"`
                          
                          	// Standard object metadata.
                          	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
                          	// +optional
                          	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
                          
                          	// Specification of the desired attach/detach volume behavior.
                          	// Populated by the Kubernetes system.
                          	Spec VolumeAttachmentSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`
                          
                          	// Status of the VolumeAttachment request.
                          	// Populated by the entity completing the attach or detach
                          	// operation, i.e. the external-attacher.
                          	// +optional
                          	Status VolumeAttachmentStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
                          }

                            VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

                            VolumeAttachment objects are non-namespaced.

                            func (*VolumeAttachment) DeepCopy

                            func (in *VolumeAttachment) DeepCopy() *VolumeAttachment

                              DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachment.

                              func (*VolumeAttachment) DeepCopyInto

                              func (in *VolumeAttachment) DeepCopyInto(out *VolumeAttachment)

                                DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                func (*VolumeAttachment) DeepCopyObject

                                func (in *VolumeAttachment) DeepCopyObject() runtime.Object

                                  DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                                  func (*VolumeAttachment) Descriptor

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

                                  func (*VolumeAttachment) Marshal

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

                                  func (*VolumeAttachment) MarshalTo

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

                                  func (*VolumeAttachment) ProtoMessage

                                  func (*VolumeAttachment) ProtoMessage()

                                  func (*VolumeAttachment) Reset

                                  func (m *VolumeAttachment) Reset()

                                  func (*VolumeAttachment) Size

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

                                  func (*VolumeAttachment) String

                                  func (this *VolumeAttachment) String() string

                                  func (VolumeAttachment) SwaggerDoc

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

                                  func (*VolumeAttachment) Unmarshal

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

                                  type VolumeAttachmentList

                                  type VolumeAttachmentList struct {
                                  	metav1.TypeMeta `json:",inline"`
                                  	// Standard list metadata
                                  	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
                                  	// +optional
                                  	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
                                  
                                  	// Items is the list of VolumeAttachments
                                  	Items []VolumeAttachment `json:"items" protobuf:"bytes,2,rep,name=items"`
                                  }

                                    VolumeAttachmentList is a collection of VolumeAttachment objects.

                                    func (*VolumeAttachmentList) DeepCopy

                                      DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachmentList.

                                      func (*VolumeAttachmentList) DeepCopyInto

                                      func (in *VolumeAttachmentList) DeepCopyInto(out *VolumeAttachmentList)

                                        DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                        func (*VolumeAttachmentList) DeepCopyObject

                                        func (in *VolumeAttachmentList) DeepCopyObject() runtime.Object

                                          DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                                          func (*VolumeAttachmentList) Descriptor

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

                                          func (*VolumeAttachmentList) Marshal

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

                                          func (*VolumeAttachmentList) MarshalTo

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

                                          func (*VolumeAttachmentList) ProtoMessage

                                          func (*VolumeAttachmentList) ProtoMessage()

                                          func (*VolumeAttachmentList) Reset

                                          func (m *VolumeAttachmentList) Reset()

                                          func (*VolumeAttachmentList) Size

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

                                          func (*VolumeAttachmentList) String

                                          func (this *VolumeAttachmentList) String() string

                                          func (VolumeAttachmentList) SwaggerDoc

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

                                          func (*VolumeAttachmentList) Unmarshal

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

                                          type VolumeAttachmentSource

                                          type VolumeAttachmentSource struct {
                                          	// Name of the persistent volume to attach.
                                          	// +optional
                                          	PersistentVolumeName *string `json:"persistentVolumeName,omitempty" protobuf:"bytes,1,opt,name=persistentVolumeName"`
                                          }

                                            VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.

                                            func (*VolumeAttachmentSource) DeepCopy

                                              DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachmentSource.

                                              func (*VolumeAttachmentSource) DeepCopyInto

                                              func (in *VolumeAttachmentSource) DeepCopyInto(out *VolumeAttachmentSource)

                                                DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                func (*VolumeAttachmentSource) Descriptor

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

                                                func (*VolumeAttachmentSource) Marshal

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

                                                func (*VolumeAttachmentSource) MarshalTo

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

                                                func (*VolumeAttachmentSource) ProtoMessage

                                                func (*VolumeAttachmentSource) ProtoMessage()

                                                func (*VolumeAttachmentSource) Reset

                                                func (m *VolumeAttachmentSource) Reset()

                                                func (*VolumeAttachmentSource) Size

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

                                                func (*VolumeAttachmentSource) String

                                                func (this *VolumeAttachmentSource) String() string

                                                func (VolumeAttachmentSource) SwaggerDoc

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

                                                func (*VolumeAttachmentSource) Unmarshal

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

                                                type VolumeAttachmentSpec

                                                type VolumeAttachmentSpec struct {
                                                	// Attacher indicates the name of the volume driver that MUST handle this
                                                	// request. This is the name returned by GetPluginName().
                                                	Attacher string `json:"attacher" protobuf:"bytes,1,opt,name=attacher"`
                                                
                                                	// Source represents the volume that should be attached.
                                                	Source VolumeAttachmentSource `json:"source" protobuf:"bytes,2,opt,name=source"`
                                                
                                                	// The node that the volume should be attached to.
                                                	NodeName string `json:"nodeName" protobuf:"bytes,3,opt,name=nodeName"`
                                                }

                                                  VolumeAttachmentSpec is the specification of a VolumeAttachment request.

                                                  func (*VolumeAttachmentSpec) DeepCopy

                                                    DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachmentSpec.

                                                    func (*VolumeAttachmentSpec) DeepCopyInto

                                                    func (in *VolumeAttachmentSpec) DeepCopyInto(out *VolumeAttachmentSpec)

                                                      DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                      func (*VolumeAttachmentSpec) Descriptor

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

                                                      func (*VolumeAttachmentSpec) Marshal

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

                                                      func (*VolumeAttachmentSpec) MarshalTo

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

                                                      func (*VolumeAttachmentSpec) ProtoMessage

                                                      func (*VolumeAttachmentSpec) ProtoMessage()

                                                      func (*VolumeAttachmentSpec) Reset

                                                      func (m *VolumeAttachmentSpec) Reset()

                                                      func (*VolumeAttachmentSpec) Size

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

                                                      func (*VolumeAttachmentSpec) String

                                                      func (this *VolumeAttachmentSpec) String() string

                                                      func (VolumeAttachmentSpec) SwaggerDoc

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

                                                      func (*VolumeAttachmentSpec) Unmarshal

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

                                                      type VolumeAttachmentStatus

                                                      type VolumeAttachmentStatus struct {
                                                      	// Indicates the volume is successfully attached.
                                                      	// This field must only be set by the entity completing the attach
                                                      	// operation, i.e. the external-attacher.
                                                      	Attached bool `json:"attached" protobuf:"varint,1,opt,name=attached"`
                                                      
                                                      	// Upon successful attach, this field is populated with any
                                                      	// information returned by the attach operation that must be passed
                                                      	// into subsequent WaitForAttach or Mount calls.
                                                      	// This field must only be set by the entity completing the attach
                                                      	// operation, i.e. the external-attacher.
                                                      	// +optional
                                                      	AttachmentMetadata map[string]string `json:"attachmentMetadata,omitempty" protobuf:"bytes,2,rep,name=attachmentMetadata"`
                                                      
                                                      	// The last error encountered during attach operation, if any.
                                                      	// This field must only be set by the entity completing the attach
                                                      	// operation, i.e. the external-attacher.
                                                      	// +optional
                                                      	AttachError *VolumeError `json:"attachError,omitempty" protobuf:"bytes,3,opt,name=attachError,casttype=VolumeError"`
                                                      
                                                      	// The last error encountered during detach operation, if any.
                                                      	// This field must only be set by the entity completing the detach
                                                      	// operation, i.e. the external-attacher.
                                                      	// +optional
                                                      	DetachError *VolumeError `json:"detachError,omitempty" protobuf:"bytes,4,opt,name=detachError,casttype=VolumeError"`
                                                      }

                                                        VolumeAttachmentStatus is the status of a VolumeAttachment request.

                                                        func (*VolumeAttachmentStatus) DeepCopy

                                                          DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachmentStatus.

                                                          func (*VolumeAttachmentStatus) DeepCopyInto

                                                          func (in *VolumeAttachmentStatus) DeepCopyInto(out *VolumeAttachmentStatus)

                                                            DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                            func (*VolumeAttachmentStatus) Descriptor

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

                                                            func (*VolumeAttachmentStatus) Marshal

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

                                                            func (*VolumeAttachmentStatus) MarshalTo

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

                                                            func (*VolumeAttachmentStatus) ProtoMessage

                                                            func (*VolumeAttachmentStatus) ProtoMessage()

                                                            func (*VolumeAttachmentStatus) Reset

                                                            func (m *VolumeAttachmentStatus) Reset()

                                                            func (*VolumeAttachmentStatus) Size

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

                                                            func (*VolumeAttachmentStatus) String

                                                            func (this *VolumeAttachmentStatus) String() string

                                                            func (VolumeAttachmentStatus) SwaggerDoc

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

                                                            func (*VolumeAttachmentStatus) Unmarshal

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

                                                            type VolumeBindingMode

                                                            type VolumeBindingMode string

                                                              VolumeBindingMode indicates how PersistentVolumeClaims should be bound.

                                                              const (
                                                              	// VolumeBindingImmediate indicates that PersistentVolumeClaims should be
                                                              	// immediately provisioned and bound.  This is the default mode.
                                                              	VolumeBindingImmediate VolumeBindingMode = "Immediate"
                                                              
                                                              	// VolumeBindingWaitForFirstConsumer indicates that PersistentVolumeClaims
                                                              	// should not be provisioned and bound until the first Pod is created that
                                                              	// references the PeristentVolumeClaim.  The volume provisioning and
                                                              	// binding will occur during Pod scheduing.
                                                              	VolumeBindingWaitForFirstConsumer VolumeBindingMode = "WaitForFirstConsumer"
                                                              )

                                                              type VolumeError

                                                              type VolumeError struct {
                                                              	// Time the error was encountered.
                                                              	// +optional
                                                              	Time metav1.Time `json:"time,omitempty" protobuf:"bytes,1,opt,name=time"`
                                                              
                                                              	// String detailing the error encountered during Attach or Detach operation.
                                                              	// This string may be logged, so it should not contain sensitive
                                                              	// information.
                                                              	// +optional
                                                              	Message string `json:"message,omitempty" protobuf:"bytes,2,opt,name=message"`
                                                              }

                                                                VolumeError captures an error encountered during a volume operation.

                                                                func (*VolumeError) DeepCopy

                                                                func (in *VolumeError) DeepCopy() *VolumeError

                                                                  DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeError.

                                                                  func (*VolumeError) DeepCopyInto

                                                                  func (in *VolumeError) DeepCopyInto(out *VolumeError)

                                                                    DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                                    func (*VolumeError) Descriptor

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

                                                                    func (*VolumeError) Marshal

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

                                                                    func (*VolumeError) MarshalTo

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

                                                                    func (*VolumeError) ProtoMessage

                                                                    func (*VolumeError) ProtoMessage()

                                                                    func (*VolumeError) Reset

                                                                    func (m *VolumeError) Reset()

                                                                    func (*VolumeError) Size

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

                                                                    func (*VolumeError) String

                                                                    func (this *VolumeError) String() string

                                                                    func (VolumeError) SwaggerDoc

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

                                                                    func (*VolumeError) Unmarshal

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