kubernetes.client package¶
Subpackages¶
- kubernetes.client.apis package
- Submodules
- kubernetes.client.apis.apis_api module
- kubernetes.client.apis.apps_api module
- kubernetes.client.apis.apps_v1beta1_api module
- kubernetes.client.apis.authentication_api module
- kubernetes.client.apis.authentication_v1beta1_api module
- kubernetes.client.apis.authorization_api module
- kubernetes.client.apis.authorization_v1beta1_api module
- kubernetes.client.apis.autoscaling_api module
- kubernetes.client.apis.autoscaling_v1_api module
- kubernetes.client.apis.batch_api module
- kubernetes.client.apis.batch_v1_api module
- kubernetes.client.apis.batch_v2alpha1_api module
- kubernetes.client.apis.certificates_api module
- kubernetes.client.apis.certificates_v1alpha1_api module
- kubernetes.client.apis.core_api module
- kubernetes.client.apis.core_v1_api module
- kubernetes.client.apis.extensions_api module
- kubernetes.client.apis.extensions_v1beta1_api module
- kubernetes.client.apis.logs_api module
- kubernetes.client.apis.policy_api module
- kubernetes.client.apis.policy_v1beta1_api module
- kubernetes.client.apis.rbac_authorization_api module
- kubernetes.client.apis.rbac_authorization_v1alpha1_api module
- kubernetes.client.apis.storage_api module
- kubernetes.client.apis.storage_v1beta1_api module
- kubernetes.client.apis.version_api module
- Module contents
- kubernetes.client.models package
- Submodules
- kubernetes.client.models.intstr_int_or_string module
- kubernetes.client.models.resource_quantity module
- kubernetes.client.models.runtime_raw_extension module
- kubernetes.client.models.unversioned_api_group module
- kubernetes.client.models.unversioned_api_group_list module
- kubernetes.client.models.unversioned_api_resource module
- kubernetes.client.models.unversioned_api_resource_list module
- kubernetes.client.models.unversioned_api_versions module
- kubernetes.client.models.unversioned_group_version_for_discovery module
- kubernetes.client.models.unversioned_label_selector module
- kubernetes.client.models.unversioned_label_selector_requirement module
- kubernetes.client.models.unversioned_list_meta module
- kubernetes.client.models.unversioned_server_address_by_client_cidr module
- kubernetes.client.models.unversioned_status module
- kubernetes.client.models.unversioned_status_cause module
- kubernetes.client.models.unversioned_status_details module
- kubernetes.client.models.unversioned_time module
- kubernetes.client.models.v1_attached_volume module
- kubernetes.client.models.v1_aws_elastic_block_store_volume_source module
- kubernetes.client.models.v1_azure_disk_volume_source module
- kubernetes.client.models.v1_azure_file_volume_source module
- kubernetes.client.models.v1_binding module
- kubernetes.client.models.v1_capabilities module
- kubernetes.client.models.v1_ceph_fs_volume_source module
- kubernetes.client.models.v1_cinder_volume_source module
- kubernetes.client.models.v1_component_condition module
- kubernetes.client.models.v1_component_status module
- kubernetes.client.models.v1_component_status_list module
- kubernetes.client.models.v1_config_map module
- kubernetes.client.models.v1_config_map_key_selector module
- kubernetes.client.models.v1_config_map_list module
- kubernetes.client.models.v1_config_map_volume_source module
- kubernetes.client.models.v1_container module
- kubernetes.client.models.v1_container_image module
- kubernetes.client.models.v1_container_port module
- kubernetes.client.models.v1_container_state module
- kubernetes.client.models.v1_container_state_running module
- kubernetes.client.models.v1_container_state_terminated module
- kubernetes.client.models.v1_container_state_waiting module
- kubernetes.client.models.v1_container_status module
- kubernetes.client.models.v1_cross_version_object_reference module
- kubernetes.client.models.v1_daemon_endpoint module
- kubernetes.client.models.v1_delete_options module
- kubernetes.client.models.v1_downward_api_volume_file module
- kubernetes.client.models.v1_downward_api_volume_source module
- kubernetes.client.models.v1_empty_dir_volume_source module
- kubernetes.client.models.v1_endpoint_address module
- kubernetes.client.models.v1_endpoint_port module
- kubernetes.client.models.v1_endpoint_subset module
- kubernetes.client.models.v1_endpoints module
- kubernetes.client.models.v1_endpoints_list module
- kubernetes.client.models.v1_env_var module
- kubernetes.client.models.v1_env_var_source module
- kubernetes.client.models.v1_event module
- kubernetes.client.models.v1_event_list module
- kubernetes.client.models.v1_event_source module
- kubernetes.client.models.v1_exec_action module
- kubernetes.client.models.v1_fc_volume_source module
- kubernetes.client.models.v1_flex_volume_source module
- kubernetes.client.models.v1_flocker_volume_source module
- kubernetes.client.models.v1_gce_persistent_disk_volume_source module
- kubernetes.client.models.v1_git_repo_volume_source module
- kubernetes.client.models.v1_glusterfs_volume_source module
- kubernetes.client.models.v1_handler module
- kubernetes.client.models.v1_horizontal_pod_autoscaler module
- kubernetes.client.models.v1_horizontal_pod_autoscaler_list module
- kubernetes.client.models.v1_horizontal_pod_autoscaler_spec module
- kubernetes.client.models.v1_horizontal_pod_autoscaler_status module
- kubernetes.client.models.v1_host_path_volume_source module
- kubernetes.client.models.v1_http_get_action module
- kubernetes.client.models.v1_http_header module
- kubernetes.client.models.v1_iscsi_volume_source module
- kubernetes.client.models.v1_job module
- kubernetes.client.models.v1_job_condition module
- kubernetes.client.models.v1_job_list module
- kubernetes.client.models.v1_job_spec module
- kubernetes.client.models.v1_job_status module
- kubernetes.client.models.v1_key_to_path module
- kubernetes.client.models.v1_lifecycle module
- kubernetes.client.models.v1_limit_range module
- kubernetes.client.models.v1_limit_range_item module
- kubernetes.client.models.v1_limit_range_list module
- kubernetes.client.models.v1_limit_range_spec module
- kubernetes.client.models.v1_load_balancer_ingress module
- kubernetes.client.models.v1_load_balancer_status module
- kubernetes.client.models.v1_local_object_reference module
- kubernetes.client.models.v1_namespace module
- kubernetes.client.models.v1_namespace_list module
- kubernetes.client.models.v1_namespace_spec module
- kubernetes.client.models.v1_namespace_status module
- kubernetes.client.models.v1_nfs_volume_source module
- kubernetes.client.models.v1_node module
- kubernetes.client.models.v1_node_address module
- kubernetes.client.models.v1_node_condition module
- kubernetes.client.models.v1_node_daemon_endpoints module
- kubernetes.client.models.v1_node_list module
- kubernetes.client.models.v1_node_spec module
- kubernetes.client.models.v1_node_status module
- kubernetes.client.models.v1_node_system_info module
- kubernetes.client.models.v1_object_field_selector module
- kubernetes.client.models.v1_object_meta module
- kubernetes.client.models.v1_object_reference module
- kubernetes.client.models.v1_owner_reference module
- kubernetes.client.models.v1_persistent_volume module
- kubernetes.client.models.v1_persistent_volume_claim module
- kubernetes.client.models.v1_persistent_volume_claim_list module
- kubernetes.client.models.v1_persistent_volume_claim_spec module
- kubernetes.client.models.v1_persistent_volume_claim_status module
- kubernetes.client.models.v1_persistent_volume_claim_volume_source module
- kubernetes.client.models.v1_persistent_volume_list module
- kubernetes.client.models.v1_persistent_volume_spec module
- kubernetes.client.models.v1_persistent_volume_status module
- kubernetes.client.models.v1_photon_persistent_disk_volume_source module
- kubernetes.client.models.v1_pod module
- kubernetes.client.models.v1_pod_condition module
- kubernetes.client.models.v1_pod_list module
- kubernetes.client.models.v1_pod_security_context module
- kubernetes.client.models.v1_pod_spec module
- kubernetes.client.models.v1_pod_status module
- kubernetes.client.models.v1_pod_template module
- kubernetes.client.models.v1_pod_template_list module
- kubernetes.client.models.v1_pod_template_spec module
- kubernetes.client.models.v1_preconditions module
- kubernetes.client.models.v1_probe module
- kubernetes.client.models.v1_quobyte_volume_source module
- kubernetes.client.models.v1_rbd_volume_source module
- kubernetes.client.models.v1_replication_controller module
- kubernetes.client.models.v1_replication_controller_condition module
- kubernetes.client.models.v1_replication_controller_list module
- kubernetes.client.models.v1_replication_controller_spec module
- kubernetes.client.models.v1_replication_controller_status module
- kubernetes.client.models.v1_resource_field_selector module
- kubernetes.client.models.v1_resource_quota module
- kubernetes.client.models.v1_resource_quota_list module
- kubernetes.client.models.v1_resource_quota_spec module
- kubernetes.client.models.v1_resource_quota_status module
- kubernetes.client.models.v1_resource_requirements module
- kubernetes.client.models.v1_scale module
- kubernetes.client.models.v1_scale_spec module
- kubernetes.client.models.v1_scale_status module
- kubernetes.client.models.v1_se_linux_options module
- kubernetes.client.models.v1_secret module
- kubernetes.client.models.v1_secret_key_selector module
- kubernetes.client.models.v1_secret_list module
- kubernetes.client.models.v1_secret_volume_source module
- kubernetes.client.models.v1_security_context module
- kubernetes.client.models.v1_service module
- kubernetes.client.models.v1_service_account module
- kubernetes.client.models.v1_service_account_list module
- kubernetes.client.models.v1_service_list module
- kubernetes.client.models.v1_service_port module
- kubernetes.client.models.v1_service_spec module
- kubernetes.client.models.v1_service_status module
- kubernetes.client.models.v1_tcp_socket_action module
- kubernetes.client.models.v1_volume module
- kubernetes.client.models.v1_volume_mount module
- kubernetes.client.models.v1_vsphere_virtual_disk_volume_source module
- kubernetes.client.models.v1alpha1_certificate_signing_request module
- kubernetes.client.models.v1alpha1_certificate_signing_request_condition module
- kubernetes.client.models.v1alpha1_certificate_signing_request_list module
- kubernetes.client.models.v1alpha1_certificate_signing_request_spec module
- kubernetes.client.models.v1alpha1_certificate_signing_request_status module
- kubernetes.client.models.v1alpha1_cluster_role module
- kubernetes.client.models.v1alpha1_cluster_role_binding module
- kubernetes.client.models.v1alpha1_cluster_role_binding_list module
- kubernetes.client.models.v1alpha1_cluster_role_list module
- kubernetes.client.models.v1alpha1_policy_rule module
- kubernetes.client.models.v1alpha1_role module
- kubernetes.client.models.v1alpha1_role_binding module
- kubernetes.client.models.v1alpha1_role_binding_list module
- kubernetes.client.models.v1alpha1_role_list module
- kubernetes.client.models.v1alpha1_role_ref module
- kubernetes.client.models.v1alpha1_subject module
- kubernetes.client.models.v1beta1_api_version module
- kubernetes.client.models.v1beta1_cpu_target_utilization module
- kubernetes.client.models.v1beta1_daemon_set module
- kubernetes.client.models.v1beta1_daemon_set_list module
- kubernetes.client.models.v1beta1_daemon_set_spec module
- kubernetes.client.models.v1beta1_daemon_set_status module
- kubernetes.client.models.v1beta1_deployment module
- kubernetes.client.models.v1beta1_deployment_condition module
- kubernetes.client.models.v1beta1_deployment_list module
- kubernetes.client.models.v1beta1_deployment_rollback module
- kubernetes.client.models.v1beta1_deployment_spec module
- kubernetes.client.models.v1beta1_deployment_status module
- kubernetes.client.models.v1beta1_deployment_strategy module
- kubernetes.client.models.v1beta1_eviction module
- kubernetes.client.models.v1beta1_horizontal_pod_autoscaler module
- kubernetes.client.models.v1beta1_horizontal_pod_autoscaler_list module
- kubernetes.client.models.v1beta1_horizontal_pod_autoscaler_spec module
- kubernetes.client.models.v1beta1_horizontal_pod_autoscaler_status module
- kubernetes.client.models.v1beta1_http_ingress_path module
- kubernetes.client.models.v1beta1_http_ingress_rule_value module
- kubernetes.client.models.v1beta1_ingress module
- kubernetes.client.models.v1beta1_ingress_backend module
- kubernetes.client.models.v1beta1_ingress_list module
- kubernetes.client.models.v1beta1_ingress_rule module
- kubernetes.client.models.v1beta1_ingress_spec module
- kubernetes.client.models.v1beta1_ingress_status module
- kubernetes.client.models.v1beta1_ingress_tls module
- kubernetes.client.models.v1beta1_job module
- kubernetes.client.models.v1beta1_job_condition module
- kubernetes.client.models.v1beta1_job_list module
- kubernetes.client.models.v1beta1_job_spec module
- kubernetes.client.models.v1beta1_job_status module
- kubernetes.client.models.v1beta1_local_subject_access_review module
- kubernetes.client.models.v1beta1_network_policy module
- kubernetes.client.models.v1beta1_network_policy_ingress_rule module
- kubernetes.client.models.v1beta1_network_policy_list module
- kubernetes.client.models.v1beta1_network_policy_peer module
- kubernetes.client.models.v1beta1_network_policy_port module
- kubernetes.client.models.v1beta1_network_policy_spec module
- kubernetes.client.models.v1beta1_non_resource_attributes module
- kubernetes.client.models.v1beta1_pod_disruption_budget module
- kubernetes.client.models.v1beta1_pod_disruption_budget_list module
- kubernetes.client.models.v1beta1_pod_disruption_budget_spec module
- kubernetes.client.models.v1beta1_pod_disruption_budget_status module
- kubernetes.client.models.v1beta1_replica_set module
- kubernetes.client.models.v1beta1_replica_set_condition module
- kubernetes.client.models.v1beta1_replica_set_list module
- kubernetes.client.models.v1beta1_replica_set_spec module
- kubernetes.client.models.v1beta1_replica_set_status module
- kubernetes.client.models.v1beta1_resource_attributes module
- kubernetes.client.models.v1beta1_rollback_config module
- kubernetes.client.models.v1beta1_rolling_update_deployment module
- kubernetes.client.models.v1beta1_scale module
- kubernetes.client.models.v1beta1_scale_spec module
- kubernetes.client.models.v1beta1_scale_status module
- kubernetes.client.models.v1beta1_self_subject_access_review module
- kubernetes.client.models.v1beta1_self_subject_access_review_spec module
- kubernetes.client.models.v1beta1_stateful_set module
- kubernetes.client.models.v1beta1_stateful_set_list module
- kubernetes.client.models.v1beta1_stateful_set_spec module
- kubernetes.client.models.v1beta1_stateful_set_status module
- kubernetes.client.models.v1beta1_storage_class module
- kubernetes.client.models.v1beta1_storage_class_list module
- kubernetes.client.models.v1beta1_subject_access_review module
- kubernetes.client.models.v1beta1_subject_access_review_spec module
- kubernetes.client.models.v1beta1_subject_access_review_status module
- kubernetes.client.models.v1beta1_subresource_reference module
- kubernetes.client.models.v1beta1_third_party_resource module
- kubernetes.client.models.v1beta1_third_party_resource_list module
- kubernetes.client.models.v1beta1_token_review module
- kubernetes.client.models.v1beta1_token_review_spec module
- kubernetes.client.models.v1beta1_token_review_status module
- kubernetes.client.models.v1beta1_user_info module
- kubernetes.client.models.v2alpha1_cron_job module
- kubernetes.client.models.v2alpha1_cron_job_list module
- kubernetes.client.models.v2alpha1_cron_job_spec module
- kubernetes.client.models.v2alpha1_cron_job_status module
- kubernetes.client.models.v2alpha1_job module
- kubernetes.client.models.v2alpha1_job_condition module
- kubernetes.client.models.v2alpha1_job_list module
- kubernetes.client.models.v2alpha1_job_spec module
- kubernetes.client.models.v2alpha1_job_status module
- kubernetes.client.models.v2alpha1_job_template_spec module
- kubernetes.client.models.version_info module
- kubernetes.client.models.versioned_event module
- Module contents
Submodules¶
kubernetes.client.api_client module¶
Kubernetes
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: v1.12.4
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
kubernetes.client.api_client.
ApiClient
(configuration=None, header_name=None, header_value=None, cookie=None)¶ Bases:
object
Generic API client for Swagger client library builds.
Swagger generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the Swagger templates.
NOTE: This class is auto generated by the swagger code generator program. Ref: https://github.com/swagger-api/swagger-codegen Do not edit the class manually.
Parameters: - host – The base path for the server to call.
- header_name – a header to pass when making calls to the API.
- header_value – a header value to pass when making calls to the API.
-
NATIVE_TYPES_MAPPING
= {'bool': <class 'bool'>, 'date': <class 'datetime.date'>, 'datetime': <class 'datetime.datetime'>, 'float': <class 'float'>, 'int': <class 'int'>, 'long': <class 'int'>, 'object': <class 'object'>, 'str': <class 'str'>}¶
-
PRIMITIVE_TYPES
= (<class 'float'>, <class 'bool'>, <class 'bytes'>, <class 'str'>, <class 'int'>)¶
-
call_api
(resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_type=None, auth_settings=None, async_req=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None)¶ Makes the HTTP request (synchronous) and return the deserialized data. To make an async request, set the async parameter.
Parameters: - resource_path – Path to method endpoint.
- method – Method to call.
- path_params – Path parameters in the url.
- query_params – Query parameters in the url.
- header_params – Header parameters to be placed in the request header.
- body – Request body.
- dict (files) – Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.
- list (auth_settings) – Auth Settings names for the request.
- response – Response data type.
- dict – key -> filename, value -> filepath, for multipart/form-data.
- bool (async_req) – execute request asynchronously
- _return_http_data_only – response data without head status code and headers
- collection_formats – dict of collection formats for path, query, header, and post parameters.
- _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
- _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns: If async parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async is False or missing, then the method will return the response directly.
-
deserialize
(response, response_type)¶ Deserializes response into an object.
Parameters: - response – RESTResponse object to be deserialized.
- response_type – class literal for deserialized object, or string of class name.
Returns: deserialized object.
-
parameters_to_tuples
(params, collection_formats)¶ Get parameters as list of tuples, formatting collections.
Parameters: - params – Parameters as dict or list of two-tuples
- collection_formats (dict) – Parameter collection formats
Returns: Parameters as list of tuples, collections formatted
-
prepare_post_parameters
(post_params=None, files=None)¶ Builds form parameters.
Parameters: - post_params – Normal form parameters.
- files – File parameters.
Returns: Form parameters with files.
-
request
(method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)¶ Makes the HTTP request using RESTClient.
-
sanitize_for_serialization
(obj)¶ Builds a JSON POST object.
If obj is None, return None. If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date
convert to string in iso8601 format.If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is swagger model, return the properties dict.
Parameters: obj – The data to serialize. Returns: The serialized form of data.
-
select_header_accept
(accepts)¶ Returns Accept based on an array of accepts provided.
Parameters: accepts – List of headers. Returns: Accept (e.g. application/json).
-
select_header_content_type
(content_types)¶ Returns Content-Type based on an array of content_types provided.
Parameters: content_types – List of content-types. Returns: Content-Type (e.g. application/json).
-
set_default_header
(header_name, header_value)¶
-
update_params_for_auth
(headers, querys, auth_settings)¶ Updates header and query params based on authentication setting.
Parameters: - headers – Header parameters dict to be updated.
- querys – Query parameters tuple list to be updated.
- auth_settings – Authentication setting identifiers list.
-
user_agent
¶ Gets user agent.
kubernetes.client.configuration module¶
Kubernetes
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: v1.12.4
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
kubernetes.client.configuration.
Configuration
¶ Bases:
object
NOTE: This class is auto generated by the swagger code generator program. Ref: https://github.com/swagger-api/swagger-codegen Do not edit the class manually.
-
auth_settings
()¶ Gets Auth Settings dict for api client.
Returns: The Auth Settings information dict.
-
debug
¶ Gets the debug status.
-
get_api_key_with_prefix
(identifier)¶ Gets API key (with prefix if set).
Parameters: identifier – The identifier of apiKey. Returns: The token for api key authentication.
-
get_basic_auth_token
()¶ Gets HTTP basic authentication header (string).
Returns: The token for basic HTTP authentication.
-
logger_file
¶ Gets the logger_file.
-
logger_format
¶ Gets the logger_format.
-
to_debug_report
()¶ Gets the essential information for debugging.
Returns: The report for debugging.
-
kubernetes.client.rest module¶
Kubernetes
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: v1.12.4
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
exception
kubernetes.client.rest.
ApiException
(status=None, reason=None, http_resp=None)¶ Bases:
Exception
-
class
kubernetes.client.rest.
RESTClientObject
(configuration, pools_size=4, maxsize=None)¶ Bases:
object
-
DELETE
(url, headers=None, query_params=None, body=None, _preload_content=True, _request_timeout=None)¶
-
GET
(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)¶
-
HEAD
(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)¶
-
OPTIONS
(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)¶
-
PATCH
(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)¶
-
POST
(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)¶
-
PUT
(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)¶
-
request
(method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None)¶ Parameters: - method – http request method
- url – http request url
- query_params – query parameters in the url
- headers – http request headers
- body – request json body, for application/json
- post_params – request post parameters, application/x-www-form-urlencoded and multipart/form-data
- _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
- _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
-
Module contents¶
Kubernetes
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: v1.12.4
Generated by: https://github.com/swagger-api/swagger-codegen.git