Documentation
¶
Overview ¶
+k8s:deepcopy-gen=package +k8s:openapi-gen=true +gencrdrefdocs:force=true
Index ¶
- Variables
- func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
- type FormEntry
- func (in *FormEntry) DeepCopy() *FormEntry
- func (in *FormEntry) DeepCopyInto(out *FormEntry)
- func (*FormEntry) Descriptor() ([]byte, []int)
- func (m *FormEntry) Marshal() (dAtA []byte, err error)
- func (m *FormEntry) MarshalTo(dAtA []byte) (int, error)
- func (m *FormEntry) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*FormEntry) ProtoMessage()
- func (m *FormEntry) Reset()
- func (m *FormEntry) Size() (n int)
- func (this *FormEntry) String() string
- func (m *FormEntry) Unmarshal(dAtA []byte) error
- func (m *FormEntry) XXX_DiscardUnknown()
- func (m *FormEntry) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *FormEntry) XXX_Merge(src proto.Message)
- func (m *FormEntry) XXX_Size() int
- func (m *FormEntry) XXX_Unmarshal(b []byte) error
- type HTTPPostAction
- func (in *HTTPPostAction) DeepCopy() *HTTPPostAction
- func (in *HTTPPostAction) DeepCopyInto(out *HTTPPostAction)
- func (*HTTPPostAction) Descriptor() ([]byte, []int)
- func (m *HTTPPostAction) Marshal() (dAtA []byte, err error)
- func (m *HTTPPostAction) MarshalTo(dAtA []byte) (int, error)
- func (m *HTTPPostAction) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*HTTPPostAction) ProtoMessage()
- func (m *HTTPPostAction) Reset()
- func (m *HTTPPostAction) Size() (n int)
- func (this *HTTPPostAction) String() string
- func (m *HTTPPostAction) Unmarshal(dAtA []byte) error
- func (m *HTTPPostAction) XXX_DiscardUnknown()
- func (m *HTTPPostAction) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *HTTPPostAction) XXX_Merge(src proto.Message)
- func (m *HTTPPostAction) XXX_Size() int
- func (m *HTTPPostAction) XXX_Unmarshal(b []byte) error
- type Handler
- func (in *Handler) DeepCopy() *Handler
- func (in *Handler) DeepCopyInto(out *Handler)
- func (*Handler) Descriptor() ([]byte, []int)
- func (m *Handler) Marshal() (dAtA []byte, err error)
- func (m *Handler) MarshalTo(dAtA []byte) (int, error)
- func (m *Handler) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*Handler) ProtoMessage()
- func (m *Handler) Reset()
- func (m *Handler) Size() (n int)
- func (this *Handler) String() string
- func (m *Handler) Unmarshal(dAtA []byte) error
- func (m *Handler) XXX_DiscardUnknown()
- func (m *Handler) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Handler) XXX_Merge(src proto.Message)
- func (m *Handler) XXX_Size() int
- func (m *Handler) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
Functions ¶
func GetOpenAPIDefinitions ¶
func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
Types ¶
type FormEntry ¶
type FormEntry struct { Key string `json:"key,omitempty" protobuf:"bytes,1,rep,name=key"` Values []string `json:"values,omitempty" protobuf:"bytes,2,rep,name=values"` }
func (*FormEntry) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FormEntry.
func (*FormEntry) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*FormEntry) Descriptor ¶
func (*FormEntry) MarshalToSizedBuffer ¶
func (*FormEntry) ProtoMessage ¶
func (*FormEntry) ProtoMessage()
func (*FormEntry) XXX_DiscardUnknown ¶
func (m *FormEntry) XXX_DiscardUnknown()
func (*FormEntry) XXX_Marshal ¶
func (*FormEntry) XXX_Unmarshal ¶
type HTTPPostAction ¶
type HTTPPostAction struct { // Path to access on the HTTP server. // +optional Path string `json:"path,omitempty" protobuf:"bytes,1,opt,name=path"` // Name or number of the port to access on the container. // Number must be in the range 1 to 65535. // Name must be an IANA_SVC_NAME. Port intstr.IntOrString `json:"port" protobuf:"bytes,2,opt,name=port"` // Host name to connect to, defaults to the pod IP. You probably want to set // "Host" in httpHeaders instead. // +optional Host string `json:"host,omitempty" protobuf:"bytes,3,opt,name=host"` // Scheme to use for connecting to the host. // Defaults to HTTP. // +optional Scheme core.URIScheme `json:"scheme,omitempty" protobuf:"bytes,4,opt,name=scheme,casttype=k8s.io/api/core/v1.URIScheme"` // Custom headers to set in the request. HTTP allows repeated headers. // +optional HTTPHeaders []core.HTTPHeader `json:"httpHeaders,omitempty" protobuf:"bytes,5,rep,name=httpHeaders"` // Body to set in the request. // +optional Body string `json:"body,omitempty" protobuf:"bytes,6,opt,name=body"` // Form to set in the request body. // +optional Form []FormEntry `json:"form,omitempty" protobuf:"bytes,7,rep,name=form"` }
HTTPPostAction describes an action based on HTTP Post requests.
func (*HTTPPostAction) DeepCopy ¶
func (in *HTTPPostAction) DeepCopy() *HTTPPostAction
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPPostAction.
func (*HTTPPostAction) DeepCopyInto ¶
func (in *HTTPPostAction) DeepCopyInto(out *HTTPPostAction)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*HTTPPostAction) Descriptor ¶
func (*HTTPPostAction) Descriptor() ([]byte, []int)
func (*HTTPPostAction) Marshal ¶
func (m *HTTPPostAction) Marshal() (dAtA []byte, err error)
func (*HTTPPostAction) MarshalToSizedBuffer ¶
func (m *HTTPPostAction) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*HTTPPostAction) ProtoMessage ¶
func (*HTTPPostAction) ProtoMessage()
func (*HTTPPostAction) Reset ¶
func (m *HTTPPostAction) Reset()
func (*HTTPPostAction) Size ¶
func (m *HTTPPostAction) Size() (n int)
func (*HTTPPostAction) String ¶
func (this *HTTPPostAction) String() string
func (*HTTPPostAction) Unmarshal ¶
func (m *HTTPPostAction) Unmarshal(dAtA []byte) error
func (*HTTPPostAction) XXX_DiscardUnknown ¶
func (m *HTTPPostAction) XXX_DiscardUnknown()
func (*HTTPPostAction) XXX_Marshal ¶
func (m *HTTPPostAction) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*HTTPPostAction) XXX_Merge ¶
func (m *HTTPPostAction) XXX_Merge(src proto.Message)
func (*HTTPPostAction) XXX_Size ¶
func (m *HTTPPostAction) XXX_Size() int
func (*HTTPPostAction) XXX_Unmarshal ¶
func (m *HTTPPostAction) XXX_Unmarshal(b []byte) error
type Handler ¶
type Handler struct { // One and only one of the following should be specified. // Exec specifies the action to take. // +optional Exec *core.ExecAction `json:"exec,omitempty" protobuf:"bytes,1,opt,name=exec"` // HTTPGet specifies the http Get request to perform. // +optional HTTPGet *core.HTTPGetAction `json:"httpGet,omitempty" protobuf:"bytes,2,opt,name=httpGet"` // HTTPPost specifies the http Post request to perform. // +optional HTTPPost *HTTPPostAction `json:"httpPost,omitempty" protobuf:"bytes,3,opt,name=httpPost"` // TCPSocket specifies an action involving a TCP port. // TCP hooks not yet supported // TODO: implement a realistic TCP lifecycle hook // +optional TCPSocket *core.TCPSocketAction `json:"tcpSocket,omitempty" protobuf:"bytes,4,opt,name=tcpSocket"` // ContainerName specifies the name of the container where to execute the commands for Exec probe // or where to find the port for HTTP or TCP probe // +optional ContainerName string `json:"containerName,omitempty" protobuf:"bytes,5,opt,name=containerName"` }
Handler defines a specific action that should be taken TODO: pass structured data to these actions, and document that data here.
func (*Handler) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Handler.
func (*Handler) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Handler) Descriptor ¶
func (*Handler) MarshalToSizedBuffer ¶
func (*Handler) ProtoMessage ¶
func (*Handler) ProtoMessage()
func (*Handler) XXX_DiscardUnknown ¶
func (m *Handler) XXX_DiscardUnknown()