kubernetes.client.api.core_v1_api module¶
Kubernetes
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
The version of the OpenAPI document: release-1.36 Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
- class kubernetes.client.api.core_v1_api.CoreV1Api(api_client=None)¶
Bases:
objectNOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
- close() None¶
- connect_delete_namespaced_pod_proxy()¶
connect DELETE requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_delete_namespaced_pod_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to pod.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_delete_namespaced_pod_proxy
connect DELETE requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_delete_namespaced_pod_proxy_with_path()¶
connect DELETE requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_delete_namespaced_pod_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to pod.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_delete_namespaced_pod_proxy_with_path
connect DELETE requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_delete_namespaced_service_proxy()¶
connect DELETE requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_delete_namespaced_service_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_delete_namespaced_service_proxy
connect DELETE requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_delete_namespaced_service_proxy_with_path()¶
connect DELETE requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_delete_namespaced_service_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_delete_namespaced_service_proxy_with_path
connect DELETE requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_delete_node_proxy()¶
connect DELETE requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_delete_node_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the NodeProxyOptions')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to node.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_delete_node_proxy
connect DELETE requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_delete_node_proxy_with_path()¶
connect DELETE requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_delete_node_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the NodeProxyOptions')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to node.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_delete_node_proxy_with_path
connect DELETE requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_namespaced_pod_attach()¶
connect GET requests to attach of Pod
- Parameters:
name (str) – name of the PodAttachOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
container (str) – The container in which to execute the command. Defaults to only container if there is only one container in the pod.
stderr (bool) – Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.
stdin (bool) – Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.
stdout (bool) – Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.
tty (bool) – TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_namespaced_pod_attach_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodAttachOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], container: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The container in which to execute the command. Defaults to only container if there is only one container in the pod.')] = None, stderr: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.')] = None, stdin: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.')] = None, stdout: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.')] = None, tty: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_get_namespaced_pod_attach
connect GET requests to attach of Pod
- Parameters:
name (str) – name of the PodAttachOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
container (str) – The container in which to execute the command. Defaults to only container if there is only one container in the pod.
stderr (bool) – Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.
stdin (bool) – Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.
stdout (bool) – Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.
tty (bool) – TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_namespaced_pod_exec()¶
connect GET requests to exec of Pod
- Parameters:
name (str) – name of the PodExecOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
command (List[str]) – Command is the remote command to execute. argv array. Not executed within a shell.
container (str) – Container in which to execute the command. Defaults to only container if there is only one container in the pod.
stderr (bool) – Redirect the standard error stream of the pod for this call.
stdin (bool) – Redirect the standard input stream of the pod for this call. Defaults to false.
stdout (bool) – Redirect the standard output stream of the pod for this call.
tty (bool) – TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_namespaced_pod_exec_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodExecOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], command: Annotated[List[Annotated[str, Strict(strict=True)]] | None, FieldInfo(annotation=NoneType, required=True, description='Command is the remote command to execute. argv array. Not executed within a shell.')] = None, container: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Container in which to execute the command. Defaults to only container if there is only one container in the pod.')] = None, stderr: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Redirect the standard error stream of the pod for this call.')] = None, stdin: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Redirect the standard input stream of the pod for this call. Defaults to false.')] = None, stdout: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Redirect the standard output stream of the pod for this call.')] = None, tty: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_get_namespaced_pod_exec
connect GET requests to exec of Pod
- Parameters:
name (str) – name of the PodExecOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
command (List[str]) – Command is the remote command to execute. argv array. Not executed within a shell.
container (str) – Container in which to execute the command. Defaults to only container if there is only one container in the pod.
stderr (bool) – Redirect the standard error stream of the pod for this call.
stdin (bool) – Redirect the standard input stream of the pod for this call. Defaults to false.
stdout (bool) – Redirect the standard output stream of the pod for this call.
tty (bool) – TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_namespaced_pod_portforward()¶
connect GET requests to portforward of Pod
- Parameters:
name (str) – name of the PodPortForwardOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
ports (str) – List of ports to forward Required when using WebSockets
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_namespaced_pod_portforward_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodPortForwardOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], ports: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='List of ports to forward Required when using WebSockets')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_get_namespaced_pod_portforward
connect GET requests to portforward of Pod
- Parameters:
name (str) – name of the PodPortForwardOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
ports (str) – List of ports to forward Required when using WebSockets
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_namespaced_pod_proxy()¶
connect GET requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_namespaced_pod_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to pod.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_get_namespaced_pod_proxy
connect GET requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_namespaced_pod_proxy_with_path()¶
connect GET requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_namespaced_pod_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to pod.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_get_namespaced_pod_proxy_with_path
connect GET requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_namespaced_service_proxy()¶
connect GET requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_namespaced_service_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_get_namespaced_service_proxy
connect GET requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_namespaced_service_proxy_with_path()¶
connect GET requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_namespaced_service_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_get_namespaced_service_proxy_with_path
connect GET requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_node_proxy()¶
connect GET requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_node_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the NodeProxyOptions')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to node.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_get_node_proxy
connect GET requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_node_proxy_with_path()¶
connect GET requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_get_node_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the NodeProxyOptions')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to node.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_get_node_proxy_with_path
connect GET requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_head_namespaced_pod_proxy()¶
connect HEAD requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_head_namespaced_pod_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to pod.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_head_namespaced_pod_proxy
connect HEAD requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_head_namespaced_pod_proxy_with_path()¶
connect HEAD requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_head_namespaced_pod_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to pod.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_head_namespaced_pod_proxy_with_path
connect HEAD requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_head_namespaced_service_proxy()¶
connect HEAD requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_head_namespaced_service_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_head_namespaced_service_proxy
connect HEAD requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_head_namespaced_service_proxy_with_path()¶
connect HEAD requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_head_namespaced_service_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_head_namespaced_service_proxy_with_path
connect HEAD requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_head_node_proxy()¶
connect HEAD requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_head_node_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the NodeProxyOptions')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to node.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_head_node_proxy
connect HEAD requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_head_node_proxy_with_path()¶
connect HEAD requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_head_node_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the NodeProxyOptions')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to node.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_head_node_proxy_with_path
connect HEAD requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_options_namespaced_pod_proxy()¶
connect OPTIONS requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_options_namespaced_pod_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to pod.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_options_namespaced_pod_proxy
connect OPTIONS requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_options_namespaced_pod_proxy_with_path()¶
connect OPTIONS requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_options_namespaced_pod_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to pod.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_options_namespaced_pod_proxy_with_path
connect OPTIONS requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_options_namespaced_service_proxy()¶
connect OPTIONS requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_options_namespaced_service_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_options_namespaced_service_proxy
connect OPTIONS requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_options_namespaced_service_proxy_with_path()¶
connect OPTIONS requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_options_namespaced_service_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_options_namespaced_service_proxy_with_path
connect OPTIONS requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_options_node_proxy()¶
connect OPTIONS requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_options_node_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the NodeProxyOptions')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to node.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_options_node_proxy
connect OPTIONS requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_options_node_proxy_with_path()¶
connect OPTIONS requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_options_node_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the NodeProxyOptions')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to node.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_options_node_proxy_with_path
connect OPTIONS requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_patch_namespaced_pod_proxy()¶
connect PATCH requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_patch_namespaced_pod_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to pod.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_patch_namespaced_pod_proxy
connect PATCH requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_patch_namespaced_pod_proxy_with_path()¶
connect PATCH requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_patch_namespaced_pod_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to pod.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_patch_namespaced_pod_proxy_with_path
connect PATCH requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_patch_namespaced_service_proxy()¶
connect PATCH requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_patch_namespaced_service_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_patch_namespaced_service_proxy
connect PATCH requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_patch_namespaced_service_proxy_with_path()¶
connect PATCH requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_patch_namespaced_service_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_patch_namespaced_service_proxy_with_path
connect PATCH requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_patch_node_proxy()¶
connect PATCH requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_patch_node_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the NodeProxyOptions')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to node.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_patch_node_proxy
connect PATCH requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_patch_node_proxy_with_path()¶
connect PATCH requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_patch_node_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the NodeProxyOptions')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to node.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_patch_node_proxy_with_path
connect PATCH requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_namespaced_pod_attach()¶
connect POST requests to attach of Pod
- Parameters:
name (str) – name of the PodAttachOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
container (str) – The container in which to execute the command. Defaults to only container if there is only one container in the pod.
stderr (bool) – Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.
stdin (bool) – Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.
stdout (bool) – Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.
tty (bool) – TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_namespaced_pod_attach_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodAttachOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], container: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The container in which to execute the command. Defaults to only container if there is only one container in the pod.')] = None, stderr: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.')] = None, stdin: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.')] = None, stdout: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.')] = None, tty: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_post_namespaced_pod_attach
connect POST requests to attach of Pod
- Parameters:
name (str) – name of the PodAttachOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
container (str) – The container in which to execute the command. Defaults to only container if there is only one container in the pod.
stderr (bool) – Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.
stdin (bool) – Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.
stdout (bool) – Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.
tty (bool) – TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_namespaced_pod_exec()¶
connect POST requests to exec of Pod
- Parameters:
name (str) – name of the PodExecOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
command (List[str]) – Command is the remote command to execute. argv array. Not executed within a shell.
container (str) – Container in which to execute the command. Defaults to only container if there is only one container in the pod.
stderr (bool) – Redirect the standard error stream of the pod for this call.
stdin (bool) – Redirect the standard input stream of the pod for this call. Defaults to false.
stdout (bool) – Redirect the standard output stream of the pod for this call.
tty (bool) – TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_namespaced_pod_exec_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodExecOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], command: Annotated[List[Annotated[str, Strict(strict=True)]] | None, FieldInfo(annotation=NoneType, required=True, description='Command is the remote command to execute. argv array. Not executed within a shell.')] = None, container: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Container in which to execute the command. Defaults to only container if there is only one container in the pod.')] = None, stderr: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Redirect the standard error stream of the pod for this call.')] = None, stdin: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Redirect the standard input stream of the pod for this call. Defaults to false.')] = None, stdout: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Redirect the standard output stream of the pod for this call.')] = None, tty: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_post_namespaced_pod_exec
connect POST requests to exec of Pod
- Parameters:
name (str) – name of the PodExecOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
command (List[str]) – Command is the remote command to execute. argv array. Not executed within a shell.
container (str) – Container in which to execute the command. Defaults to only container if there is only one container in the pod.
stderr (bool) – Redirect the standard error stream of the pod for this call.
stdin (bool) – Redirect the standard input stream of the pod for this call. Defaults to false.
stdout (bool) – Redirect the standard output stream of the pod for this call.
tty (bool) – TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_namespaced_pod_portforward()¶
connect POST requests to portforward of Pod
- Parameters:
name (str) – name of the PodPortForwardOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
ports (str) – List of ports to forward Required when using WebSockets
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_namespaced_pod_portforward_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodPortForwardOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], ports: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='List of ports to forward Required when using WebSockets')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_post_namespaced_pod_portforward
connect POST requests to portforward of Pod
- Parameters:
name (str) – name of the PodPortForwardOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
ports (str) – List of ports to forward Required when using WebSockets
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_namespaced_pod_proxy()¶
connect POST requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_namespaced_pod_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to pod.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_post_namespaced_pod_proxy
connect POST requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_namespaced_pod_proxy_with_path()¶
connect POST requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_namespaced_pod_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to pod.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_post_namespaced_pod_proxy_with_path
connect POST requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_namespaced_service_proxy()¶
connect POST requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_namespaced_service_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_post_namespaced_service_proxy
connect POST requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_namespaced_service_proxy_with_path()¶
connect POST requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_namespaced_service_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_post_namespaced_service_proxy_with_path
connect POST requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_node_proxy()¶
connect POST requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_node_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the NodeProxyOptions')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to node.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_post_node_proxy
connect POST requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_node_proxy_with_path()¶
connect POST requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_post_node_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the NodeProxyOptions')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to node.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_post_node_proxy_with_path
connect POST requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_put_namespaced_pod_proxy()¶
connect PUT requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_put_namespaced_pod_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to pod.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_put_namespaced_pod_proxy
connect PUT requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_put_namespaced_pod_proxy_with_path()¶
connect PUT requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_put_namespaced_pod_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to pod.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_put_namespaced_pod_proxy_with_path
connect PUT requests to proxy of Pod
- Parameters:
name (str) – name of the PodProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to pod.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_put_namespaced_service_proxy()¶
connect PUT requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_put_namespaced_service_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_put_namespaced_service_proxy
connect PUT requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_put_namespaced_service_proxy_with_path()¶
connect PUT requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_put_namespaced_service_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceProxyOptions')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_put_namespaced_service_proxy_with_path
connect PUT requests to proxy of Service
- Parameters:
name (str) – name of the ServiceProxyOptions (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
path (str) – path to the resource (required)
path2 (str) – Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_put_node_proxy()¶
connect PUT requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_put_node_proxy_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the NodeProxyOptions')], path: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to node.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_put_node_proxy
connect PUT requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_put_node_proxy_with_path()¶
connect PUT requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- connect_put_node_proxy_with_path_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the NodeProxyOptions')], path: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='path to the resource')], path2: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Path is the URL path to use for the current proxy request to node.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
connect_put_node_proxy_with_path
connect PUT requests to proxy of Node
- Parameters:
name (str) – name of the NodeProxyOptions (required)
path (str) – path to the resource (required)
path2 (str) – Path is the URL path to use for the current proxy request to node.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespace()¶
create a Namespace
- Parameters:
body (V1Namespace) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespace_with_http_info(body: V1Namespace, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Namespace, int, Any]¶
create_namespace
create a Namespace
- Parameters:
body (V1Namespace) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_binding()¶
create a Binding
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Binding) – (required)
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_binding_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Binding, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Binding, int, Any]¶
create_namespaced_binding
create a Binding
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Binding) – (required)
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_config_map()¶
create a ConfigMap
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ConfigMap) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_config_map_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1ConfigMap, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ConfigMap, int, Any]¶
create_namespaced_config_map
create a ConfigMap
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ConfigMap) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_endpoints()¶
create Endpoints
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Endpoints) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_endpoints_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Endpoints, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Endpoints, int, Any]¶
create_namespaced_endpoints
create Endpoints
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Endpoints) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_event()¶
create an Event
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (CoreV1Event) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_event_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: CoreV1Event, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[CoreV1Event, int, Any]¶
create_namespaced_event
create an Event
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (CoreV1Event) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_limit_range()¶
create a LimitRange
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1LimitRange) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_limit_range_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1LimitRange, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1LimitRange, int, Any]¶
create_namespaced_limit_range
create a LimitRange
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1LimitRange) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_persistent_volume_claim()¶
create a PersistentVolumeClaim
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1PersistentVolumeClaim) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_persistent_volume_claim_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1PersistentVolumeClaim, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolumeClaim, int, Any]¶
create_namespaced_persistent_volume_claim
create a PersistentVolumeClaim
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1PersistentVolumeClaim) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_pod()¶
create a Pod
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Pod) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_pod_binding()¶
create binding of a Pod
- Parameters:
name (str) – name of the Binding (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Binding) – (required)
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_pod_binding_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Binding')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Binding, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Binding, int, Any]¶
create_namespaced_pod_binding
create binding of a Pod
- Parameters:
name (str) – name of the Binding (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Binding) – (required)
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_pod_eviction()¶
create eviction of a Pod
- Parameters:
name (str) – name of the Eviction (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Eviction) – (required)
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_pod_eviction_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Eviction')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Eviction, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Eviction, int, Any]¶
create_namespaced_pod_eviction
create eviction of a Pod
- Parameters:
name (str) – name of the Eviction (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Eviction) – (required)
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_pod_template()¶
create a PodTemplate
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1PodTemplate) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_pod_template_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1PodTemplate, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PodTemplate, int, Any]¶
create_namespaced_pod_template
create a PodTemplate
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1PodTemplate) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_pod_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Pod, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Pod, int, Any]¶
create_namespaced_pod
create a Pod
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Pod) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_replication_controller()¶
create a ReplicationController
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ReplicationController) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_replication_controller_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1ReplicationController, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ReplicationController, int, Any]¶
create_namespaced_replication_controller
create a ReplicationController
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ReplicationController) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_resource_quota()¶
create a ResourceQuota
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ResourceQuota) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_resource_quota_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1ResourceQuota, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ResourceQuota, int, Any]¶
create_namespaced_resource_quota
create a ResourceQuota
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ResourceQuota) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_secret()¶
create a Secret
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Secret) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_secret_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Secret, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Secret, int, Any]¶
create_namespaced_secret
create a Secret
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Secret) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_service()¶
create a Service
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Service) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_service_account()¶
create a ServiceAccount
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ServiceAccount) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_service_account_token()¶
create token of a ServiceAccount
- Parameters:
name (str) – name of the TokenRequest (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (AuthenticationV1TokenRequest) – (required)
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_service_account_token_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the TokenRequest')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: AuthenticationV1TokenRequest, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[AuthenticationV1TokenRequest, int, Any]¶
create_namespaced_service_account_token
create token of a ServiceAccount
- Parameters:
name (str) – name of the TokenRequest (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (AuthenticationV1TokenRequest) – (required)
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_service_account_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1ServiceAccount, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ServiceAccount, int, Any]¶
create_namespaced_service_account
create a ServiceAccount
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ServiceAccount) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_namespaced_service_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Service, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Service, int, Any]¶
create_namespaced_service
create a Service
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Service) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_node()¶
create a Node
- Parameters:
body (V1Node) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_node_with_http_info(body: V1Node, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Node, int, Any]¶
create_node
create a Node
- Parameters:
body (V1Node) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_persistent_volume()¶
create a PersistentVolume
- Parameters:
body (V1PersistentVolume) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- create_persistent_volume_with_http_info(body: V1PersistentVolume, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolume, int, Any]¶
create_persistent_volume
create a PersistentVolume
- Parameters:
body (V1PersistentVolume) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_config_map()¶
delete collection of ConfigMap
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_config_map_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_collection_namespaced_config_map
delete collection of ConfigMap
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_endpoints()¶
delete collection of Endpoints
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_endpoints_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_collection_namespaced_endpoints
delete collection of Endpoints
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_event()¶
delete collection of Event
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_event_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_collection_namespaced_event
delete collection of Event
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_limit_range()¶
delete collection of LimitRange
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_limit_range_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_collection_namespaced_limit_range
delete collection of LimitRange
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_persistent_volume_claim()¶
delete collection of PersistentVolumeClaim
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_persistent_volume_claim_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_collection_namespaced_persistent_volume_claim
delete collection of PersistentVolumeClaim
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_pod()¶
delete collection of Pod
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_pod_template()¶
delete collection of PodTemplate
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_pod_template_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_collection_namespaced_pod_template
delete collection of PodTemplate
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_pod_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_collection_namespaced_pod
delete collection of Pod
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_replication_controller()¶
delete collection of ReplicationController
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_replication_controller_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_collection_namespaced_replication_controller
delete collection of ReplicationController
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_resource_quota()¶
delete collection of ResourceQuota
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_resource_quota_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_collection_namespaced_resource_quota
delete collection of ResourceQuota
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_secret()¶
delete collection of Secret
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_secret_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_collection_namespaced_secret
delete collection of Secret
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_service()¶
delete collection of Service
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_service_account()¶
delete collection of ServiceAccount
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_service_account_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_collection_namespaced_service_account
delete collection of ServiceAccount
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_namespaced_service_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_collection_namespaced_service
delete collection of Service
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_node()¶
delete collection of Node
- Parameters:
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_node_with_http_info(pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_collection_node
delete collection of Node
- Parameters:
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_persistent_volume()¶
delete collection of PersistentVolume
- Parameters:
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_collection_persistent_volume_with_http_info(pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_collection_persistent_volume
delete collection of PersistentVolume
- Parameters:
pretty (str) – 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).
_continue (str) – 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.
dry_run (str) – 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
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
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.
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. 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespace()¶
delete a Namespace
- Parameters:
name (str) – name of the Namespace (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespace_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Namespace')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[object, int, Any]¶
delete_namespace
delete a Namespace
- Parameters:
name (str) – name of the Namespace (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_config_map()¶
delete a ConfigMap
- Parameters:
name (str) – name of the ConfigMap (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_config_map_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ConfigMap')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_namespaced_config_map
delete a ConfigMap
- Parameters:
name (str) – name of the ConfigMap (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_endpoints()¶
delete Endpoints
- Parameters:
name (str) – name of the Endpoints (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_endpoints_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Endpoints')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_namespaced_endpoints
delete Endpoints
- Parameters:
name (str) – name of the Endpoints (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_event()¶
delete an Event
- Parameters:
name (str) – name of the Event (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_event_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Event')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_namespaced_event
delete an Event
- Parameters:
name (str) – name of the Event (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_limit_range()¶
delete a LimitRange
- Parameters:
name (str) – name of the LimitRange (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_limit_range_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the LimitRange')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_namespaced_limit_range
delete a LimitRange
- Parameters:
name (str) – name of the LimitRange (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_persistent_volume_claim()¶
delete a PersistentVolumeClaim
- Parameters:
name (str) – name of the PersistentVolumeClaim (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_persistent_volume_claim_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PersistentVolumeClaim')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolumeClaim, int, Any]¶
delete_namespaced_persistent_volume_claim
delete a PersistentVolumeClaim
- Parameters:
name (str) – name of the PersistentVolumeClaim (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_pod()¶
delete a Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_pod_template()¶
delete a PodTemplate
- Parameters:
name (str) – name of the PodTemplate (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_pod_template_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodTemplate')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PodTemplate, int, Any]¶
delete_namespaced_pod_template
delete a PodTemplate
- Parameters:
name (str) – name of the PodTemplate (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_pod_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Pod')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Pod, int, Any]¶
delete_namespaced_pod
delete a Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_replication_controller()¶
delete a ReplicationController
- Parameters:
name (str) – name of the ReplicationController (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_replication_controller_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ReplicationController')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_namespaced_replication_controller
delete a ReplicationController
- Parameters:
name (str) – name of the ReplicationController (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_resource_quota()¶
delete a ResourceQuota
- Parameters:
name (str) – name of the ResourceQuota (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_resource_quota_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ResourceQuota')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ResourceQuota, int, Any]¶
delete_namespaced_resource_quota
delete a ResourceQuota
- Parameters:
name (str) – name of the ResourceQuota (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_secret()¶
delete a Secret
- Parameters:
name (str) – name of the Secret (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_secret_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Secret')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_namespaced_secret
delete a Secret
- Parameters:
name (str) – name of the Secret (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_service()¶
delete a Service
- Parameters:
name (str) – name of the Service (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_service_account()¶
delete a ServiceAccount
- Parameters:
name (str) – name of the ServiceAccount (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_service_account_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceAccount')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ServiceAccount, int, Any]¶
delete_namespaced_service_account
delete a ServiceAccount
- Parameters:
name (str) – name of the ServiceAccount (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_namespaced_service_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Service')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Service, int, Any]¶
delete_namespaced_service
delete a Service
- Parameters:
name (str) – name of the Service (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_node()¶
delete a Node
- Parameters:
name (str) – name of the Node (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_node_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Node')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Status, int, Any]¶
delete_node
delete a Node
- Parameters:
name (str) – name of the Node (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_persistent_volume()¶
delete a PersistentVolume
- Parameters:
name (str) – name of the PersistentVolume (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- delete_persistent_volume_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PersistentVolume')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, ignore_store_read_error_with_cluster_breaking_potential: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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.")] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolume, int, Any]¶
delete_persistent_volume
delete a PersistentVolume
- Parameters:
name (str) – name of the PersistentVolume (required)
pretty (str) – 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).
dry_run (str) – 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
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.
ignore_store_read_error_with_cluster_breaking_potential (bool) – 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
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.
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. 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.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- get_api_resources()¶
get available resources
- Parameters:
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- get_api_resources_with_http_info(async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1APIResourceList, int, Any]¶
get_api_resources
get available resources
- Parameters:
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_component_status()¶
list objects of kind ComponentStatus
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_component_status_with_http_info(allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ComponentStatusList, int, Any]¶
list_component_status
list objects of kind ComponentStatus
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_config_map_for_all_namespaces()¶
list or watch objects of kind ConfigMap
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_config_map_for_all_namespaces_with_http_info(allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ConfigMapList, int, Any]¶
list_config_map_for_all_namespaces
list or watch objects of kind ConfigMap
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_endpoints_for_all_namespaces()¶
list or watch objects of kind Endpoints
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_endpoints_for_all_namespaces_with_http_info(allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1EndpointsList, int, Any]¶
list_endpoints_for_all_namespaces
list or watch objects of kind Endpoints
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_event_for_all_namespaces()¶
list or watch objects of kind Event
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_event_for_all_namespaces_with_http_info(allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[CoreV1EventList, int, Any]¶
list_event_for_all_namespaces
list or watch objects of kind Event
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_limit_range_for_all_namespaces()¶
list or watch objects of kind LimitRange
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_limit_range_for_all_namespaces_with_http_info(allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1LimitRangeList, int, Any]¶
list_limit_range_for_all_namespaces
list or watch objects of kind LimitRange
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespace()¶
list or watch objects of kind Namespace
- Parameters:
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespace_with_http_info(pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1NamespaceList, int, Any]¶
list_namespace
list or watch objects of kind Namespace
- Parameters:
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_config_map()¶
list or watch objects of kind ConfigMap
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_config_map_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ConfigMapList, int, Any]¶
list_namespaced_config_map
list or watch objects of kind ConfigMap
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_endpoints()¶
list or watch objects of kind Endpoints
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_endpoints_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1EndpointsList, int, Any]¶
list_namespaced_endpoints
list or watch objects of kind Endpoints
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_event()¶
list or watch objects of kind Event
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_event_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[CoreV1EventList, int, Any]¶
list_namespaced_event
list or watch objects of kind Event
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_limit_range()¶
list or watch objects of kind LimitRange
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_limit_range_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1LimitRangeList, int, Any]¶
list_namespaced_limit_range
list or watch objects of kind LimitRange
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_persistent_volume_claim()¶
list or watch objects of kind PersistentVolumeClaim
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_persistent_volume_claim_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolumeClaimList, int, Any]¶
list_namespaced_persistent_volume_claim
list or watch objects of kind PersistentVolumeClaim
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_pod()¶
list or watch objects of kind Pod
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_pod_template()¶
list or watch objects of kind PodTemplate
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_pod_template_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PodTemplateList, int, Any]¶
list_namespaced_pod_template
list or watch objects of kind PodTemplate
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_pod_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PodList, int, Any]¶
list_namespaced_pod
list or watch objects of kind Pod
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_replication_controller()¶
list or watch objects of kind ReplicationController
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_replication_controller_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ReplicationControllerList, int, Any]¶
list_namespaced_replication_controller
list or watch objects of kind ReplicationController
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_resource_quota()¶
list or watch objects of kind ResourceQuota
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_resource_quota_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ResourceQuotaList, int, Any]¶
list_namespaced_resource_quota
list or watch objects of kind ResourceQuota
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_secret()¶
list or watch objects of kind Secret
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_secret_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1SecretList, int, Any]¶
list_namespaced_secret
list or watch objects of kind Secret
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_service()¶
list or watch objects of kind Service
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_service_account()¶
list or watch objects of kind ServiceAccount
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_service_account_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ServiceAccountList, int, Any]¶
list_namespaced_service_account
list or watch objects of kind ServiceAccount
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_namespaced_service_with_http_info(namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ServiceList, int, Any]¶
list_namespaced_service
list or watch objects of kind Service
- Parameters:
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_node()¶
list or watch objects of kind Node
- Parameters:
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_node_with_http_info(pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1NodeList, int, Any]¶
list_node
list or watch objects of kind Node
- Parameters:
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_persistent_volume()¶
list or watch objects of kind PersistentVolume
- Parameters:
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_persistent_volume_claim_for_all_namespaces()¶
list or watch objects of kind PersistentVolumeClaim
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_persistent_volume_claim_for_all_namespaces_with_http_info(allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolumeClaimList, int, Any]¶
list_persistent_volume_claim_for_all_namespaces
list or watch objects of kind PersistentVolumeClaim
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_persistent_volume_with_http_info(pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolumeList, int, Any]¶
list_persistent_volume
list or watch objects of kind PersistentVolume
- Parameters:
pretty (str) – 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).
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_pod_for_all_namespaces()¶
list or watch objects of kind Pod
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_pod_for_all_namespaces_with_http_info(allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PodList, int, Any]¶
list_pod_for_all_namespaces
list or watch objects of kind Pod
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_pod_template_for_all_namespaces()¶
list or watch objects of kind PodTemplate
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_pod_template_for_all_namespaces_with_http_info(allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PodTemplateList, int, Any]¶
list_pod_template_for_all_namespaces
list or watch objects of kind PodTemplate
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_replication_controller_for_all_namespaces()¶
list or watch objects of kind ReplicationController
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_replication_controller_for_all_namespaces_with_http_info(allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ReplicationControllerList, int, Any]¶
list_replication_controller_for_all_namespaces
list or watch objects of kind ReplicationController
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_resource_quota_for_all_namespaces()¶
list or watch objects of kind ResourceQuota
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_resource_quota_for_all_namespaces_with_http_info(allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ResourceQuotaList, int, Any]¶
list_resource_quota_for_all_namespaces
list or watch objects of kind ResourceQuota
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_secret_for_all_namespaces()¶
list or watch objects of kind Secret
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_secret_for_all_namespaces_with_http_info(allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1SecretList, int, Any]¶
list_secret_for_all_namespaces
list or watch objects of kind Secret
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_service_account_for_all_namespaces()¶
list or watch objects of kind ServiceAccount
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_service_account_for_all_namespaces_with_http_info(allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ServiceAccountList, int, Any]¶
list_service_account_for_all_namespaces
list or watch objects of kind ServiceAccount
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_service_for_all_namespaces()¶
list or watch objects of kind Service
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- list_service_for_all_namespaces_with_http_info(allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, send_initial_events: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='`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.')] = None, shard_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') shardRange(object.metadata.uid, \'0x0\', \'0x8000000000000000\') || shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') Field paths use CEL-style object-rooted syntax (e.g. "object.metadata.uid"), NOT the fieldSelector format ("metadata.uid"). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a \'0x\' prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x8000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0x10000000000000000\') 4-shard split: shard 0: shardRange(object.metadata.uid, \'0x0000000000000000\', \'0x4000000000000000\') shard 1: shardRange(object.metadata.uid, \'0x4000000000000000\', \'0x8000000000000000\') shard 2: shardRange(object.metadata.uid, \'0x8000000000000000\', \'0xc000000000000000\') shard 3: shardRange(object.metadata.uid, \'0xc000000000000000\', \'0x10000000000000000\') This is an alpha field and requires enabling the ShardedListAndWatch feature gate.')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ServiceList, int, Any]¶
list_service_for_all_namespaces
list or watch objects of kind Service
- Parameters:
allow_watch_bookmarks (bool) – 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.
_continue (str) – 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.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – 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.
pretty (str) – 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).
resource_version (str) – 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
resource_version_match (str) – 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
send_initial_events (bool) – 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.
shard_selector (str) – shardSelector restricts the list of returned objects using a CEL-based shard selector expression. The format uses the shardRange() function combined with || (logical OR) to specify one or more hash ranges: shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) shardRange(object.metadata.uid, ‘0x0’, ‘0x8000000000000000’) || shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) Field paths use CEL-style object-rooted syntax (e.g. “object.metadata.uid”), NOT the fieldSelector format (“metadata.uid”). Currently supported paths: - object.metadata.uid - object.metadata.namespace hexStart and hexEnd are single-quoted CEL string literals with a ‘0x’ prefix, defining the inclusive lower and exclusive upper bounds over the 64-bit FNV-1a hash space. The full range is [0x0, 0x10000000000000000), where the exclusive upper bound equals 2^64. Examples: 2-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x8000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0x10000000000000000’) 4-shard split: shard 0: shardRange(object.metadata.uid, ‘0x0000000000000000’, ‘0x4000000000000000’) shard 1: shardRange(object.metadata.uid, ‘0x4000000000000000’, ‘0x8000000000000000’) shard 2: shardRange(object.metadata.uid, ‘0x8000000000000000’, ‘0xc000000000000000’) shard 3: shardRange(object.metadata.uid, ‘0xc000000000000000’, ‘0x10000000000000000’) This is an alpha field and requires enabling the ShardedListAndWatch feature gate.
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespace()¶
partially update the specified Namespace
- Parameters:
name (str) – name of the Namespace (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespace_status()¶
partially update status of the specified Namespace
- Parameters:
name (str) – name of the Namespace (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespace_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Namespace')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Namespace, int, Any]¶
patch_namespace_status
partially update status of the specified Namespace
- Parameters:
name (str) – name of the Namespace (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespace_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Namespace')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Namespace, int, Any]¶
patch_namespace
partially update the specified Namespace
- Parameters:
name (str) – name of the Namespace (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_config_map()¶
partially update the specified ConfigMap
- Parameters:
name (str) – name of the ConfigMap (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_config_map_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ConfigMap')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ConfigMap, int, Any]¶
patch_namespaced_config_map
partially update the specified ConfigMap
- Parameters:
name (str) – name of the ConfigMap (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_endpoints()¶
partially update the specified Endpoints
- Parameters:
name (str) – name of the Endpoints (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_endpoints_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Endpoints')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Endpoints, int, Any]¶
patch_namespaced_endpoints
partially update the specified Endpoints
- Parameters:
name (str) – name of the Endpoints (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_event()¶
partially update the specified Event
- Parameters:
name (str) – name of the Event (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_event_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Event')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[CoreV1Event, int, Any]¶
patch_namespaced_event
partially update the specified Event
- Parameters:
name (str) – name of the Event (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_limit_range()¶
partially update the specified LimitRange
- Parameters:
name (str) – name of the LimitRange (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_limit_range_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the LimitRange')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1LimitRange, int, Any]¶
patch_namespaced_limit_range
partially update the specified LimitRange
- Parameters:
name (str) – name of the LimitRange (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_persistent_volume_claim()¶
partially update the specified PersistentVolumeClaim
- Parameters:
name (str) – name of the PersistentVolumeClaim (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_persistent_volume_claim_status()¶
partially update status of the specified PersistentVolumeClaim
- Parameters:
name (str) – name of the PersistentVolumeClaim (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_persistent_volume_claim_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PersistentVolumeClaim')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolumeClaim, int, Any]¶
patch_namespaced_persistent_volume_claim_status
partially update status of the specified PersistentVolumeClaim
- Parameters:
name (str) – name of the PersistentVolumeClaim (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_persistent_volume_claim_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PersistentVolumeClaim')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolumeClaim, int, Any]¶
patch_namespaced_persistent_volume_claim
partially update the specified PersistentVolumeClaim
- Parameters:
name (str) – name of the PersistentVolumeClaim (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_pod()¶
partially update the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_pod_ephemeralcontainers()¶
partially update ephemeralcontainers of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_pod_ephemeralcontainers_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Pod')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Pod, int, Any]¶
patch_namespaced_pod_ephemeralcontainers
partially update ephemeralcontainers of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_pod_resize()¶
partially update resize of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_pod_resize_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Pod')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Pod, int, Any]¶
patch_namespaced_pod_resize
partially update resize of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_pod_status()¶
partially update status of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_pod_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Pod')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Pod, int, Any]¶
patch_namespaced_pod_status
partially update status of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_pod_template()¶
partially update the specified PodTemplate
- Parameters:
name (str) – name of the PodTemplate (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_pod_template_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodTemplate')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PodTemplate, int, Any]¶
patch_namespaced_pod_template
partially update the specified PodTemplate
- Parameters:
name (str) – name of the PodTemplate (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_pod_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Pod')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Pod, int, Any]¶
patch_namespaced_pod
partially update the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_replication_controller()¶
partially update the specified ReplicationController
- Parameters:
name (str) – name of the ReplicationController (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_replication_controller_scale()¶
partially update scale of the specified ReplicationController
- Parameters:
name (str) – name of the Scale (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_replication_controller_scale_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Scale')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Scale, int, Any]¶
patch_namespaced_replication_controller_scale
partially update scale of the specified ReplicationController
- Parameters:
name (str) – name of the Scale (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_replication_controller_status()¶
partially update status of the specified ReplicationController
- Parameters:
name (str) – name of the ReplicationController (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_replication_controller_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ReplicationController')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ReplicationController, int, Any]¶
patch_namespaced_replication_controller_status
partially update status of the specified ReplicationController
- Parameters:
name (str) – name of the ReplicationController (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_replication_controller_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ReplicationController')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ReplicationController, int, Any]¶
patch_namespaced_replication_controller
partially update the specified ReplicationController
- Parameters:
name (str) – name of the ReplicationController (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_resource_quota()¶
partially update the specified ResourceQuota
- Parameters:
name (str) – name of the ResourceQuota (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_resource_quota_status()¶
partially update status of the specified ResourceQuota
- Parameters:
name (str) – name of the ResourceQuota (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_resource_quota_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ResourceQuota')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ResourceQuota, int, Any]¶
patch_namespaced_resource_quota_status
partially update status of the specified ResourceQuota
- Parameters:
name (str) – name of the ResourceQuota (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_resource_quota_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ResourceQuota')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ResourceQuota, int, Any]¶
patch_namespaced_resource_quota
partially update the specified ResourceQuota
- Parameters:
name (str) – name of the ResourceQuota (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_secret()¶
partially update the specified Secret
- Parameters:
name (str) – name of the Secret (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_secret_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Secret')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Secret, int, Any]¶
patch_namespaced_secret
partially update the specified Secret
- Parameters:
name (str) – name of the Secret (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_service()¶
partially update the specified Service
- Parameters:
name (str) – name of the Service (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_service_account()¶
partially update the specified ServiceAccount
- Parameters:
name (str) – name of the ServiceAccount (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_service_account_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceAccount')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ServiceAccount, int, Any]¶
patch_namespaced_service_account
partially update the specified ServiceAccount
- Parameters:
name (str) – name of the ServiceAccount (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_service_status()¶
partially update status of the specified Service
- Parameters:
name (str) – name of the Service (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_service_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Service')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Service, int, Any]¶
patch_namespaced_service_status
partially update status of the specified Service
- Parameters:
name (str) – name of the Service (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_namespaced_service_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Service')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Service, int, Any]¶
patch_namespaced_service
partially update the specified Service
- Parameters:
name (str) – name of the Service (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_node()¶
partially update the specified Node
- Parameters:
name (str) – name of the Node (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_node_status()¶
partially update status of the specified Node
- Parameters:
name (str) – name of the Node (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_node_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Node')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Node, int, Any]¶
patch_node_status
partially update status of the specified Node
- Parameters:
name (str) – name of the Node (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_node_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Node')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Node, int, Any]¶
patch_node
partially update the specified Node
- Parameters:
name (str) – name of the Node (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_persistent_volume()¶
partially update the specified PersistentVolume
- Parameters:
name (str) – name of the PersistentVolume (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_persistent_volume_status()¶
partially update status of the specified PersistentVolume
- Parameters:
name (str) – name of the PersistentVolume (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_persistent_volume_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PersistentVolume')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolume, int, Any]¶
patch_persistent_volume_status
partially update status of the specified PersistentVolume
- Parameters:
name (str) – name of the PersistentVolume (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- patch_persistent_volume_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PersistentVolume')], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolume, int, Any]¶
patch_persistent_volume
partially update the specified PersistentVolume
- Parameters:
name (str) – name of the PersistentVolume (required)
body (object) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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).
field_validation (str) – 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.
force (bool) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_component_status()¶
read the specified ComponentStatus
- Parameters:
name (str) – name of the ComponentStatus (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_component_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ComponentStatus')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ComponentStatus, int, Any]¶
read_component_status
read the specified ComponentStatus
- Parameters:
name (str) – name of the ComponentStatus (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespace()¶
read the specified Namespace
- Parameters:
name (str) – name of the Namespace (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespace_status()¶
read status of the specified Namespace
- Parameters:
name (str) – name of the Namespace (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespace_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Namespace')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Namespace, int, Any]¶
read_namespace_status
read status of the specified Namespace
- Parameters:
name (str) – name of the Namespace (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespace_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Namespace')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Namespace, int, Any]¶
read_namespace
read the specified Namespace
- Parameters:
name (str) – name of the Namespace (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_config_map()¶
read the specified ConfigMap
- Parameters:
name (str) – name of the ConfigMap (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_config_map_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ConfigMap')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ConfigMap, int, Any]¶
read_namespaced_config_map
read the specified ConfigMap
- Parameters:
name (str) – name of the ConfigMap (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_endpoints()¶
read the specified Endpoints
- Parameters:
name (str) – name of the Endpoints (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_endpoints_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Endpoints')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Endpoints, int, Any]¶
read_namespaced_endpoints
read the specified Endpoints
- Parameters:
name (str) – name of the Endpoints (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_event()¶
read the specified Event
- Parameters:
name (str) – name of the Event (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_event_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Event')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[CoreV1Event, int, Any]¶
read_namespaced_event
read the specified Event
- Parameters:
name (str) – name of the Event (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_limit_range()¶
read the specified LimitRange
- Parameters:
name (str) – name of the LimitRange (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_limit_range_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the LimitRange')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1LimitRange, int, Any]¶
read_namespaced_limit_range
read the specified LimitRange
- Parameters:
name (str) – name of the LimitRange (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_persistent_volume_claim()¶
read the specified PersistentVolumeClaim
- Parameters:
name (str) – name of the PersistentVolumeClaim (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_persistent_volume_claim_status()¶
read status of the specified PersistentVolumeClaim
- Parameters:
name (str) – name of the PersistentVolumeClaim (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_persistent_volume_claim_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PersistentVolumeClaim')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolumeClaim, int, Any]¶
read_namespaced_persistent_volume_claim_status
read status of the specified PersistentVolumeClaim
- Parameters:
name (str) – name of the PersistentVolumeClaim (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_persistent_volume_claim_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PersistentVolumeClaim')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolumeClaim, int, Any]¶
read_namespaced_persistent_volume_claim
read the specified PersistentVolumeClaim
- Parameters:
name (str) – name of the PersistentVolumeClaim (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_pod()¶
read the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_pod_ephemeralcontainers()¶
read ephemeralcontainers of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_pod_ephemeralcontainers_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Pod')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Pod, int, Any]¶
read_namespaced_pod_ephemeralcontainers
read ephemeralcontainers of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_pod_log()¶
read log of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
container (str) – The container for which to stream logs. Defaults to only container if there is one container in the pod.
follow (bool) – Follow the log stream of the pod. Defaults to false.
insecure_skip_tls_verify_backend (bool) – insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver’s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet).
limit_bytes (int) – If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.
pretty (str) – 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).
previous (bool) – Return previous terminated container logs. Defaults to false.
since_seconds (int) – A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.
stream (str) – Specify which container log stream to return to the client. Acceptable values are “All”, “Stdout” and “Stderr”. If not specified, “All” is used, and both stdout and stderr are returned interleaved. Note that when “TailLines” is specified, “Stream” can only be set to nil or “All”.
tail_lines (int) – If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when “TailLines” is specified, “Stream” can only be set to nil or “All”.
timestamps (bool) – If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_pod_log_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Pod')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], container: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The container for which to stream logs. Defaults to only container if there is one container in the pod.')] = None, follow: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Follow the log stream of the pod. Defaults to false.')] = None, insecure_skip_tls_verify_backend: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet).")] = None, limit_bytes: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, previous: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Return previous terminated container logs. Defaults to false.')] = None, since_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.')] = None, stream: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Specify which container log stream to return to the client. Acceptable values are "All", "Stdout" and "Stderr". If not specified, "All" is used, and both stdout and stderr are returned interleaved. Note that when "TailLines" is specified, "Stream" can only be set to nil or "All".')] = None, tail_lines: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when "TailLines" is specified, "Stream" can only be set to nil or "All".')] = None, timestamps: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[str, int, Any]¶
read_namespaced_pod_log
read log of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
container (str) – The container for which to stream logs. Defaults to only container if there is one container in the pod.
follow (bool) – Follow the log stream of the pod. Defaults to false.
insecure_skip_tls_verify_backend (bool) – insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver’s TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet).
limit_bytes (int) – If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.
pretty (str) – 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).
previous (bool) – Return previous terminated container logs. Defaults to false.
since_seconds (int) – A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.
stream (str) – Specify which container log stream to return to the client. Acceptable values are “All”, “Stdout” and “Stderr”. If not specified, “All” is used, and both stdout and stderr are returned interleaved. Note that when “TailLines” is specified, “Stream” can only be set to nil or “All”.
tail_lines (int) – If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime. Note that when “TailLines” is specified, “Stream” can only be set to nil or “All”.
timestamps (bool) – If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_pod_resize()¶
read resize of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_pod_resize_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Pod')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Pod, int, Any]¶
read_namespaced_pod_resize
read resize of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_pod_status()¶
read status of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_pod_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Pod')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Pod, int, Any]¶
read_namespaced_pod_status
read status of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_pod_template()¶
read the specified PodTemplate
- Parameters:
name (str) – name of the PodTemplate (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_pod_template_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodTemplate')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PodTemplate, int, Any]¶
read_namespaced_pod_template
read the specified PodTemplate
- Parameters:
name (str) – name of the PodTemplate (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_pod_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Pod')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Pod, int, Any]¶
read_namespaced_pod
read the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_replication_controller()¶
read the specified ReplicationController
- Parameters:
name (str) – name of the ReplicationController (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_replication_controller_scale()¶
read scale of the specified ReplicationController
- Parameters:
name (str) – name of the Scale (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_replication_controller_scale_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Scale')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Scale, int, Any]¶
read_namespaced_replication_controller_scale
read scale of the specified ReplicationController
- Parameters:
name (str) – name of the Scale (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_replication_controller_status()¶
read status of the specified ReplicationController
- Parameters:
name (str) – name of the ReplicationController (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_replication_controller_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ReplicationController')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ReplicationController, int, Any]¶
read_namespaced_replication_controller_status
read status of the specified ReplicationController
- Parameters:
name (str) – name of the ReplicationController (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_replication_controller_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ReplicationController')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ReplicationController, int, Any]¶
read_namespaced_replication_controller
read the specified ReplicationController
- Parameters:
name (str) – name of the ReplicationController (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_resource_quota()¶
read the specified ResourceQuota
- Parameters:
name (str) – name of the ResourceQuota (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_resource_quota_status()¶
read status of the specified ResourceQuota
- Parameters:
name (str) – name of the ResourceQuota (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_resource_quota_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ResourceQuota')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ResourceQuota, int, Any]¶
read_namespaced_resource_quota_status
read status of the specified ResourceQuota
- Parameters:
name (str) – name of the ResourceQuota (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_resource_quota_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ResourceQuota')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ResourceQuota, int, Any]¶
read_namespaced_resource_quota
read the specified ResourceQuota
- Parameters:
name (str) – name of the ResourceQuota (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_secret()¶
read the specified Secret
- Parameters:
name (str) – name of the Secret (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_secret_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Secret')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Secret, int, Any]¶
read_namespaced_secret
read the specified Secret
- Parameters:
name (str) – name of the Secret (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_service()¶
read the specified Service
- Parameters:
name (str) – name of the Service (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_service_account()¶
read the specified ServiceAccount
- Parameters:
name (str) – name of the ServiceAccount (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_service_account_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceAccount')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ServiceAccount, int, Any]¶
read_namespaced_service_account
read the specified ServiceAccount
- Parameters:
name (str) – name of the ServiceAccount (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_service_status()¶
read status of the specified Service
- Parameters:
name (str) – name of the Service (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_service_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Service')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Service, int, Any]¶
read_namespaced_service_status
read status of the specified Service
- Parameters:
name (str) – name of the Service (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_namespaced_service_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Service')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Service, int, Any]¶
read_namespaced_service
read the specified Service
- Parameters:
name (str) – name of the Service (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_node()¶
read the specified Node
- Parameters:
name (str) – name of the Node (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_node_status()¶
read status of the specified Node
- Parameters:
name (str) – name of the Node (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_node_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Node')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Node, int, Any]¶
read_node_status
read status of the specified Node
- Parameters:
name (str) – name of the Node (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_node_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Node')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Node, int, Any]¶
read_node
read the specified Node
- Parameters:
name (str) – name of the Node (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_persistent_volume()¶
read the specified PersistentVolume
- Parameters:
name (str) – name of the PersistentVolume (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_persistent_volume_status()¶
read status of the specified PersistentVolume
- Parameters:
name (str) – name of the PersistentVolume (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_persistent_volume_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PersistentVolume')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolume, int, Any]¶
read_persistent_volume_status
read status of the specified PersistentVolume
- Parameters:
name (str) – name of the PersistentVolume (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- read_persistent_volume_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PersistentVolume')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolume, int, Any]¶
read_persistent_volume
read the specified PersistentVolume
- Parameters:
name (str) – name of the PersistentVolume (required)
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespace()¶
replace the specified Namespace
- Parameters:
name (str) – name of the Namespace (required)
body (V1Namespace) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespace_finalize()¶
replace finalize of the specified Namespace
- Parameters:
name (str) – name of the Namespace (required)
body (V1Namespace) – (required)
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespace_finalize_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Namespace')], body: V1Namespace, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Namespace, int, Any]¶
replace_namespace_finalize
replace finalize of the specified Namespace
- Parameters:
name (str) – name of the Namespace (required)
body (V1Namespace) – (required)
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
pretty (str) – 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).
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespace_status()¶
replace status of the specified Namespace
- Parameters:
name (str) – name of the Namespace (required)
body (V1Namespace) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespace_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Namespace')], body: V1Namespace, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Namespace, int, Any]¶
replace_namespace_status
replace status of the specified Namespace
- Parameters:
name (str) – name of the Namespace (required)
body (V1Namespace) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespace_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Namespace')], body: V1Namespace, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Namespace, int, Any]¶
replace_namespace
replace the specified Namespace
- Parameters:
name (str) – name of the Namespace (required)
body (V1Namespace) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_config_map()¶
replace the specified ConfigMap
- Parameters:
name (str) – name of the ConfigMap (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ConfigMap) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_config_map_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ConfigMap')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1ConfigMap, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ConfigMap, int, Any]¶
replace_namespaced_config_map
replace the specified ConfigMap
- Parameters:
name (str) – name of the ConfigMap (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ConfigMap) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_endpoints()¶
replace the specified Endpoints
- Parameters:
name (str) – name of the Endpoints (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Endpoints) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_endpoints_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Endpoints')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Endpoints, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Endpoints, int, Any]¶
replace_namespaced_endpoints
replace the specified Endpoints
- Parameters:
name (str) – name of the Endpoints (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Endpoints) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_event()¶
replace the specified Event
- Parameters:
name (str) – name of the Event (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (CoreV1Event) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_event_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Event')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: CoreV1Event, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[CoreV1Event, int, Any]¶
replace_namespaced_event
replace the specified Event
- Parameters:
name (str) – name of the Event (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (CoreV1Event) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_limit_range()¶
replace the specified LimitRange
- Parameters:
name (str) – name of the LimitRange (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1LimitRange) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_limit_range_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the LimitRange')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1LimitRange, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1LimitRange, int, Any]¶
replace_namespaced_limit_range
replace the specified LimitRange
- Parameters:
name (str) – name of the LimitRange (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1LimitRange) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_persistent_volume_claim()¶
replace the specified PersistentVolumeClaim
- Parameters:
name (str) – name of the PersistentVolumeClaim (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1PersistentVolumeClaim) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_persistent_volume_claim_status()¶
replace status of the specified PersistentVolumeClaim
- Parameters:
name (str) – name of the PersistentVolumeClaim (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1PersistentVolumeClaim) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_persistent_volume_claim_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PersistentVolumeClaim')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1PersistentVolumeClaim, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolumeClaim, int, Any]¶
replace_namespaced_persistent_volume_claim_status
replace status of the specified PersistentVolumeClaim
- Parameters:
name (str) – name of the PersistentVolumeClaim (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1PersistentVolumeClaim) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_persistent_volume_claim_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PersistentVolumeClaim')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1PersistentVolumeClaim, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolumeClaim, int, Any]¶
replace_namespaced_persistent_volume_claim
replace the specified PersistentVolumeClaim
- Parameters:
name (str) – name of the PersistentVolumeClaim (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1PersistentVolumeClaim) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_pod()¶
replace the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Pod) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_pod_ephemeralcontainers()¶
replace ephemeralcontainers of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Pod) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_pod_ephemeralcontainers_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Pod')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Pod, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Pod, int, Any]¶
replace_namespaced_pod_ephemeralcontainers
replace ephemeralcontainers of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Pod) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_pod_resize()¶
replace resize of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Pod) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_pod_resize_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Pod')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Pod, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Pod, int, Any]¶
replace_namespaced_pod_resize
replace resize of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Pod) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_pod_status()¶
replace status of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Pod) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_pod_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Pod')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Pod, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Pod, int, Any]¶
replace_namespaced_pod_status
replace status of the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Pod) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_pod_template()¶
replace the specified PodTemplate
- Parameters:
name (str) – name of the PodTemplate (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1PodTemplate) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_pod_template_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PodTemplate')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1PodTemplate, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PodTemplate, int, Any]¶
replace_namespaced_pod_template
replace the specified PodTemplate
- Parameters:
name (str) – name of the PodTemplate (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1PodTemplate) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_pod_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Pod')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Pod, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Pod, int, Any]¶
replace_namespaced_pod
replace the specified Pod
- Parameters:
name (str) – name of the Pod (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Pod) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_replication_controller()¶
replace the specified ReplicationController
- Parameters:
name (str) – name of the ReplicationController (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ReplicationController) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_replication_controller_scale()¶
replace scale of the specified ReplicationController
- Parameters:
name (str) – name of the Scale (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Scale) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_replication_controller_scale_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Scale')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Scale, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Scale, int, Any]¶
replace_namespaced_replication_controller_scale
replace scale of the specified ReplicationController
- Parameters:
name (str) – name of the Scale (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Scale) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_replication_controller_status()¶
replace status of the specified ReplicationController
- Parameters:
name (str) – name of the ReplicationController (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ReplicationController) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_replication_controller_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ReplicationController')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1ReplicationController, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ReplicationController, int, Any]¶
replace_namespaced_replication_controller_status
replace status of the specified ReplicationController
- Parameters:
name (str) – name of the ReplicationController (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ReplicationController) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_replication_controller_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ReplicationController')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1ReplicationController, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ReplicationController, int, Any]¶
replace_namespaced_replication_controller
replace the specified ReplicationController
- Parameters:
name (str) – name of the ReplicationController (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ReplicationController) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_resource_quota()¶
replace the specified ResourceQuota
- Parameters:
name (str) – name of the ResourceQuota (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ResourceQuota) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_resource_quota_status()¶
replace status of the specified ResourceQuota
- Parameters:
name (str) – name of the ResourceQuota (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ResourceQuota) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_resource_quota_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ResourceQuota')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1ResourceQuota, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ResourceQuota, int, Any]¶
replace_namespaced_resource_quota_status
replace status of the specified ResourceQuota
- Parameters:
name (str) – name of the ResourceQuota (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ResourceQuota) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_resource_quota_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ResourceQuota')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1ResourceQuota, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ResourceQuota, int, Any]¶
replace_namespaced_resource_quota
replace the specified ResourceQuota
- Parameters:
name (str) – name of the ResourceQuota (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ResourceQuota) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_secret()¶
replace the specified Secret
- Parameters:
name (str) – name of the Secret (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Secret) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_secret_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Secret')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Secret, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Secret, int, Any]¶
replace_namespaced_secret
replace the specified Secret
- Parameters:
name (str) – name of the Secret (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Secret) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_service()¶
replace the specified Service
- Parameters:
name (str) – name of the Service (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Service) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_service_account()¶
replace the specified ServiceAccount
- Parameters:
name (str) – name of the ServiceAccount (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ServiceAccount) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_service_account_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the ServiceAccount')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1ServiceAccount, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1ServiceAccount, int, Any]¶
replace_namespaced_service_account
replace the specified ServiceAccount
- Parameters:
name (str) – name of the ServiceAccount (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1ServiceAccount) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_service_status()¶
replace status of the specified Service
- Parameters:
name (str) – name of the Service (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Service) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_service_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Service')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Service, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Service, int, Any]¶
replace_namespaced_service_status
replace status of the specified Service
- Parameters:
name (str) – name of the Service (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Service) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_namespaced_service_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Service')], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='object name and auth scope, such as for teams and projects')], body: V1Service, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Service, int, Any]¶
replace_namespaced_service
replace the specified Service
- Parameters:
name (str) – name of the Service (required)
namespace (str) – object name and auth scope, such as for teams and projects (required)
body (V1Service) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_node()¶
replace the specified Node
- Parameters:
name (str) – name of the Node (required)
body (V1Node) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_node_status()¶
replace status of the specified Node
- Parameters:
name (str) – name of the Node (required)
body (V1Node) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_node_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Node')], body: V1Node, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Node, int, Any]¶
replace_node_status
replace status of the specified Node
- Parameters:
name (str) – name of the Node (required)
body (V1Node) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_node_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the Node')], body: V1Node, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1Node, int, Any]¶
replace_node
replace the specified Node
- Parameters:
name (str) – name of the Node (required)
body (V1Node) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_persistent_volume()¶
replace the specified PersistentVolume
- Parameters:
name (str) – name of the PersistentVolume (required)
body (V1PersistentVolume) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_persistent_volume_status()¶
replace status of the specified PersistentVolume
- Parameters:
name (str) – name of the PersistentVolume (required)
body (V1PersistentVolume) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_persistent_volume_status_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PersistentVolume')], body: V1PersistentVolume, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolume, int, Any]¶
replace_persistent_volume_status
replace status of the specified PersistentVolume
- Parameters:
name (str) – name of the PersistentVolume (required)
body (V1PersistentVolume) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.
- replace_persistent_volume_with_http_info(name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description='name of the PersistentVolume')], body: V1PersistentVolume, pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="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).")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='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.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) Tuple[V1PersistentVolume, int, Any]¶
replace_persistent_volume
replace the specified PersistentVolume
- Parameters:
name (str) – name of the PersistentVolume (required)
body (V1PersistentVolume) – (required)
pretty (str) – 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).
dry_run (str) – 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
field_manager (str) – 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.
field_validation (str) – 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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Returns:
Returns the result object.