kubernetes-api-135.0.1: lib/Kubernetes/OpenAPI/API/SchedulingV1alpha1.hs
{-
Kubernetes
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
OpenAPI Version: 3.0.1
Kubernetes API version: release-1.35
Generated by OpenAPI Generator (https://openapi-generator.tech)
-}
{-|
Module : Kubernetes.OpenAPI.API.SchedulingV1alpha1
-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE MonoLocalBinds #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE OverloadedStrings #-}
{-# OPTIONS_GHC -fno-warn-name-shadowing -fno-warn-unused-binds -fno-warn-unused-imports #-}
module Kubernetes.OpenAPI.API.SchedulingV1alpha1 where
import Kubernetes.OpenAPI.Core
import Kubernetes.OpenAPI.MimeTypes
import Kubernetes.OpenAPI.Model as M
import qualified Data.Aeson as A
import qualified Data.ByteString as B
import qualified Data.ByteString.Lazy as BL
import qualified Data.Data as P (Typeable, TypeRep, typeOf, typeRep)
import qualified Data.Foldable as P
import qualified Data.Map as Map
import qualified Data.Maybe as P
import qualified Data.Proxy as P (Proxy(..))
import qualified Data.Set as Set
import qualified Data.String as P
import qualified Data.Text as T
import qualified Data.Text.Encoding as T
import qualified Data.Text.Lazy as TL
import qualified Data.Text.Lazy.Encoding as TL
import qualified Data.Time as TI
import qualified Network.HTTP.Client.MultipartFormData as NH
import qualified Network.HTTP.Media as ME
import qualified Network.HTTP.Types as NH
import qualified Web.FormUrlEncoded as WH
import qualified Web.HttpApiData as WH
import Data.Text (Text)
import GHC.Base ((<|>))
import Prelude ((==),(/=),($), (.),(<$>),(<*>),(>>=),Maybe(..),Bool(..),Char,Double,FilePath,Float,Int,Integer,String,fmap,undefined,mempty,maybe,pure,Monad,Applicative,Functor)
import qualified Prelude as P
-- * Operations
-- ** SchedulingV1alpha1
-- *** createNamespacedWorkload
-- | @POST \/apis\/scheduling.k8s.io\/v1alpha1\/namespaces\/{namespace}\/workloads@
--
-- create a Workload
--
-- AuthMethod: 'AuthApiKeyBearerToken'
--
createNamespacedWorkload
:: (Consumes CreateNamespacedWorkload contentType, MimeRender contentType V1alpha1Workload)
=> ContentType contentType -- ^ request content-type ('MimeType')
-> Accept accept -- ^ request accept ('MimeType')
-> V1alpha1Workload -- ^ "body"
-> Namespace -- ^ "namespace" - object name and auth scope, such as for teams and projects
-> KubernetesRequest CreateNamespacedWorkload contentType V1alpha1Workload accept
createNamespacedWorkload _ _ body (Namespace namespace) =
_mkRequest "POST" ["/apis/scheduling.k8s.io/v1alpha1/namespaces/",toPath namespace,"/workloads"]
`_hasAuthType` (P.Proxy :: P.Proxy AuthApiKeyBearerToken)
`setBodyParam` body
data CreateNamespacedWorkload
instance HasBodyParam CreateNamespacedWorkload V1alpha1Workload
-- | /Optional Param/ "pretty" - If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).
instance HasOptionalParam CreateNamespacedWorkload Pretty where
applyOptionalParam req (Pretty xs) =
req `addQuery` toQuery ("pretty", Just xs)
-- | /Optional Param/ "dryRun" - When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
instance HasOptionalParam CreateNamespacedWorkload DryRun where
applyOptionalParam req (DryRun xs) =
req `addQuery` toQuery ("dryRun", Just xs)
-- | /Optional Param/ "fieldManager" - fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
instance HasOptionalParam CreateNamespacedWorkload FieldManager where
applyOptionalParam req (FieldManager xs) =
req `addQuery` toQuery ("fieldManager", Just xs)
-- | /Optional Param/ "fieldValidation" - fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
instance HasOptionalParam CreateNamespacedWorkload FieldValidation where
applyOptionalParam req (FieldValidation xs) =
req `addQuery` toQuery ("fieldValidation", Just xs)
-- | @*/*@
instance MimeType mtype => Consumes CreateNamespacedWorkload mtype
-- | @application/json@
instance Produces CreateNamespacedWorkload MimeJSON
-- | @application/vnd.kubernetes.protobuf@
instance Produces CreateNamespacedWorkload MimeVndKubernetesProtobuf
-- | @application/cbor@
instance Produces CreateNamespacedWorkload MimeCbor
-- | @application/yaml@
instance Produces CreateNamespacedWorkload MimeYaml
-- *** deleteCollectionNamespacedWorkload
-- | @DELETE \/apis\/scheduling.k8s.io\/v1alpha1\/namespaces\/{namespace}\/workloads@
--
-- delete collection of Workload
--
-- AuthMethod: 'AuthApiKeyBearerToken'
--
deleteCollectionNamespacedWorkload
:: (Consumes DeleteCollectionNamespacedWorkload contentType)
=> ContentType contentType -- ^ request content-type ('MimeType')
-> Accept accept -- ^ request accept ('MimeType')
-> Namespace -- ^ "namespace" - object name and auth scope, such as for teams and projects
-> KubernetesRequest DeleteCollectionNamespacedWorkload contentType V1Status accept
deleteCollectionNamespacedWorkload _ _ (Namespace namespace) =
_mkRequest "DELETE" ["/apis/scheduling.k8s.io/v1alpha1/namespaces/",toPath namespace,"/workloads"]
`_hasAuthType` (P.Proxy :: P.Proxy AuthApiKeyBearerToken)
data DeleteCollectionNamespacedWorkload
instance HasBodyParam DeleteCollectionNamespacedWorkload V1DeleteOptions
-- | /Optional Param/ "pretty" - If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).
instance HasOptionalParam DeleteCollectionNamespacedWorkload Pretty where
applyOptionalParam req (Pretty xs) =
req `addQuery` toQuery ("pretty", Just xs)
-- | /Optional Param/ "continue" - The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
instance HasOptionalParam DeleteCollectionNamespacedWorkload Continue where
applyOptionalParam req (Continue xs) =
req `addQuery` toQuery ("continue", Just xs)
-- | /Optional Param/ "dryRun" - When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
instance HasOptionalParam DeleteCollectionNamespacedWorkload DryRun where
applyOptionalParam req (DryRun xs) =
req `addQuery` toQuery ("dryRun", Just xs)
-- | /Optional Param/ "fieldSelector" - A selector to restrict the list of returned objects by their fields. Defaults to everything.
instance HasOptionalParam DeleteCollectionNamespacedWorkload FieldSelector where
applyOptionalParam req (FieldSelector xs) =
req `addQuery` toQuery ("fieldSelector", Just xs)
-- | /Optional Param/ "gracePeriodSeconds" - 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.
instance HasOptionalParam DeleteCollectionNamespacedWorkload GracePeriodSeconds where
applyOptionalParam req (GracePeriodSeconds xs) =
req `addQuery` toQuery ("gracePeriodSeconds", Just xs)
-- | /Optional Param/ "ignoreStoreReadErrorWithClusterBreakingPotential" - if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it
instance HasOptionalParam DeleteCollectionNamespacedWorkload IgnoreStoreReadErrorWithClusterBreakingPotential where
applyOptionalParam req (IgnoreStoreReadErrorWithClusterBreakingPotential xs) =
req `addQuery` toQuery ("ignoreStoreReadErrorWithClusterBreakingPotential", Just xs)
-- | /Optional Param/ "labelSelector" - A selector to restrict the list of returned objects by their labels. Defaults to everything.
instance HasOptionalParam DeleteCollectionNamespacedWorkload LabelSelector where
applyOptionalParam req (LabelSelector xs) =
req `addQuery` toQuery ("labelSelector", Just xs)
-- | /Optional Param/ "limit" - limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
instance HasOptionalParam DeleteCollectionNamespacedWorkload Limit where
applyOptionalParam req (Limit xs) =
req `addQuery` toQuery ("limit", Just xs)
-- | /Optional Param/ "orphanDependents" - 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.
instance HasOptionalParam DeleteCollectionNamespacedWorkload OrphanDependents where
applyOptionalParam req (OrphanDependents xs) =
req `addQuery` toQuery ("orphanDependents", Just xs)
-- | /Optional Param/ "propagationPolicy" - 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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
instance HasOptionalParam DeleteCollectionNamespacedWorkload PropagationPolicy where
applyOptionalParam req (PropagationPolicy xs) =
req `addQuery` toQuery ("propagationPolicy", Just xs)
-- | /Optional Param/ "resourceVersion" - resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
instance HasOptionalParam DeleteCollectionNamespacedWorkload ResourceVersion where
applyOptionalParam req (ResourceVersion xs) =
req `addQuery` toQuery ("resourceVersion", Just xs)
-- | /Optional Param/ "resourceVersionMatch" - resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
instance HasOptionalParam DeleteCollectionNamespacedWorkload ResourceVersionMatch where
applyOptionalParam req (ResourceVersionMatch xs) =
req `addQuery` toQuery ("resourceVersionMatch", Just xs)
-- | /Optional Param/ "sendInitialEvents" - `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise.
instance HasOptionalParam DeleteCollectionNamespacedWorkload SendInitialEvents where
applyOptionalParam req (SendInitialEvents xs) =
req `addQuery` toQuery ("sendInitialEvents", Just xs)
-- | /Optional Param/ "timeoutSeconds" - Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
instance HasOptionalParam DeleteCollectionNamespacedWorkload TimeoutSeconds where
applyOptionalParam req (TimeoutSeconds xs) =
req `addQuery` toQuery ("timeoutSeconds", Just xs)
-- | @*/*@
instance MimeType mtype => Consumes DeleteCollectionNamespacedWorkload mtype
-- | @application/json@
instance Produces DeleteCollectionNamespacedWorkload MimeJSON
-- | @application/vnd.kubernetes.protobuf@
instance Produces DeleteCollectionNamespacedWorkload MimeVndKubernetesProtobuf
-- | @application/cbor@
instance Produces DeleteCollectionNamespacedWorkload MimeCbor
-- | @application/yaml@
instance Produces DeleteCollectionNamespacedWorkload MimeYaml
-- *** deleteNamespacedWorkload
-- | @DELETE \/apis\/scheduling.k8s.io\/v1alpha1\/namespaces\/{namespace}\/workloads\/{name}@
--
-- delete a Workload
--
-- AuthMethod: 'AuthApiKeyBearerToken'
--
deleteNamespacedWorkload
:: (Consumes DeleteNamespacedWorkload contentType)
=> ContentType contentType -- ^ request content-type ('MimeType')
-> Accept accept -- ^ request accept ('MimeType')
-> Name -- ^ "name" - name of the Workload
-> Namespace -- ^ "namespace" - object name and auth scope, such as for teams and projects
-> KubernetesRequest DeleteNamespacedWorkload contentType V1Status accept
deleteNamespacedWorkload _ _ (Name name) (Namespace namespace) =
_mkRequest "DELETE" ["/apis/scheduling.k8s.io/v1alpha1/namespaces/",toPath namespace,"/workloads/",toPath name]
`_hasAuthType` (P.Proxy :: P.Proxy AuthApiKeyBearerToken)
data DeleteNamespacedWorkload
instance HasBodyParam DeleteNamespacedWorkload V1DeleteOptions
-- | /Optional Param/ "pretty" - If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).
instance HasOptionalParam DeleteNamespacedWorkload Pretty where
applyOptionalParam req (Pretty xs) =
req `addQuery` toQuery ("pretty", Just xs)
-- | /Optional Param/ "dryRun" - When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
instance HasOptionalParam DeleteNamespacedWorkload DryRun where
applyOptionalParam req (DryRun xs) =
req `addQuery` toQuery ("dryRun", Just xs)
-- | /Optional Param/ "gracePeriodSeconds" - 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.
instance HasOptionalParam DeleteNamespacedWorkload GracePeriodSeconds where
applyOptionalParam req (GracePeriodSeconds xs) =
req `addQuery` toQuery ("gracePeriodSeconds", Just xs)
-- | /Optional Param/ "ignoreStoreReadErrorWithClusterBreakingPotential" - if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it
instance HasOptionalParam DeleteNamespacedWorkload IgnoreStoreReadErrorWithClusterBreakingPotential where
applyOptionalParam req (IgnoreStoreReadErrorWithClusterBreakingPotential xs) =
req `addQuery` toQuery ("ignoreStoreReadErrorWithClusterBreakingPotential", Just xs)
-- | /Optional Param/ "orphanDependents" - 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.
instance HasOptionalParam DeleteNamespacedWorkload OrphanDependents where
applyOptionalParam req (OrphanDependents xs) =
req `addQuery` toQuery ("orphanDependents", Just xs)
-- | /Optional Param/ "propagationPolicy" - 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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
instance HasOptionalParam DeleteNamespacedWorkload PropagationPolicy where
applyOptionalParam req (PropagationPolicy xs) =
req `addQuery` toQuery ("propagationPolicy", Just xs)
-- | @*/*@
instance MimeType mtype => Consumes DeleteNamespacedWorkload mtype
-- | @application/json@
instance Produces DeleteNamespacedWorkload MimeJSON
-- | @application/vnd.kubernetes.protobuf@
instance Produces DeleteNamespacedWorkload MimeVndKubernetesProtobuf
-- | @application/cbor@
instance Produces DeleteNamespacedWorkload MimeCbor
-- | @application/yaml@
instance Produces DeleteNamespacedWorkload MimeYaml
-- *** getAPIResources
-- | @GET \/apis\/scheduling.k8s.io\/v1alpha1\/@
--
-- get available resources
--
-- AuthMethod: 'AuthApiKeyBearerToken'
--
getAPIResources
:: Accept accept -- ^ request accept ('MimeType')
-> KubernetesRequest GetAPIResources MimeNoContent V1APIResourceList accept
getAPIResources _ =
_mkRequest "GET" ["/apis/scheduling.k8s.io/v1alpha1/"]
`_hasAuthType` (P.Proxy :: P.Proxy AuthApiKeyBearerToken)
data GetAPIResources
-- | @application/json@
instance Produces GetAPIResources MimeJSON
-- | @application/vnd.kubernetes.protobuf@
instance Produces GetAPIResources MimeVndKubernetesProtobuf
-- | @application/cbor@
instance Produces GetAPIResources MimeCbor
-- | @application/yaml@
instance Produces GetAPIResources MimeYaml
-- *** listNamespacedWorkload
-- | @GET \/apis\/scheduling.k8s.io\/v1alpha1\/namespaces\/{namespace}\/workloads@
--
-- list or watch objects of kind Workload
--
-- AuthMethod: 'AuthApiKeyBearerToken'
--
listNamespacedWorkload
:: Accept accept -- ^ request accept ('MimeType')
-> Namespace -- ^ "namespace" - object name and auth scope, such as for teams and projects
-> KubernetesRequest ListNamespacedWorkload MimeNoContent V1alpha1WorkloadList accept
listNamespacedWorkload _ (Namespace namespace) =
_mkRequest "GET" ["/apis/scheduling.k8s.io/v1alpha1/namespaces/",toPath namespace,"/workloads"]
`_hasAuthType` (P.Proxy :: P.Proxy AuthApiKeyBearerToken)
data ListNamespacedWorkload
-- | /Optional Param/ "pretty" - If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).
instance HasOptionalParam ListNamespacedWorkload Pretty where
applyOptionalParam req (Pretty xs) =
req `addQuery` toQuery ("pretty", Just xs)
-- | /Optional Param/ "allowWatchBookmarks" - allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.
instance HasOptionalParam ListNamespacedWorkload AllowWatchBookmarks where
applyOptionalParam req (AllowWatchBookmarks xs) =
req `addQuery` toQuery ("allowWatchBookmarks", Just xs)
-- | /Optional Param/ "continue" - The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
instance HasOptionalParam ListNamespacedWorkload Continue where
applyOptionalParam req (Continue xs) =
req `addQuery` toQuery ("continue", Just xs)
-- | /Optional Param/ "fieldSelector" - A selector to restrict the list of returned objects by their fields. Defaults to everything.
instance HasOptionalParam ListNamespacedWorkload FieldSelector where
applyOptionalParam req (FieldSelector xs) =
req `addQuery` toQuery ("fieldSelector", Just xs)
-- | /Optional Param/ "labelSelector" - A selector to restrict the list of returned objects by their labels. Defaults to everything.
instance HasOptionalParam ListNamespacedWorkload LabelSelector where
applyOptionalParam req (LabelSelector xs) =
req `addQuery` toQuery ("labelSelector", Just xs)
-- | /Optional Param/ "limit" - limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
instance HasOptionalParam ListNamespacedWorkload Limit where
applyOptionalParam req (Limit xs) =
req `addQuery` toQuery ("limit", Just xs)
-- | /Optional Param/ "resourceVersion" - resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
instance HasOptionalParam ListNamespacedWorkload ResourceVersion where
applyOptionalParam req (ResourceVersion xs) =
req `addQuery` toQuery ("resourceVersion", Just xs)
-- | /Optional Param/ "resourceVersionMatch" - resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
instance HasOptionalParam ListNamespacedWorkload ResourceVersionMatch where
applyOptionalParam req (ResourceVersionMatch xs) =
req `addQuery` toQuery ("resourceVersionMatch", Just xs)
-- | /Optional Param/ "sendInitialEvents" - `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise.
instance HasOptionalParam ListNamespacedWorkload SendInitialEvents where
applyOptionalParam req (SendInitialEvents xs) =
req `addQuery` toQuery ("sendInitialEvents", Just xs)
-- | /Optional Param/ "timeoutSeconds" - Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
instance HasOptionalParam ListNamespacedWorkload TimeoutSeconds where
applyOptionalParam req (TimeoutSeconds xs) =
req `addQuery` toQuery ("timeoutSeconds", Just xs)
-- | /Optional Param/ "watch" - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
instance HasOptionalParam ListNamespacedWorkload Watch where
applyOptionalParam req (Watch xs) =
req `addQuery` toQuery ("watch", Just xs)
-- | @application/cbor-seq@
instance Produces ListNamespacedWorkload MimeCborSeq
-- | @application/json@
instance Produces ListNamespacedWorkload MimeJSON
-- | @application/json;stream=watch@
instance Produces ListNamespacedWorkload MimeJsonstreamwatch
-- | @application/vnd.kubernetes.protobuf@
instance Produces ListNamespacedWorkload MimeVndKubernetesProtobuf
-- | @application/vnd.kubernetes.protobuf;stream=watch@
instance Produces ListNamespacedWorkload MimeVndKubernetesProtobufstreamwatch
-- | @application/cbor@
instance Produces ListNamespacedWorkload MimeCbor
-- | @application/yaml@
instance Produces ListNamespacedWorkload MimeYaml
-- *** listWorkloadForAllNamespaces
-- | @GET \/apis\/scheduling.k8s.io\/v1alpha1\/workloads@
--
-- list or watch objects of kind Workload
--
-- AuthMethod: 'AuthApiKeyBearerToken'
--
listWorkloadForAllNamespaces
:: Accept accept -- ^ request accept ('MimeType')
-> KubernetesRequest ListWorkloadForAllNamespaces MimeNoContent V1alpha1WorkloadList accept
listWorkloadForAllNamespaces _ =
_mkRequest "GET" ["/apis/scheduling.k8s.io/v1alpha1/workloads"]
`_hasAuthType` (P.Proxy :: P.Proxy AuthApiKeyBearerToken)
data ListWorkloadForAllNamespaces
-- | /Optional Param/ "allowWatchBookmarks" - allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.
instance HasOptionalParam ListWorkloadForAllNamespaces AllowWatchBookmarks where
applyOptionalParam req (AllowWatchBookmarks xs) =
req `addQuery` toQuery ("allowWatchBookmarks", Just xs)
-- | /Optional Param/ "continue" - The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
instance HasOptionalParam ListWorkloadForAllNamespaces Continue where
applyOptionalParam req (Continue xs) =
req `addQuery` toQuery ("continue", Just xs)
-- | /Optional Param/ "fieldSelector" - A selector to restrict the list of returned objects by their fields. Defaults to everything.
instance HasOptionalParam ListWorkloadForAllNamespaces FieldSelector where
applyOptionalParam req (FieldSelector xs) =
req `addQuery` toQuery ("fieldSelector", Just xs)
-- | /Optional Param/ "labelSelector" - A selector to restrict the list of returned objects by their labels. Defaults to everything.
instance HasOptionalParam ListWorkloadForAllNamespaces LabelSelector where
applyOptionalParam req (LabelSelector xs) =
req `addQuery` toQuery ("labelSelector", Just xs)
-- | /Optional Param/ "limit" - limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
instance HasOptionalParam ListWorkloadForAllNamespaces Limit where
applyOptionalParam req (Limit xs) =
req `addQuery` toQuery ("limit", Just xs)
-- | /Optional Param/ "pretty" - If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).
instance HasOptionalParam ListWorkloadForAllNamespaces Pretty where
applyOptionalParam req (Pretty xs) =
req `addQuery` toQuery ("pretty", Just xs)
-- | /Optional Param/ "resourceVersion" - resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
instance HasOptionalParam ListWorkloadForAllNamespaces ResourceVersion where
applyOptionalParam req (ResourceVersion xs) =
req `addQuery` toQuery ("resourceVersion", Just xs)
-- | /Optional Param/ "resourceVersionMatch" - resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
instance HasOptionalParam ListWorkloadForAllNamespaces ResourceVersionMatch where
applyOptionalParam req (ResourceVersionMatch xs) =
req `addQuery` toQuery ("resourceVersionMatch", Just xs)
-- | /Optional Param/ "sendInitialEvents" - `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise.
instance HasOptionalParam ListWorkloadForAllNamespaces SendInitialEvents where
applyOptionalParam req (SendInitialEvents xs) =
req `addQuery` toQuery ("sendInitialEvents", Just xs)
-- | /Optional Param/ "timeoutSeconds" - Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
instance HasOptionalParam ListWorkloadForAllNamespaces TimeoutSeconds where
applyOptionalParam req (TimeoutSeconds xs) =
req `addQuery` toQuery ("timeoutSeconds", Just xs)
-- | /Optional Param/ "watch" - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
instance HasOptionalParam ListWorkloadForAllNamespaces Watch where
applyOptionalParam req (Watch xs) =
req `addQuery` toQuery ("watch", Just xs)
-- | @application/cbor-seq@
instance Produces ListWorkloadForAllNamespaces MimeCborSeq
-- | @application/json@
instance Produces ListWorkloadForAllNamespaces MimeJSON
-- | @application/json;stream=watch@
instance Produces ListWorkloadForAllNamespaces MimeJsonstreamwatch
-- | @application/vnd.kubernetes.protobuf@
instance Produces ListWorkloadForAllNamespaces MimeVndKubernetesProtobuf
-- | @application/vnd.kubernetes.protobuf;stream=watch@
instance Produces ListWorkloadForAllNamespaces MimeVndKubernetesProtobufstreamwatch
-- | @application/cbor@
instance Produces ListWorkloadForAllNamespaces MimeCbor
-- | @application/yaml@
instance Produces ListWorkloadForAllNamespaces MimeYaml
-- *** patchNamespacedWorkload
-- | @PATCH \/apis\/scheduling.k8s.io\/v1alpha1\/namespaces\/{namespace}\/workloads\/{name}@
--
-- partially update the specified Workload
--
-- AuthMethod: 'AuthApiKeyBearerToken'
--
patchNamespacedWorkload
:: (Consumes PatchNamespacedWorkload contentType, MimeRender contentType Body)
=> ContentType contentType -- ^ request content-type ('MimeType')
-> Accept accept -- ^ request accept ('MimeType')
-> Body -- ^ "body"
-> Name -- ^ "name" - name of the Workload
-> Namespace -- ^ "namespace" - object name and auth scope, such as for teams and projects
-> KubernetesRequest PatchNamespacedWorkload contentType V1alpha1Workload accept
patchNamespacedWorkload _ _ body (Name name) (Namespace namespace) =
_mkRequest "PATCH" ["/apis/scheduling.k8s.io/v1alpha1/namespaces/",toPath namespace,"/workloads/",toPath name]
`_hasAuthType` (P.Proxy :: P.Proxy AuthApiKeyBearerToken)
`setBodyParam` body
data PatchNamespacedWorkload
instance HasBodyParam PatchNamespacedWorkload Body
-- | /Optional Param/ "pretty" - If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).
instance HasOptionalParam PatchNamespacedWorkload Pretty where
applyOptionalParam req (Pretty xs) =
req `addQuery` toQuery ("pretty", Just xs)
-- | /Optional Param/ "dryRun" - When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
instance HasOptionalParam PatchNamespacedWorkload DryRun where
applyOptionalParam req (DryRun xs) =
req `addQuery` toQuery ("dryRun", Just xs)
-- | /Optional Param/ "fieldManager" - fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
instance HasOptionalParam PatchNamespacedWorkload FieldManager where
applyOptionalParam req (FieldManager xs) =
req `addQuery` toQuery ("fieldManager", Just xs)
-- | /Optional Param/ "fieldValidation" - fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
instance HasOptionalParam PatchNamespacedWorkload FieldValidation where
applyOptionalParam req (FieldValidation xs) =
req `addQuery` toQuery ("fieldValidation", Just xs)
-- | /Optional Param/ "force" - Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.
instance HasOptionalParam PatchNamespacedWorkload Force where
applyOptionalParam req (Force xs) =
req `addQuery` toQuery ("force", Just xs)
-- | @application/apply-patch+yaml@
instance Consumes PatchNamespacedWorkload MimeApplyPatchyaml
-- | @application/json-patch+json@
instance Consumes PatchNamespacedWorkload MimeJsonPatchjson
-- | @application/merge-patch+json@
instance Consumes PatchNamespacedWorkload MimeMergePatchjson
-- | @application/strategic-merge-patch+json@
instance Consumes PatchNamespacedWorkload MimeStrategicMergePatchjson
-- | @application/apply-patch+cbor@
instance Consumes PatchNamespacedWorkload MimeApplyPatchcbor
-- | @application/json@
instance Produces PatchNamespacedWorkload MimeJSON
-- | @application/vnd.kubernetes.protobuf@
instance Produces PatchNamespacedWorkload MimeVndKubernetesProtobuf
-- | @application/cbor@
instance Produces PatchNamespacedWorkload MimeCbor
-- | @application/yaml@
instance Produces PatchNamespacedWorkload MimeYaml
-- *** readNamespacedWorkload
-- | @GET \/apis\/scheduling.k8s.io\/v1alpha1\/namespaces\/{namespace}\/workloads\/{name}@
--
-- read the specified Workload
--
-- AuthMethod: 'AuthApiKeyBearerToken'
--
readNamespacedWorkload
:: Accept accept -- ^ request accept ('MimeType')
-> Name -- ^ "name" - name of the Workload
-> Namespace -- ^ "namespace" - object name and auth scope, such as for teams and projects
-> KubernetesRequest ReadNamespacedWorkload MimeNoContent V1alpha1Workload accept
readNamespacedWorkload _ (Name name) (Namespace namespace) =
_mkRequest "GET" ["/apis/scheduling.k8s.io/v1alpha1/namespaces/",toPath namespace,"/workloads/",toPath name]
`_hasAuthType` (P.Proxy :: P.Proxy AuthApiKeyBearerToken)
data ReadNamespacedWorkload
-- | /Optional Param/ "pretty" - If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).
instance HasOptionalParam ReadNamespacedWorkload Pretty where
applyOptionalParam req (Pretty xs) =
req `addQuery` toQuery ("pretty", Just xs)
-- | @application/json@
instance Produces ReadNamespacedWorkload MimeJSON
-- | @application/vnd.kubernetes.protobuf@
instance Produces ReadNamespacedWorkload MimeVndKubernetesProtobuf
-- | @application/cbor@
instance Produces ReadNamespacedWorkload MimeCbor
-- | @application/yaml@
instance Produces ReadNamespacedWorkload MimeYaml
-- *** replaceNamespacedWorkload
-- | @PUT \/apis\/scheduling.k8s.io\/v1alpha1\/namespaces\/{namespace}\/workloads\/{name}@
--
-- replace the specified Workload
--
-- AuthMethod: 'AuthApiKeyBearerToken'
--
replaceNamespacedWorkload
:: (Consumes ReplaceNamespacedWorkload contentType, MimeRender contentType V1alpha1Workload)
=> ContentType contentType -- ^ request content-type ('MimeType')
-> Accept accept -- ^ request accept ('MimeType')
-> V1alpha1Workload -- ^ "body"
-> Name -- ^ "name" - name of the Workload
-> Namespace -- ^ "namespace" - object name and auth scope, such as for teams and projects
-> KubernetesRequest ReplaceNamespacedWorkload contentType V1alpha1Workload accept
replaceNamespacedWorkload _ _ body (Name name) (Namespace namespace) =
_mkRequest "PUT" ["/apis/scheduling.k8s.io/v1alpha1/namespaces/",toPath namespace,"/workloads/",toPath name]
`_hasAuthType` (P.Proxy :: P.Proxy AuthApiKeyBearerToken)
`setBodyParam` body
data ReplaceNamespacedWorkload
instance HasBodyParam ReplaceNamespacedWorkload V1alpha1Workload
-- | /Optional Param/ "pretty" - If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).
instance HasOptionalParam ReplaceNamespacedWorkload Pretty where
applyOptionalParam req (Pretty xs) =
req `addQuery` toQuery ("pretty", Just xs)
-- | /Optional Param/ "dryRun" - When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
instance HasOptionalParam ReplaceNamespacedWorkload DryRun where
applyOptionalParam req (DryRun xs) =
req `addQuery` toQuery ("dryRun", Just xs)
-- | /Optional Param/ "fieldManager" - fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
instance HasOptionalParam ReplaceNamespacedWorkload FieldManager where
applyOptionalParam req (FieldManager xs) =
req `addQuery` toQuery ("fieldManager", Just xs)
-- | /Optional Param/ "fieldValidation" - fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
instance HasOptionalParam ReplaceNamespacedWorkload FieldValidation where
applyOptionalParam req (FieldValidation xs) =
req `addQuery` toQuery ("fieldValidation", Just xs)
-- | @*/*@
instance MimeType mtype => Consumes ReplaceNamespacedWorkload mtype
-- | @application/json@
instance Produces ReplaceNamespacedWorkload MimeJSON
-- | @application/vnd.kubernetes.protobuf@
instance Produces ReplaceNamespacedWorkload MimeVndKubernetesProtobuf
-- | @application/cbor@
instance Produces ReplaceNamespacedWorkload MimeCbor
-- | @application/yaml@
instance Produces ReplaceNamespacedWorkload MimeYaml