kubernetes.client.SettingsV1alpha1Api

All URIs are relative to https://localhost

Method	HTTP request	Description
create_namespaced_pod_preset	POST /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets
delete_collection_namespaced_pod_preset	DELETE /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets
delete_namespaced_pod_preset	DELETE /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}
get_api_resources	GET /apis/settings.k8s.io/v1alpha1/
list_namespaced_pod_preset	GET /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets
list_pod_preset_for_all_namespaces	GET /apis/settings.k8s.io/v1alpha1/podpresets
patch_namespaced_pod_preset	PATCH /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}
read_namespaced_pod_preset	GET /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}
replace_namespaced_pod_preset	PUT /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}

create_namespaced_pod_preset

V1alpha1PodPreset create_namespaced_pod_preset(namespace, body, pretty=pretty)

create a PodPreset

Example

from __future__ import print_statement
import time
import kubernetes.client
from kubernetes.client.rest import ApiException
from pprint import pprint

# Configure API key authorization: BearerToken
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'

# create an instance of the API class
api_instance = kubernetes.client.SettingsV1alpha1Api()
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes.client.V1alpha1PodPreset() # V1alpha1PodPreset | 
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)

try: 
    api_response = api_instance.create_namespaced_pod_preset(namespace, body, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SettingsV1alpha1Api->create_namespaced_pod_preset: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str	object name and auth scope, such as for teams and projects
body	V1alpha1PodPreset
pretty	str	If 'true', then the output is pretty printed.	[optional]

Return type

V1alpha1PodPreset

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_collection_namespaced_pod_preset

V1Status delete_collection_namespaced_pod_preset(namespace, pretty=pretty, field_selector=field_selector, label_selector=label_selector, resource_version=resource_version, timeout_seconds=timeout_seconds, watch=watch)

delete collection of PodPreset

Example

from __future__ import print_statement
import time
import kubernetes.client
from kubernetes.client.rest import ApiException
from pprint import pprint

# Configure API key authorization: BearerToken
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'

# create an instance of the API class
api_instance = kubernetes.client.SettingsV1alpha1Api()
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. (optional)
watch = true # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)

try: 
    api_response = api_instance.delete_collection_namespaced_pod_preset(namespace, pretty=pretty, field_selector=field_selector, label_selector=label_selector, resource_version=resource_version, timeout_seconds=timeout_seconds, watch=watch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SettingsV1alpha1Api->delete_collection_namespaced_pod_preset: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str	object name and auth scope, such as for teams and projects
pretty	str	If 'true', then the output is pretty printed.	[optional]
field_selector	str	A selector to restrict the list of returned objects by their fields. Defaults to everything.	[optional]
label_selector	str	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
resource_version	str	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.	[optional]
timeout_seconds	int	Timeout for the list/watch call.	[optional]
watch	bool	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	[optional]

Return type

V1Status

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_namespaced_pod_preset

V1Status delete_namespaced_pod_preset(name, namespace, body, pretty=pretty, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy)

delete a PodPreset

Example

from __future__ import print_statement
import time
import kubernetes.client
from kubernetes.client.rest import ApiException
from pprint import pprint

# Configure API key authorization: BearerToken
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'

# create an instance of the API class
api_instance = kubernetes.client.SettingsV1alpha1Api()
name = 'name_example' # str | name of the PodPreset
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | 
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
orphan_dependents = true # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional)

try: 
    api_response = api_instance.delete_namespaced_pod_preset(name, namespace, body, pretty=pretty, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SettingsV1alpha1Api->delete_namespaced_pod_preset: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	name of the PodPreset
namespace	str	object name and auth scope, such as for teams and projects
body	V1DeleteOptions
pretty	str	If 'true', then the output is pretty printed.	[optional]
grace_period_seconds	int	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.	[optional]
orphan_dependents	bool	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.	[optional]
propagation_policy	str	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.	[optional]

Return type

V1Status

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_api_resources

V1APIResourceList get_api_resources()

get available resources

Example

from __future__ import print_statement
import time
import kubernetes.client
from kubernetes.client.rest import ApiException
from pprint import pprint

# Configure API key authorization: BearerToken
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'

# create an instance of the API class
api_instance = kubernetes.client.SettingsV1alpha1Api()

try: 
    api_response = api_instance.get_api_resources()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SettingsV1alpha1Api->get_api_resources: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

V1APIResourceList

Authorization

BearerToken

HTTP request headers

Content-Type: application/json, application/yaml, application/vnd.kubernetes.protobuf
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_namespaced_pod_preset

V1alpha1PodPresetList list_namespaced_pod_preset(namespace, pretty=pretty, field_selector=field_selector, label_selector=label_selector, resource_version=resource_version, timeout_seconds=timeout_seconds, watch=watch)

list or watch objects of kind PodPreset

Example

from __future__ import print_statement
import time
import kubernetes.client
from kubernetes.client.rest import ApiException
from pprint import pprint

# Configure API key authorization: BearerToken
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'

# create an instance of the API class
api_instance = kubernetes.client.SettingsV1alpha1Api()
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. (optional)
watch = true # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)

try: 
    api_response = api_instance.list_namespaced_pod_preset(namespace, pretty=pretty, field_selector=field_selector, label_selector=label_selector, resource_version=resource_version, timeout_seconds=timeout_seconds, watch=watch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SettingsV1alpha1Api->list_namespaced_pod_preset: %s\n" % e)

Parameters

Name	Type	Description	Notes
namespace	str	object name and auth scope, such as for teams and projects
pretty	str	If 'true', then the output is pretty printed.	[optional]
field_selector	str	A selector to restrict the list of returned objects by their fields. Defaults to everything.	[optional]
label_selector	str	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
resource_version	str	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.	[optional]
timeout_seconds	int	Timeout for the list/watch call.	[optional]
watch	bool	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	[optional]

Return type

V1alpha1PodPresetList

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_pod_preset_for_all_namespaces

V1alpha1PodPresetList list_pod_preset_for_all_namespaces(field_selector=field_selector, label_selector=label_selector, pretty=pretty, resource_version=resource_version, timeout_seconds=timeout_seconds, watch=watch)

list or watch objects of kind PodPreset

Example

from __future__ import print_statement
import time
import kubernetes.client
from kubernetes.client.rest import ApiException
from pprint import pprint

# Configure API key authorization: BearerToken
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'

# create an instance of the API class
api_instance = kubernetes.client.SettingsV1alpha1Api()
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. (optional)
watch = true # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)

try: 
    api_response = api_instance.list_pod_preset_for_all_namespaces(field_selector=field_selector, label_selector=label_selector, pretty=pretty, resource_version=resource_version, timeout_seconds=timeout_seconds, watch=watch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SettingsV1alpha1Api->list_pod_preset_for_all_namespaces: %s\n" % e)

Parameters

Name	Type	Description	Notes
field_selector	str	A selector to restrict the list of returned objects by their fields. Defaults to everything.	[optional]
label_selector	str	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
pretty	str	If 'true', then the output is pretty printed.	[optional]
resource_version	str	When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.	[optional]
timeout_seconds	int	Timeout for the list/watch call.	[optional]
watch	bool	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	[optional]

Return type

V1alpha1PodPresetList

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patch_namespaced_pod_preset

V1alpha1PodPreset patch_namespaced_pod_preset(name, namespace, body, pretty=pretty)

partially update the specified PodPreset

Example

from __future__ import print_statement
import time
import kubernetes.client
from kubernetes.client.rest import ApiException
from pprint import pprint

# Configure API key authorization: BearerToken
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'

# create an instance of the API class
api_instance = kubernetes.client.SettingsV1alpha1Api()
name = 'name_example' # str | name of the PodPreset
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes.client.V1Patch() # V1Patch | 
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)

try: 
    api_response = api_instance.patch_namespaced_pod_preset(name, namespace, body, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SettingsV1alpha1Api->patch_namespaced_pod_preset: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	name of the PodPreset
namespace	str	object name and auth scope, such as for teams and projects
body	V1Patch
pretty	str	If 'true', then the output is pretty printed.	[optional]

Return type

V1alpha1PodPreset

Authorization

BearerToken

HTTP request headers

Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read_namespaced_pod_preset

V1alpha1PodPreset read_namespaced_pod_preset(name, namespace, pretty=pretty, exact=exact, export=export)

read the specified PodPreset

Example

from __future__ import print_statement
import time
import kubernetes.client
from kubernetes.client.rest import ApiException
from pprint import pprint

# Configure API key authorization: BearerToken
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'

# create an instance of the API class
api_instance = kubernetes.client.SettingsV1alpha1Api()
name = 'name_example' # str | name of the PodPreset
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
exact = true # bool | Should the export be exact.  Exact export maintains cluster-specific fields like 'Namespace'. (optional)
export = true # bool | Should this value be exported.  Export strips fields that a user can not specify. (optional)

try: 
    api_response = api_instance.read_namespaced_pod_preset(name, namespace, pretty=pretty, exact=exact, export=export)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SettingsV1alpha1Api->read_namespaced_pod_preset: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	name of the PodPreset
namespace	str	object name and auth scope, such as for teams and projects
pretty	str	If 'true', then the output is pretty printed.	[optional]
exact	bool	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.	[optional]
export	bool	Should this value be exported. Export strips fields that a user can not specify.	[optional]

Return type

V1alpha1PodPreset

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

replace_namespaced_pod_preset

V1alpha1PodPreset replace_namespaced_pod_preset(name, namespace, body, pretty=pretty)

replace the specified PodPreset

Example

from __future__ import print_statement
import time
import kubernetes.client
from kubernetes.client.rest import ApiException
from pprint import pprint

# Configure API key authorization: BearerToken
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'

# create an instance of the API class
api_instance = kubernetes.client.SettingsV1alpha1Api()
name = 'name_example' # str | name of the PodPreset
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes.client.V1alpha1PodPreset() # V1alpha1PodPreset | 
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)

try: 
    api_response = api_instance.replace_namespaced_pod_preset(name, namespace, body, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SettingsV1alpha1Api->replace_namespaced_pod_preset: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	name of the PodPreset
namespace	str	object name and auth scope, such as for teams and projects
body	V1alpha1PodPreset
pretty	str	If 'true', then the output is pretty printed.	[optional]

Return type

V1alpha1PodPreset

Authorization

BearerToken

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

SettingsV1alpha1Api.md

Latest commit

History

SettingsV1alpha1Api.md

File metadata and controls

kubernetes.client.SettingsV1alpha1Api

create_namespaced_pod_preset

Example

Parameters

Return type

Authorization

HTTP request headers

delete_collection_namespaced_pod_preset

Example

Parameters

Return type

Authorization

HTTP request headers

delete_namespaced_pod_preset

Example

Parameters

Return type

Authorization

HTTP request headers

get_api_resources

Example

Parameters

Return type

Authorization

HTTP request headers

list_namespaced_pod_preset

Example

Parameters

Return type

Authorization

HTTP request headers

list_pod_preset_for_all_namespaces

Example

Parameters

Return type

Authorization

HTTP request headers

patch_namespaced_pod_preset

Example

Parameters

Return type

Authorization

HTTP request headers

read_namespaced_pod_preset

Example

Parameters

Return type

Authorization

HTTP request headers

replace_namespaced_pod_preset

Example

Parameters

Return type

Authorization

HTTP request headers