fix(kubernetes): temporary solution for updated k8s python client
This commit is contained in:
parent
07d6fe7442
commit
9129813244
GPG key ID:
F17EFE4272D89FF6
1478 changed files with 422354 additions and 2 deletions
70
kubernetes/docs/AdmissionregistrationApi.md
Normal file
70
kubernetes/docs/AdmissionregistrationApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.AdmissionregistrationApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](AdmissionregistrationApi.md#get_api_group) | **GET** /apis/admissionregistration.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AdmissionregistrationApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AdmissionregistrationApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
2538
kubernetes/docs/AdmissionregistrationV1Api.md
Normal file
2538
kubernetes/docs/AdmissionregistrationV1Api.md
Normal file
File diff suppressed because it is too large
Load diff
14
kubernetes/docs/AdmissionregistrationV1ServiceReference.md
Normal file
14
kubernetes/docs/AdmissionregistrationV1ServiceReference.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# AdmissionregistrationV1ServiceReference
|
||||
|
||||
ServiceReference holds a reference to Service.legacy.k8s.io
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | `name` is the name of the service. Required |
|
||||
**namespace** | **str** | `namespace` is the namespace of the service. Required |
|
||||
**path** | **str** | `path` is an optional URL path which will be sent in any request to this service. | [optional]
|
||||
**port** | **int** | If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# AdmissionregistrationV1WebhookClientConfig
|
||||
|
||||
WebhookClientConfig contains the information to make a TLS connection with the webhook
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ca_bundle** | **str** | `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. | [optional]
|
||||
**service** | [**AdmissionregistrationV1ServiceReference**](AdmissionregistrationV1ServiceReference.md) | | [optional]
|
||||
**url** | **str** | `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be \"https\"; the URL must begin with \"https://\". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. \"user:password@\" is not allowed. Fragments (\"#...\") and query parameters (\"?...\") are not allowed, either. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
1192
kubernetes/docs/AdmissionregistrationV1alpha1Api.md
Normal file
1192
kubernetes/docs/AdmissionregistrationV1alpha1Api.md
Normal file
File diff suppressed because it is too large
Load diff
1416
kubernetes/docs/AdmissionregistrationV1beta1Api.md
Normal file
1416
kubernetes/docs/AdmissionregistrationV1beta1Api.md
Normal file
File diff suppressed because it is too large
Load diff
70
kubernetes/docs/ApiextensionsApi.md
Normal file
70
kubernetes/docs/ApiextensionsApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.ApiextensionsApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](ApiextensionsApi.md#get_api_group) | **GET** /apis/apiextensions.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiextensionsApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiextensionsApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
855
kubernetes/docs/ApiextensionsV1Api.md
Normal file
855
kubernetes/docs/ApiextensionsV1Api.md
Normal file
|
|
@ -0,0 +1,855 @@
|
|||
# kubernetes.client.ApiextensionsV1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_custom_resource_definition**](ApiextensionsV1Api.md#create_custom_resource_definition) | **POST** /apis/apiextensions.k8s.io/v1/customresourcedefinitions |
|
||||
[**delete_collection_custom_resource_definition**](ApiextensionsV1Api.md#delete_collection_custom_resource_definition) | **DELETE** /apis/apiextensions.k8s.io/v1/customresourcedefinitions |
|
||||
[**delete_custom_resource_definition**](ApiextensionsV1Api.md#delete_custom_resource_definition) | **DELETE** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} |
|
||||
[**get_api_resources**](ApiextensionsV1Api.md#get_api_resources) | **GET** /apis/apiextensions.k8s.io/v1/ |
|
||||
[**list_custom_resource_definition**](ApiextensionsV1Api.md#list_custom_resource_definition) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions |
|
||||
[**patch_custom_resource_definition**](ApiextensionsV1Api.md#patch_custom_resource_definition) | **PATCH** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} |
|
||||
[**patch_custom_resource_definition_status**](ApiextensionsV1Api.md#patch_custom_resource_definition_status) | **PATCH** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status |
|
||||
[**read_custom_resource_definition**](ApiextensionsV1Api.md#read_custom_resource_definition) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} |
|
||||
[**read_custom_resource_definition_status**](ApiextensionsV1Api.md#read_custom_resource_definition_status) | **GET** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status |
|
||||
[**replace_custom_resource_definition**](ApiextensionsV1Api.md#replace_custom_resource_definition) | **PUT** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name} |
|
||||
[**replace_custom_resource_definition_status**](ApiextensionsV1Api.md#replace_custom_resource_definition_status) | **PUT** /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status |
|
||||
|
||||
|
||||
# **create_custom_resource_definition**
|
||||
> V1CustomResourceDefinition create_custom_resource_definition(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create a CustomResourceDefinition
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiextensionsV1Api(api_client)
|
||||
body = kubernetes.client.V1CustomResourceDefinition() # V1CustomResourceDefinition |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_custom_resource_definition(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiextensionsV1Api->create_custom_resource_definition: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1CustomResourceDefinition**](V1CustomResourceDefinition.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1CustomResourceDefinition**](V1CustomResourceDefinition.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_custom_resource_definition**
|
||||
> V1Status delete_collection_custom_resource_definition(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of CustomResourceDefinition
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiextensionsV1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_custom_resource_definition(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiextensionsV1Api->delete_collection_custom_resource_definition: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_custom_resource_definition**
|
||||
> V1Status delete_custom_resource_definition(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete a CustomResourceDefinition
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiextensionsV1Api(api_client)
|
||||
name = 'name_example' # str | name of the CustomResourceDefinition
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_custom_resource_definition(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiextensionsV1Api->delete_custom_resource_definition: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the CustomResourceDefinition |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiextensionsV1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiextensionsV1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_custom_resource_definition**
|
||||
> V1CustomResourceDefinitionList list_custom_resource_definition(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind CustomResourceDefinition
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiextensionsV1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_custom_resource_definition(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiextensionsV1Api->list_custom_resource_definition: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1CustomResourceDefinitionList**](V1CustomResourceDefinitionList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_custom_resource_definition**
|
||||
> V1CustomResourceDefinition patch_custom_resource_definition(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified CustomResourceDefinition
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiextensionsV1Api(api_client)
|
||||
name = 'name_example' # str | name of the CustomResourceDefinition
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_custom_resource_definition(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiextensionsV1Api->patch_custom_resource_definition: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the CustomResourceDefinition |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1CustomResourceDefinition**](V1CustomResourceDefinition.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_custom_resource_definition_status**
|
||||
> V1CustomResourceDefinition patch_custom_resource_definition_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update status of the specified CustomResourceDefinition
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiextensionsV1Api(api_client)
|
||||
name = 'name_example' # str | name of the CustomResourceDefinition
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_custom_resource_definition_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiextensionsV1Api->patch_custom_resource_definition_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the CustomResourceDefinition |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1CustomResourceDefinition**](V1CustomResourceDefinition.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_custom_resource_definition**
|
||||
> V1CustomResourceDefinition read_custom_resource_definition(name, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified CustomResourceDefinition
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiextensionsV1Api(api_client)
|
||||
name = 'name_example' # str | name of the CustomResourceDefinition
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_custom_resource_definition(name, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiextensionsV1Api->read_custom_resource_definition: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the CustomResourceDefinition |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1CustomResourceDefinition**](V1CustomResourceDefinition.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_custom_resource_definition_status**
|
||||
> V1CustomResourceDefinition read_custom_resource_definition_status(name, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read status of the specified CustomResourceDefinition
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiextensionsV1Api(api_client)
|
||||
name = 'name_example' # str | name of the CustomResourceDefinition
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_custom_resource_definition_status(name, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiextensionsV1Api->read_custom_resource_definition_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the CustomResourceDefinition |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1CustomResourceDefinition**](V1CustomResourceDefinition.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_custom_resource_definition**
|
||||
> V1CustomResourceDefinition replace_custom_resource_definition(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified CustomResourceDefinition
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiextensionsV1Api(api_client)
|
||||
name = 'name_example' # str | name of the CustomResourceDefinition
|
||||
body = kubernetes.client.V1CustomResourceDefinition() # V1CustomResourceDefinition |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_custom_resource_definition(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiextensionsV1Api->replace_custom_resource_definition: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the CustomResourceDefinition |
|
||||
**body** | [**V1CustomResourceDefinition**](V1CustomResourceDefinition.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1CustomResourceDefinition**](V1CustomResourceDefinition.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_custom_resource_definition_status**
|
||||
> V1CustomResourceDefinition replace_custom_resource_definition_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace status of the specified CustomResourceDefinition
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiextensionsV1Api(api_client)
|
||||
name = 'name_example' # str | name of the CustomResourceDefinition
|
||||
body = kubernetes.client.V1CustomResourceDefinition() # V1CustomResourceDefinition |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_custom_resource_definition_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiextensionsV1Api->replace_custom_resource_definition_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the CustomResourceDefinition |
|
||||
**body** | [**V1CustomResourceDefinition**](V1CustomResourceDefinition.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1CustomResourceDefinition**](V1CustomResourceDefinition.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
14
kubernetes/docs/ApiextensionsV1ServiceReference.md
Normal file
14
kubernetes/docs/ApiextensionsV1ServiceReference.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# ApiextensionsV1ServiceReference
|
||||
|
||||
ServiceReference holds a reference to Service.legacy.k8s.io
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | name is the name of the service. Required |
|
||||
**namespace** | **str** | namespace is the namespace of the service. Required |
|
||||
**path** | **str** | path is an optional URL path at which the webhook will be contacted. | [optional]
|
||||
**port** | **int** | port is an optional service port at which the webhook will be contacted. `port` should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
13
kubernetes/docs/ApiextensionsV1WebhookClientConfig.md
Normal file
13
kubernetes/docs/ApiextensionsV1WebhookClientConfig.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# ApiextensionsV1WebhookClientConfig
|
||||
|
||||
WebhookClientConfig contains the information to make a TLS connection with the webhook.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ca_bundle** | **str** | caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. | [optional]
|
||||
**service** | [**ApiextensionsV1ServiceReference**](ApiextensionsV1ServiceReference.md) | | [optional]
|
||||
**url** | **str** | url gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be \"https\"; the URL must begin with \"https://\". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. \"user:password@\" is not allowed. Fragments (\"#...\") and query parameters (\"?...\") are not allowed, either. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
70
kubernetes/docs/ApiregistrationApi.md
Normal file
70
kubernetes/docs/ApiregistrationApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.ApiregistrationApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](ApiregistrationApi.md#get_api_group) | **GET** /apis/apiregistration.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiregistrationApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiregistrationApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
855
kubernetes/docs/ApiregistrationV1Api.md
Normal file
855
kubernetes/docs/ApiregistrationV1Api.md
Normal file
|
|
@ -0,0 +1,855 @@
|
|||
# kubernetes.client.ApiregistrationV1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_api_service**](ApiregistrationV1Api.md#create_api_service) | **POST** /apis/apiregistration.k8s.io/v1/apiservices |
|
||||
[**delete_api_service**](ApiregistrationV1Api.md#delete_api_service) | **DELETE** /apis/apiregistration.k8s.io/v1/apiservices/{name} |
|
||||
[**delete_collection_api_service**](ApiregistrationV1Api.md#delete_collection_api_service) | **DELETE** /apis/apiregistration.k8s.io/v1/apiservices |
|
||||
[**get_api_resources**](ApiregistrationV1Api.md#get_api_resources) | **GET** /apis/apiregistration.k8s.io/v1/ |
|
||||
[**list_api_service**](ApiregistrationV1Api.md#list_api_service) | **GET** /apis/apiregistration.k8s.io/v1/apiservices |
|
||||
[**patch_api_service**](ApiregistrationV1Api.md#patch_api_service) | **PATCH** /apis/apiregistration.k8s.io/v1/apiservices/{name} |
|
||||
[**patch_api_service_status**](ApiregistrationV1Api.md#patch_api_service_status) | **PATCH** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status |
|
||||
[**read_api_service**](ApiregistrationV1Api.md#read_api_service) | **GET** /apis/apiregistration.k8s.io/v1/apiservices/{name} |
|
||||
[**read_api_service_status**](ApiregistrationV1Api.md#read_api_service_status) | **GET** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status |
|
||||
[**replace_api_service**](ApiregistrationV1Api.md#replace_api_service) | **PUT** /apis/apiregistration.k8s.io/v1/apiservices/{name} |
|
||||
[**replace_api_service_status**](ApiregistrationV1Api.md#replace_api_service_status) | **PUT** /apis/apiregistration.k8s.io/v1/apiservices/{name}/status |
|
||||
|
||||
|
||||
# **create_api_service**
|
||||
> V1APIService create_api_service(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create an APIService
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiregistrationV1Api(api_client)
|
||||
body = kubernetes.client.V1APIService() # V1APIService |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_api_service(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiregistrationV1Api->create_api_service: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1APIService**](V1APIService.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIService**](V1APIService.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_api_service**
|
||||
> V1Status delete_api_service(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete an APIService
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiregistrationV1Api(api_client)
|
||||
name = 'name_example' # str | name of the APIService
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_api_service(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiregistrationV1Api->delete_api_service: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the APIService |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_api_service**
|
||||
> V1Status delete_collection_api_service(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of APIService
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiregistrationV1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_api_service(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiregistrationV1Api->delete_collection_api_service: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiregistrationV1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiregistrationV1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_api_service**
|
||||
> V1APIServiceList list_api_service(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind APIService
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiregistrationV1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_api_service(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiregistrationV1Api->list_api_service: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIServiceList**](V1APIServiceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_api_service**
|
||||
> V1APIService patch_api_service(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified APIService
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiregistrationV1Api(api_client)
|
||||
name = 'name_example' # str | name of the APIService
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_api_service(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiregistrationV1Api->patch_api_service: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the APIService |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIService**](V1APIService.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_api_service_status**
|
||||
> V1APIService patch_api_service_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update status of the specified APIService
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiregistrationV1Api(api_client)
|
||||
name = 'name_example' # str | name of the APIService
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_api_service_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiregistrationV1Api->patch_api_service_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the APIService |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIService**](V1APIService.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_api_service**
|
||||
> V1APIService read_api_service(name, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified APIService
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiregistrationV1Api(api_client)
|
||||
name = 'name_example' # str | name of the APIService
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_api_service(name, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiregistrationV1Api->read_api_service: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the APIService |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIService**](V1APIService.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_api_service_status**
|
||||
> V1APIService read_api_service_status(name, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read status of the specified APIService
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiregistrationV1Api(api_client)
|
||||
name = 'name_example' # str | name of the APIService
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_api_service_status(name, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiregistrationV1Api->read_api_service_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the APIService |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIService**](V1APIService.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_api_service**
|
||||
> V1APIService replace_api_service(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified APIService
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiregistrationV1Api(api_client)
|
||||
name = 'name_example' # str | name of the APIService
|
||||
body = kubernetes.client.V1APIService() # V1APIService |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_api_service(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiregistrationV1Api->replace_api_service: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the APIService |
|
||||
**body** | [**V1APIService**](V1APIService.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIService**](V1APIService.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_api_service_status**
|
||||
> V1APIService replace_api_service_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace status of the specified APIService
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApiregistrationV1Api(api_client)
|
||||
name = 'name_example' # str | name of the APIService
|
||||
body = kubernetes.client.V1APIService() # V1APIService |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_api_service_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApiregistrationV1Api->replace_api_service_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the APIService |
|
||||
**body** | [**V1APIService**](V1APIService.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIService**](V1APIService.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
13
kubernetes/docs/ApiregistrationV1ServiceReference.md
Normal file
13
kubernetes/docs/ApiregistrationV1ServiceReference.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# ApiregistrationV1ServiceReference
|
||||
|
||||
ServiceReference holds a reference to Service.legacy.k8s.io
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | Name is the name of the service | [optional]
|
||||
**namespace** | **str** | Namespace is the namespace of the service | [optional]
|
||||
**port** | **int** | If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
70
kubernetes/docs/ApisApi.md
Normal file
70
kubernetes/docs/ApisApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.ApisApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_versions**](ApisApi.md#get_api_versions) | **GET** /apis/ |
|
||||
|
||||
|
||||
# **get_api_versions**
|
||||
> V1APIGroupList get_api_versions()
|
||||
|
||||
|
||||
|
||||
get available API versions
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ApisApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_versions()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ApisApi->get_api_versions: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroupList**](V1APIGroupList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
70
kubernetes/docs/AppsApi.md
Normal file
70
kubernetes/docs/AppsApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.AppsApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](AppsApi.md#get_api_group) | **GET** /apis/apps/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AppsApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AppsApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
4985
kubernetes/docs/AppsV1Api.md
Normal file
4985
kubernetes/docs/AppsV1Api.md
Normal file
File diff suppressed because it is too large
Load diff
70
kubernetes/docs/AuthenticationApi.md
Normal file
70
kubernetes/docs/AuthenticationApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.AuthenticationApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](AuthenticationApi.md#get_api_group) | **GET** /apis/authentication.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AuthenticationApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AuthenticationApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
222
kubernetes/docs/AuthenticationV1Api.md
Normal file
222
kubernetes/docs/AuthenticationV1Api.md
Normal file
|
|
@ -0,0 +1,222 @@
|
|||
# kubernetes.client.AuthenticationV1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_self_subject_review**](AuthenticationV1Api.md#create_self_subject_review) | **POST** /apis/authentication.k8s.io/v1/selfsubjectreviews |
|
||||
[**create_token_review**](AuthenticationV1Api.md#create_token_review) | **POST** /apis/authentication.k8s.io/v1/tokenreviews |
|
||||
[**get_api_resources**](AuthenticationV1Api.md#get_api_resources) | **GET** /apis/authentication.k8s.io/v1/ |
|
||||
|
||||
|
||||
# **create_self_subject_review**
|
||||
> V1SelfSubjectReview create_self_subject_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
create a SelfSubjectReview
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AuthenticationV1Api(api_client)
|
||||
body = kubernetes.client.V1SelfSubjectReview() # V1SelfSubjectReview |
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_self_subject_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AuthenticationV1Api->create_self_subject_review: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1SelfSubjectReview**](V1SelfSubjectReview.md)| |
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1SelfSubjectReview**](V1SelfSubjectReview.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **create_token_review**
|
||||
> V1TokenReview create_token_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
create a TokenReview
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AuthenticationV1Api(api_client)
|
||||
body = kubernetes.client.V1TokenReview() # V1TokenReview |
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_token_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AuthenticationV1Api->create_token_review: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1TokenReview**](V1TokenReview.md)| |
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1TokenReview**](V1TokenReview.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AuthenticationV1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AuthenticationV1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
15
kubernetes/docs/AuthenticationV1TokenRequest.md
Normal file
15
kubernetes/docs/AuthenticationV1TokenRequest.md
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# AuthenticationV1TokenRequest
|
||||
|
||||
TokenRequest requests a token for a given service account.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
|
||||
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the kubernetes.client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
|
||||
**metadata** | [**V1ObjectMeta**](V1ObjectMeta.md) | | [optional]
|
||||
**spec** | [**V1TokenRequestSpec**](V1TokenRequestSpec.md) | |
|
||||
**status** | [**V1TokenRequestStatus**](V1TokenRequestStatus.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
146
kubernetes/docs/AuthenticationV1beta1Api.md
Normal file
146
kubernetes/docs/AuthenticationV1beta1Api.md
Normal file
|
|
@ -0,0 +1,146 @@
|
|||
# kubernetes.client.AuthenticationV1beta1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_self_subject_review**](AuthenticationV1beta1Api.md#create_self_subject_review) | **POST** /apis/authentication.k8s.io/v1beta1/selfsubjectreviews |
|
||||
[**get_api_resources**](AuthenticationV1beta1Api.md#get_api_resources) | **GET** /apis/authentication.k8s.io/v1beta1/ |
|
||||
|
||||
|
||||
# **create_self_subject_review**
|
||||
> V1beta1SelfSubjectReview create_self_subject_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
create a SelfSubjectReview
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AuthenticationV1beta1Api(api_client)
|
||||
body = kubernetes.client.V1beta1SelfSubjectReview() # V1beta1SelfSubjectReview |
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_self_subject_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AuthenticationV1beta1Api->create_self_subject_review: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1beta1SelfSubjectReview**](V1beta1SelfSubjectReview.md)| |
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1beta1SelfSubjectReview**](V1beta1SelfSubjectReview.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AuthenticationV1beta1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AuthenticationV1beta1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
70
kubernetes/docs/AuthorizationApi.md
Normal file
70
kubernetes/docs/AuthorizationApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.AuthorizationApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](AuthorizationApi.md#get_api_group) | **GET** /apis/authorization.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AuthorizationApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AuthorizationApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
376
kubernetes/docs/AuthorizationV1Api.md
Normal file
376
kubernetes/docs/AuthorizationV1Api.md
Normal file
|
|
@ -0,0 +1,376 @@
|
|||
# kubernetes.client.AuthorizationV1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_namespaced_local_subject_access_review**](AuthorizationV1Api.md#create_namespaced_local_subject_access_review) | **POST** /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews |
|
||||
[**create_self_subject_access_review**](AuthorizationV1Api.md#create_self_subject_access_review) | **POST** /apis/authorization.k8s.io/v1/selfsubjectaccessreviews |
|
||||
[**create_self_subject_rules_review**](AuthorizationV1Api.md#create_self_subject_rules_review) | **POST** /apis/authorization.k8s.io/v1/selfsubjectrulesreviews |
|
||||
[**create_subject_access_review**](AuthorizationV1Api.md#create_subject_access_review) | **POST** /apis/authorization.k8s.io/v1/subjectaccessreviews |
|
||||
[**get_api_resources**](AuthorizationV1Api.md#get_api_resources) | **GET** /apis/authorization.k8s.io/v1/ |
|
||||
|
||||
|
||||
# **create_namespaced_local_subject_access_review**
|
||||
> V1LocalSubjectAccessReview create_namespaced_local_subject_access_review(namespace, body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
create a LocalSubjectAccessReview
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AuthorizationV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V1LocalSubjectAccessReview() # V1LocalSubjectAccessReview |
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_namespaced_local_subject_access_review(namespace, body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AuthorizationV1Api->create_namespaced_local_subject_access_review: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V1LocalSubjectAccessReview**](V1LocalSubjectAccessReview.md)| |
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1LocalSubjectAccessReview**](V1LocalSubjectAccessReview.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **create_self_subject_access_review**
|
||||
> V1SelfSubjectAccessReview create_self_subject_access_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
create a SelfSubjectAccessReview
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AuthorizationV1Api(api_client)
|
||||
body = kubernetes.client.V1SelfSubjectAccessReview() # V1SelfSubjectAccessReview |
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_self_subject_access_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AuthorizationV1Api->create_self_subject_access_review: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1SelfSubjectAccessReview**](V1SelfSubjectAccessReview.md)| |
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1SelfSubjectAccessReview**](V1SelfSubjectAccessReview.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **create_self_subject_rules_review**
|
||||
> V1SelfSubjectRulesReview create_self_subject_rules_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
create a SelfSubjectRulesReview
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AuthorizationV1Api(api_client)
|
||||
body = kubernetes.client.V1SelfSubjectRulesReview() # V1SelfSubjectRulesReview |
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_self_subject_rules_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AuthorizationV1Api->create_self_subject_rules_review: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1SelfSubjectRulesReview**](V1SelfSubjectRulesReview.md)| |
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1SelfSubjectRulesReview**](V1SelfSubjectRulesReview.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **create_subject_access_review**
|
||||
> V1SubjectAccessReview create_subject_access_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
create a SubjectAccessReview
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AuthorizationV1Api(api_client)
|
||||
body = kubernetes.client.V1SubjectAccessReview() # V1SubjectAccessReview |
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_subject_access_review(body, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AuthorizationV1Api->create_subject_access_review: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1SubjectAccessReview**](V1SubjectAccessReview.md)| |
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1SubjectAccessReview**](V1SubjectAccessReview.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AuthorizationV1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AuthorizationV1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
70
kubernetes/docs/AutoscalingApi.md
Normal file
70
kubernetes/docs/AutoscalingApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.AutoscalingApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](AutoscalingApi.md#get_api_group) | **GET** /apis/autoscaling/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
961
kubernetes/docs/AutoscalingV1Api.md
Normal file
961
kubernetes/docs/AutoscalingV1Api.md
Normal file
|
|
@ -0,0 +1,961 @@
|
|||
# kubernetes.client.AutoscalingV1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_namespaced_horizontal_pod_autoscaler**](AutoscalingV1Api.md#create_namespaced_horizontal_pod_autoscaler) | **POST** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers |
|
||||
[**delete_collection_namespaced_horizontal_pod_autoscaler**](AutoscalingV1Api.md#delete_collection_namespaced_horizontal_pod_autoscaler) | **DELETE** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers |
|
||||
[**delete_namespaced_horizontal_pod_autoscaler**](AutoscalingV1Api.md#delete_namespaced_horizontal_pod_autoscaler) | **DELETE** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} |
|
||||
[**get_api_resources**](AutoscalingV1Api.md#get_api_resources) | **GET** /apis/autoscaling/v1/ |
|
||||
[**list_horizontal_pod_autoscaler_for_all_namespaces**](AutoscalingV1Api.md#list_horizontal_pod_autoscaler_for_all_namespaces) | **GET** /apis/autoscaling/v1/horizontalpodautoscalers |
|
||||
[**list_namespaced_horizontal_pod_autoscaler**](AutoscalingV1Api.md#list_namespaced_horizontal_pod_autoscaler) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers |
|
||||
[**patch_namespaced_horizontal_pod_autoscaler**](AutoscalingV1Api.md#patch_namespaced_horizontal_pod_autoscaler) | **PATCH** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} |
|
||||
[**patch_namespaced_horizontal_pod_autoscaler_status**](AutoscalingV1Api.md#patch_namespaced_horizontal_pod_autoscaler_status) | **PATCH** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status |
|
||||
[**read_namespaced_horizontal_pod_autoscaler**](AutoscalingV1Api.md#read_namespaced_horizontal_pod_autoscaler) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} |
|
||||
[**read_namespaced_horizontal_pod_autoscaler_status**](AutoscalingV1Api.md#read_namespaced_horizontal_pod_autoscaler_status) | **GET** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status |
|
||||
[**replace_namespaced_horizontal_pod_autoscaler**](AutoscalingV1Api.md#replace_namespaced_horizontal_pod_autoscaler) | **PUT** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} |
|
||||
[**replace_namespaced_horizontal_pod_autoscaler_status**](AutoscalingV1Api.md#replace_namespaced_horizontal_pod_autoscaler_status) | **PUT** /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status |
|
||||
|
||||
|
||||
# **create_namespaced_horizontal_pod_autoscaler**
|
||||
> V1HorizontalPodAutoscaler create_namespaced_horizontal_pod_autoscaler(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create a HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V1HorizontalPodAutoscaler() # V1HorizontalPodAutoscaler |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_namespaced_horizontal_pod_autoscaler(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV1Api->create_namespaced_horizontal_pod_autoscaler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V1HorizontalPodAutoscaler**](V1HorizontalPodAutoscaler.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1HorizontalPodAutoscaler**](V1HorizontalPodAutoscaler.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_namespaced_horizontal_pod_autoscaler**
|
||||
> V1Status delete_collection_namespaced_horizontal_pod_autoscaler(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_namespaced_horizontal_pod_autoscaler(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV1Api->delete_collection_namespaced_horizontal_pod_autoscaler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_namespaced_horizontal_pod_autoscaler**
|
||||
> V1Status delete_namespaced_horizontal_pod_autoscaler(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete a HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV1Api(api_client)
|
||||
name = 'name_example' # str | name of the HorizontalPodAutoscaler
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_namespaced_horizontal_pod_autoscaler(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV1Api->delete_namespaced_horizontal_pod_autoscaler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the HorizontalPodAutoscaler |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_horizontal_pod_autoscaler_for_all_namespaces**
|
||||
> V1HorizontalPodAutoscalerList list_horizontal_pod_autoscaler_for_all_namespaces(allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, pretty=pretty, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV1Api(api_client)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_horizontal_pod_autoscaler_for_all_namespaces(allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, pretty=pretty, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV1Api->list_horizontal_pod_autoscaler_for_all_namespaces: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1HorizontalPodAutoscalerList**](V1HorizontalPodAutoscalerList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_namespaced_horizontal_pod_autoscaler**
|
||||
> V1HorizontalPodAutoscalerList list_namespaced_horizontal_pod_autoscaler(namespace, pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_namespaced_horizontal_pod_autoscaler(namespace, pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV1Api->list_namespaced_horizontal_pod_autoscaler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1HorizontalPodAutoscalerList**](V1HorizontalPodAutoscalerList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_namespaced_horizontal_pod_autoscaler**
|
||||
> V1HorizontalPodAutoscaler patch_namespaced_horizontal_pod_autoscaler(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV1Api(api_client)
|
||||
name = 'name_example' # str | name of the HorizontalPodAutoscaler
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_namespaced_horizontal_pod_autoscaler(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV1Api->patch_namespaced_horizontal_pod_autoscaler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the HorizontalPodAutoscaler |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1HorizontalPodAutoscaler**](V1HorizontalPodAutoscaler.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_namespaced_horizontal_pod_autoscaler_status**
|
||||
> V1HorizontalPodAutoscaler patch_namespaced_horizontal_pod_autoscaler_status(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update status of the specified HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV1Api(api_client)
|
||||
name = 'name_example' # str | name of the HorizontalPodAutoscaler
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_namespaced_horizontal_pod_autoscaler_status(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV1Api->patch_namespaced_horizontal_pod_autoscaler_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the HorizontalPodAutoscaler |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1HorizontalPodAutoscaler**](V1HorizontalPodAutoscaler.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_namespaced_horizontal_pod_autoscaler**
|
||||
> V1HorizontalPodAutoscaler read_namespaced_horizontal_pod_autoscaler(name, namespace, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV1Api(api_client)
|
||||
name = 'name_example' # str | name of the HorizontalPodAutoscaler
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_namespaced_horizontal_pod_autoscaler(name, namespace, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV1Api->read_namespaced_horizontal_pod_autoscaler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the HorizontalPodAutoscaler |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1HorizontalPodAutoscaler**](V1HorizontalPodAutoscaler.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_namespaced_horizontal_pod_autoscaler_status**
|
||||
> V1HorizontalPodAutoscaler read_namespaced_horizontal_pod_autoscaler_status(name, namespace, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read status of the specified HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV1Api(api_client)
|
||||
name = 'name_example' # str | name of the HorizontalPodAutoscaler
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_namespaced_horizontal_pod_autoscaler_status(name, namespace, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV1Api->read_namespaced_horizontal_pod_autoscaler_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the HorizontalPodAutoscaler |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1HorizontalPodAutoscaler**](V1HorizontalPodAutoscaler.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_namespaced_horizontal_pod_autoscaler**
|
||||
> V1HorizontalPodAutoscaler replace_namespaced_horizontal_pod_autoscaler(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV1Api(api_client)
|
||||
name = 'name_example' # str | name of the HorizontalPodAutoscaler
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V1HorizontalPodAutoscaler() # V1HorizontalPodAutoscaler |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_namespaced_horizontal_pod_autoscaler(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV1Api->replace_namespaced_horizontal_pod_autoscaler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the HorizontalPodAutoscaler |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V1HorizontalPodAutoscaler**](V1HorizontalPodAutoscaler.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1HorizontalPodAutoscaler**](V1HorizontalPodAutoscaler.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_namespaced_horizontal_pod_autoscaler_status**
|
||||
> V1HorizontalPodAutoscaler replace_namespaced_horizontal_pod_autoscaler_status(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace status of the specified HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV1Api(api_client)
|
||||
name = 'name_example' # str | name of the HorizontalPodAutoscaler
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V1HorizontalPodAutoscaler() # V1HorizontalPodAutoscaler |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_namespaced_horizontal_pod_autoscaler_status(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV1Api->replace_namespaced_horizontal_pod_autoscaler_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the HorizontalPodAutoscaler |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V1HorizontalPodAutoscaler**](V1HorizontalPodAutoscaler.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1HorizontalPodAutoscaler**](V1HorizontalPodAutoscaler.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
961
kubernetes/docs/AutoscalingV2Api.md
Normal file
961
kubernetes/docs/AutoscalingV2Api.md
Normal file
|
|
@ -0,0 +1,961 @@
|
|||
# kubernetes.client.AutoscalingV2Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_namespaced_horizontal_pod_autoscaler**](AutoscalingV2Api.md#create_namespaced_horizontal_pod_autoscaler) | **POST** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers |
|
||||
[**delete_collection_namespaced_horizontal_pod_autoscaler**](AutoscalingV2Api.md#delete_collection_namespaced_horizontal_pod_autoscaler) | **DELETE** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers |
|
||||
[**delete_namespaced_horizontal_pod_autoscaler**](AutoscalingV2Api.md#delete_namespaced_horizontal_pod_autoscaler) | **DELETE** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} |
|
||||
[**get_api_resources**](AutoscalingV2Api.md#get_api_resources) | **GET** /apis/autoscaling/v2/ |
|
||||
[**list_horizontal_pod_autoscaler_for_all_namespaces**](AutoscalingV2Api.md#list_horizontal_pod_autoscaler_for_all_namespaces) | **GET** /apis/autoscaling/v2/horizontalpodautoscalers |
|
||||
[**list_namespaced_horizontal_pod_autoscaler**](AutoscalingV2Api.md#list_namespaced_horizontal_pod_autoscaler) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers |
|
||||
[**patch_namespaced_horizontal_pod_autoscaler**](AutoscalingV2Api.md#patch_namespaced_horizontal_pod_autoscaler) | **PATCH** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} |
|
||||
[**patch_namespaced_horizontal_pod_autoscaler_status**](AutoscalingV2Api.md#patch_namespaced_horizontal_pod_autoscaler_status) | **PATCH** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status |
|
||||
[**read_namespaced_horizontal_pod_autoscaler**](AutoscalingV2Api.md#read_namespaced_horizontal_pod_autoscaler) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} |
|
||||
[**read_namespaced_horizontal_pod_autoscaler_status**](AutoscalingV2Api.md#read_namespaced_horizontal_pod_autoscaler_status) | **GET** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status |
|
||||
[**replace_namespaced_horizontal_pod_autoscaler**](AutoscalingV2Api.md#replace_namespaced_horizontal_pod_autoscaler) | **PUT** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name} |
|
||||
[**replace_namespaced_horizontal_pod_autoscaler_status**](AutoscalingV2Api.md#replace_namespaced_horizontal_pod_autoscaler_status) | **PUT** /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status |
|
||||
|
||||
|
||||
# **create_namespaced_horizontal_pod_autoscaler**
|
||||
> V2HorizontalPodAutoscaler create_namespaced_horizontal_pod_autoscaler(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create a HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV2Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V2HorizontalPodAutoscaler() # V2HorizontalPodAutoscaler |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_namespaced_horizontal_pod_autoscaler(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV2Api->create_namespaced_horizontal_pod_autoscaler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V2HorizontalPodAutoscaler**](V2HorizontalPodAutoscaler.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V2HorizontalPodAutoscaler**](V2HorizontalPodAutoscaler.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_namespaced_horizontal_pod_autoscaler**
|
||||
> V1Status delete_collection_namespaced_horizontal_pod_autoscaler(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV2Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_namespaced_horizontal_pod_autoscaler(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV2Api->delete_collection_namespaced_horizontal_pod_autoscaler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_namespaced_horizontal_pod_autoscaler**
|
||||
> V1Status delete_namespaced_horizontal_pod_autoscaler(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete a HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV2Api(api_client)
|
||||
name = 'name_example' # str | name of the HorizontalPodAutoscaler
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_namespaced_horizontal_pod_autoscaler(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV2Api->delete_namespaced_horizontal_pod_autoscaler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the HorizontalPodAutoscaler |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV2Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV2Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_horizontal_pod_autoscaler_for_all_namespaces**
|
||||
> V2HorizontalPodAutoscalerList list_horizontal_pod_autoscaler_for_all_namespaces(allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, pretty=pretty, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV2Api(api_client)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_horizontal_pod_autoscaler_for_all_namespaces(allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, pretty=pretty, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV2Api->list_horizontal_pod_autoscaler_for_all_namespaces: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V2HorizontalPodAutoscalerList**](V2HorizontalPodAutoscalerList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_namespaced_horizontal_pod_autoscaler**
|
||||
> V2HorizontalPodAutoscalerList list_namespaced_horizontal_pod_autoscaler(namespace, pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV2Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_namespaced_horizontal_pod_autoscaler(namespace, pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV2Api->list_namespaced_horizontal_pod_autoscaler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V2HorizontalPodAutoscalerList**](V2HorizontalPodAutoscalerList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_namespaced_horizontal_pod_autoscaler**
|
||||
> V2HorizontalPodAutoscaler patch_namespaced_horizontal_pod_autoscaler(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV2Api(api_client)
|
||||
name = 'name_example' # str | name of the HorizontalPodAutoscaler
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_namespaced_horizontal_pod_autoscaler(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV2Api->patch_namespaced_horizontal_pod_autoscaler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the HorizontalPodAutoscaler |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V2HorizontalPodAutoscaler**](V2HorizontalPodAutoscaler.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_namespaced_horizontal_pod_autoscaler_status**
|
||||
> V2HorizontalPodAutoscaler patch_namespaced_horizontal_pod_autoscaler_status(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update status of the specified HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV2Api(api_client)
|
||||
name = 'name_example' # str | name of the HorizontalPodAutoscaler
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_namespaced_horizontal_pod_autoscaler_status(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV2Api->patch_namespaced_horizontal_pod_autoscaler_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the HorizontalPodAutoscaler |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V2HorizontalPodAutoscaler**](V2HorizontalPodAutoscaler.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_namespaced_horizontal_pod_autoscaler**
|
||||
> V2HorizontalPodAutoscaler read_namespaced_horizontal_pod_autoscaler(name, namespace, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV2Api(api_client)
|
||||
name = 'name_example' # str | name of the HorizontalPodAutoscaler
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_namespaced_horizontal_pod_autoscaler(name, namespace, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV2Api->read_namespaced_horizontal_pod_autoscaler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the HorizontalPodAutoscaler |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V2HorizontalPodAutoscaler**](V2HorizontalPodAutoscaler.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_namespaced_horizontal_pod_autoscaler_status**
|
||||
> V2HorizontalPodAutoscaler read_namespaced_horizontal_pod_autoscaler_status(name, namespace, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read status of the specified HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV2Api(api_client)
|
||||
name = 'name_example' # str | name of the HorizontalPodAutoscaler
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_namespaced_horizontal_pod_autoscaler_status(name, namespace, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV2Api->read_namespaced_horizontal_pod_autoscaler_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the HorizontalPodAutoscaler |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V2HorizontalPodAutoscaler**](V2HorizontalPodAutoscaler.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_namespaced_horizontal_pod_autoscaler**
|
||||
> V2HorizontalPodAutoscaler replace_namespaced_horizontal_pod_autoscaler(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV2Api(api_client)
|
||||
name = 'name_example' # str | name of the HorizontalPodAutoscaler
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V2HorizontalPodAutoscaler() # V2HorizontalPodAutoscaler |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_namespaced_horizontal_pod_autoscaler(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV2Api->replace_namespaced_horizontal_pod_autoscaler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the HorizontalPodAutoscaler |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V2HorizontalPodAutoscaler**](V2HorizontalPodAutoscaler.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V2HorizontalPodAutoscaler**](V2HorizontalPodAutoscaler.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_namespaced_horizontal_pod_autoscaler_status**
|
||||
> V2HorizontalPodAutoscaler replace_namespaced_horizontal_pod_autoscaler_status(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace status of the specified HorizontalPodAutoscaler
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.AutoscalingV2Api(api_client)
|
||||
name = 'name_example' # str | name of the HorizontalPodAutoscaler
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V2HorizontalPodAutoscaler() # V2HorizontalPodAutoscaler |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_namespaced_horizontal_pod_autoscaler_status(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling AutoscalingV2Api->replace_namespaced_horizontal_pod_autoscaler_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the HorizontalPodAutoscaler |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V2HorizontalPodAutoscaler**](V2HorizontalPodAutoscaler.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V2HorizontalPodAutoscaler**](V2HorizontalPodAutoscaler.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
70
kubernetes/docs/BatchApi.md
Normal file
70
kubernetes/docs/BatchApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.BatchApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](BatchApi.md#get_api_group) | **GET** /apis/batch/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.BatchApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling BatchApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
1852
kubernetes/docs/BatchV1Api.md
Normal file
1852
kubernetes/docs/BatchV1Api.md
Normal file
File diff suppressed because it is too large
Load diff
70
kubernetes/docs/CertificatesApi.md
Normal file
70
kubernetes/docs/CertificatesApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.CertificatesApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](CertificatesApi.md#get_api_group) | **GET** /apis/certificates.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CertificatesApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CertificatesApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
1079
kubernetes/docs/CertificatesV1Api.md
Normal file
1079
kubernetes/docs/CertificatesV1Api.md
Normal file
File diff suppressed because it is too large
Load diff
631
kubernetes/docs/CertificatesV1alpha1Api.md
Normal file
631
kubernetes/docs/CertificatesV1alpha1Api.md
Normal file
|
|
@ -0,0 +1,631 @@
|
|||
# kubernetes.client.CertificatesV1alpha1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_cluster_trust_bundle**](CertificatesV1alpha1Api.md#create_cluster_trust_bundle) | **POST** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles |
|
||||
[**delete_cluster_trust_bundle**](CertificatesV1alpha1Api.md#delete_cluster_trust_bundle) | **DELETE** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} |
|
||||
[**delete_collection_cluster_trust_bundle**](CertificatesV1alpha1Api.md#delete_collection_cluster_trust_bundle) | **DELETE** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles |
|
||||
[**get_api_resources**](CertificatesV1alpha1Api.md#get_api_resources) | **GET** /apis/certificates.k8s.io/v1alpha1/ |
|
||||
[**list_cluster_trust_bundle**](CertificatesV1alpha1Api.md#list_cluster_trust_bundle) | **GET** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles |
|
||||
[**patch_cluster_trust_bundle**](CertificatesV1alpha1Api.md#patch_cluster_trust_bundle) | **PATCH** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} |
|
||||
[**read_cluster_trust_bundle**](CertificatesV1alpha1Api.md#read_cluster_trust_bundle) | **GET** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} |
|
||||
[**replace_cluster_trust_bundle**](CertificatesV1alpha1Api.md#replace_cluster_trust_bundle) | **PUT** /apis/certificates.k8s.io/v1alpha1/clustertrustbundles/{name} |
|
||||
|
||||
|
||||
# **create_cluster_trust_bundle**
|
||||
> V1alpha1ClusterTrustBundle create_cluster_trust_bundle(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create a ClusterTrustBundle
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CertificatesV1alpha1Api(api_client)
|
||||
body = kubernetes.client.V1alpha1ClusterTrustBundle() # V1alpha1ClusterTrustBundle |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_cluster_trust_bundle(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CertificatesV1alpha1Api->create_cluster_trust_bundle: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1alpha1ClusterTrustBundle**](V1alpha1ClusterTrustBundle.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1ClusterTrustBundle**](V1alpha1ClusterTrustBundle.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_cluster_trust_bundle**
|
||||
> V1Status delete_cluster_trust_bundle(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete a ClusterTrustBundle
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CertificatesV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the ClusterTrustBundle
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_cluster_trust_bundle(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CertificatesV1alpha1Api->delete_cluster_trust_bundle: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the ClusterTrustBundle |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_cluster_trust_bundle**
|
||||
> V1Status delete_collection_cluster_trust_bundle(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of ClusterTrustBundle
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CertificatesV1alpha1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_cluster_trust_bundle(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CertificatesV1alpha1Api->delete_collection_cluster_trust_bundle: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CertificatesV1alpha1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CertificatesV1alpha1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_cluster_trust_bundle**
|
||||
> V1alpha1ClusterTrustBundleList list_cluster_trust_bundle(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind ClusterTrustBundle
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CertificatesV1alpha1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_cluster_trust_bundle(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CertificatesV1alpha1Api->list_cluster_trust_bundle: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1ClusterTrustBundleList**](V1alpha1ClusterTrustBundleList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_cluster_trust_bundle**
|
||||
> V1alpha1ClusterTrustBundle patch_cluster_trust_bundle(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified ClusterTrustBundle
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CertificatesV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the ClusterTrustBundle
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_cluster_trust_bundle(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CertificatesV1alpha1Api->patch_cluster_trust_bundle: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the ClusterTrustBundle |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1ClusterTrustBundle**](V1alpha1ClusterTrustBundle.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_cluster_trust_bundle**
|
||||
> V1alpha1ClusterTrustBundle read_cluster_trust_bundle(name, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified ClusterTrustBundle
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CertificatesV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the ClusterTrustBundle
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_cluster_trust_bundle(name, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CertificatesV1alpha1Api->read_cluster_trust_bundle: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the ClusterTrustBundle |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1ClusterTrustBundle**](V1alpha1ClusterTrustBundle.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_cluster_trust_bundle**
|
||||
> V1alpha1ClusterTrustBundle replace_cluster_trust_bundle(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified ClusterTrustBundle
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CertificatesV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the ClusterTrustBundle
|
||||
body = kubernetes.client.V1alpha1ClusterTrustBundle() # V1alpha1ClusterTrustBundle |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_cluster_trust_bundle(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CertificatesV1alpha1Api->replace_cluster_trust_bundle: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the ClusterTrustBundle |
|
||||
**body** | [**V1alpha1ClusterTrustBundle**](V1alpha1ClusterTrustBundle.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1ClusterTrustBundle**](V1alpha1ClusterTrustBundle.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
70
kubernetes/docs/CoordinationApi.md
Normal file
70
kubernetes/docs/CoordinationApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.CoordinationApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](CoordinationApi.md#get_api_group) | **GET** /apis/coordination.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
731
kubernetes/docs/CoordinationV1Api.md
Normal file
731
kubernetes/docs/CoordinationV1Api.md
Normal file
|
|
@ -0,0 +1,731 @@
|
|||
# kubernetes.client.CoordinationV1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_namespaced_lease**](CoordinationV1Api.md#create_namespaced_lease) | **POST** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases |
|
||||
[**delete_collection_namespaced_lease**](CoordinationV1Api.md#delete_collection_namespaced_lease) | **DELETE** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases |
|
||||
[**delete_namespaced_lease**](CoordinationV1Api.md#delete_namespaced_lease) | **DELETE** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} |
|
||||
[**get_api_resources**](CoordinationV1Api.md#get_api_resources) | **GET** /apis/coordination.k8s.io/v1/ |
|
||||
[**list_lease_for_all_namespaces**](CoordinationV1Api.md#list_lease_for_all_namespaces) | **GET** /apis/coordination.k8s.io/v1/leases |
|
||||
[**list_namespaced_lease**](CoordinationV1Api.md#list_namespaced_lease) | **GET** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases |
|
||||
[**patch_namespaced_lease**](CoordinationV1Api.md#patch_namespaced_lease) | **PATCH** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} |
|
||||
[**read_namespaced_lease**](CoordinationV1Api.md#read_namespaced_lease) | **GET** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} |
|
||||
[**replace_namespaced_lease**](CoordinationV1Api.md#replace_namespaced_lease) | **PUT** /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name} |
|
||||
|
||||
|
||||
# **create_namespaced_lease**
|
||||
> V1Lease create_namespaced_lease(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create a Lease
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V1Lease() # V1Lease |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_namespaced_lease(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1Api->create_namespaced_lease: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V1Lease**](V1Lease.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Lease**](V1Lease.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_namespaced_lease**
|
||||
> V1Status delete_collection_namespaced_lease(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of Lease
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_namespaced_lease(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1Api->delete_collection_namespaced_lease: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_namespaced_lease**
|
||||
> V1Status delete_namespaced_lease(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete a Lease
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1Api(api_client)
|
||||
name = 'name_example' # str | name of the Lease
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_namespaced_lease(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1Api->delete_namespaced_lease: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the Lease |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_lease_for_all_namespaces**
|
||||
> V1LeaseList list_lease_for_all_namespaces(allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, pretty=pretty, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind Lease
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1Api(api_client)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_lease_for_all_namespaces(allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, pretty=pretty, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1Api->list_lease_for_all_namespaces: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1LeaseList**](V1LeaseList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_namespaced_lease**
|
||||
> V1LeaseList list_namespaced_lease(namespace, pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind Lease
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_namespaced_lease(namespace, pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1Api->list_namespaced_lease: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1LeaseList**](V1LeaseList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_namespaced_lease**
|
||||
> V1Lease patch_namespaced_lease(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified Lease
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1Api(api_client)
|
||||
name = 'name_example' # str | name of the Lease
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_namespaced_lease(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1Api->patch_namespaced_lease: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the Lease |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Lease**](V1Lease.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_namespaced_lease**
|
||||
> V1Lease read_namespaced_lease(name, namespace, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified Lease
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1Api(api_client)
|
||||
name = 'name_example' # str | name of the Lease
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_namespaced_lease(name, namespace, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1Api->read_namespaced_lease: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the Lease |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Lease**](V1Lease.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_namespaced_lease**
|
||||
> V1Lease replace_namespaced_lease(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified Lease
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1Api(api_client)
|
||||
name = 'name_example' # str | name of the Lease
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V1Lease() # V1Lease |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_namespaced_lease(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1Api->replace_namespaced_lease: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the Lease |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V1Lease**](V1Lease.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Lease**](V1Lease.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
731
kubernetes/docs/CoordinationV1alpha2Api.md
Normal file
731
kubernetes/docs/CoordinationV1alpha2Api.md
Normal file
|
|
@ -0,0 +1,731 @@
|
|||
# kubernetes.client.CoordinationV1alpha2Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_namespaced_lease_candidate**](CoordinationV1alpha2Api.md#create_namespaced_lease_candidate) | **POST** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates |
|
||||
[**delete_collection_namespaced_lease_candidate**](CoordinationV1alpha2Api.md#delete_collection_namespaced_lease_candidate) | **DELETE** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates |
|
||||
[**delete_namespaced_lease_candidate**](CoordinationV1alpha2Api.md#delete_namespaced_lease_candidate) | **DELETE** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} |
|
||||
[**get_api_resources**](CoordinationV1alpha2Api.md#get_api_resources) | **GET** /apis/coordination.k8s.io/v1alpha2/ |
|
||||
[**list_lease_candidate_for_all_namespaces**](CoordinationV1alpha2Api.md#list_lease_candidate_for_all_namespaces) | **GET** /apis/coordination.k8s.io/v1alpha2/leasecandidates |
|
||||
[**list_namespaced_lease_candidate**](CoordinationV1alpha2Api.md#list_namespaced_lease_candidate) | **GET** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates |
|
||||
[**patch_namespaced_lease_candidate**](CoordinationV1alpha2Api.md#patch_namespaced_lease_candidate) | **PATCH** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} |
|
||||
[**read_namespaced_lease_candidate**](CoordinationV1alpha2Api.md#read_namespaced_lease_candidate) | **GET** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} |
|
||||
[**replace_namespaced_lease_candidate**](CoordinationV1alpha2Api.md#replace_namespaced_lease_candidate) | **PUT** /apis/coordination.k8s.io/v1alpha2/namespaces/{namespace}/leasecandidates/{name} |
|
||||
|
||||
|
||||
# **create_namespaced_lease_candidate**
|
||||
> V1alpha2LeaseCandidate create_namespaced_lease_candidate(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create a LeaseCandidate
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1alpha2Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V1alpha2LeaseCandidate() # V1alpha2LeaseCandidate |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_namespaced_lease_candidate(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1alpha2Api->create_namespaced_lease_candidate: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V1alpha2LeaseCandidate**](V1alpha2LeaseCandidate.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha2LeaseCandidate**](V1alpha2LeaseCandidate.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_namespaced_lease_candidate**
|
||||
> V1Status delete_collection_namespaced_lease_candidate(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of LeaseCandidate
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1alpha2Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_namespaced_lease_candidate(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1alpha2Api->delete_collection_namespaced_lease_candidate: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_namespaced_lease_candidate**
|
||||
> V1Status delete_namespaced_lease_candidate(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete a LeaseCandidate
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1alpha2Api(api_client)
|
||||
name = 'name_example' # str | name of the LeaseCandidate
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_namespaced_lease_candidate(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1alpha2Api->delete_namespaced_lease_candidate: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the LeaseCandidate |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1alpha2Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1alpha2Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_lease_candidate_for_all_namespaces**
|
||||
> V1alpha2LeaseCandidateList list_lease_candidate_for_all_namespaces(allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, pretty=pretty, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind LeaseCandidate
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1alpha2Api(api_client)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_lease_candidate_for_all_namespaces(allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, pretty=pretty, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1alpha2Api->list_lease_candidate_for_all_namespaces: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha2LeaseCandidateList**](V1alpha2LeaseCandidateList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_namespaced_lease_candidate**
|
||||
> V1alpha2LeaseCandidateList list_namespaced_lease_candidate(namespace, pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind LeaseCandidate
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1alpha2Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_namespaced_lease_candidate(namespace, pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1alpha2Api->list_namespaced_lease_candidate: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha2LeaseCandidateList**](V1alpha2LeaseCandidateList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_namespaced_lease_candidate**
|
||||
> V1alpha2LeaseCandidate patch_namespaced_lease_candidate(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified LeaseCandidate
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1alpha2Api(api_client)
|
||||
name = 'name_example' # str | name of the LeaseCandidate
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_namespaced_lease_candidate(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1alpha2Api->patch_namespaced_lease_candidate: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the LeaseCandidate |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha2LeaseCandidate**](V1alpha2LeaseCandidate.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_namespaced_lease_candidate**
|
||||
> V1alpha2LeaseCandidate read_namespaced_lease_candidate(name, namespace, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified LeaseCandidate
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1alpha2Api(api_client)
|
||||
name = 'name_example' # str | name of the LeaseCandidate
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_namespaced_lease_candidate(name, namespace, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1alpha2Api->read_namespaced_lease_candidate: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the LeaseCandidate |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha2LeaseCandidate**](V1alpha2LeaseCandidate.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_namespaced_lease_candidate**
|
||||
> V1alpha2LeaseCandidate replace_namespaced_lease_candidate(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified LeaseCandidate
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoordinationV1alpha2Api(api_client)
|
||||
name = 'name_example' # str | name of the LeaseCandidate
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V1alpha2LeaseCandidate() # V1alpha2LeaseCandidate |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_namespaced_lease_candidate(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoordinationV1alpha2Api->replace_namespaced_lease_candidate: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the LeaseCandidate |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V1alpha2LeaseCandidate**](V1alpha2LeaseCandidate.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha2LeaseCandidate**](V1alpha2LeaseCandidate.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
70
kubernetes/docs/CoreApi.md
Normal file
70
kubernetes/docs/CoreApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.CoreApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_versions**](CoreApi.md#get_api_versions) | **GET** /api/ |
|
||||
|
||||
|
||||
# **get_api_versions**
|
||||
> V1APIVersions get_api_versions()
|
||||
|
||||
|
||||
|
||||
get available API versions
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.CoreApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_versions()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling CoreApi->get_api_versions: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIVersions**](V1APIVersions.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
16150
kubernetes/docs/CoreV1Api.md
Normal file
16150
kubernetes/docs/CoreV1Api.md
Normal file
File diff suppressed because it is too large
Load diff
14
kubernetes/docs/CoreV1EndpointPort.md
Normal file
14
kubernetes/docs/CoreV1EndpointPort.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# CoreV1EndpointPort
|
||||
|
||||
EndpointPort is a tuple that describes a single port.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**app_protocol** | **str** | The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either: * Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). * Kubernetes-defined prefixed names: * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 * Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol. | [optional]
|
||||
**name** | **str** | The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined. | [optional]
|
||||
**port** | **int** | The port number of the endpoint. |
|
||||
**protocol** | **str** | The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
27
kubernetes/docs/CoreV1Event.md
Normal file
27
kubernetes/docs/CoreV1Event.md
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
# CoreV1Event
|
||||
|
||||
Event is a report of an event somewhere in the cluster. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**action** | **str** | What action was taken/failed regarding to the Regarding object. | [optional]
|
||||
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
|
||||
**count** | **int** | The number of times this event has occurred. | [optional]
|
||||
**event_time** | **datetime** | Time when this Event was first observed. | [optional]
|
||||
**first_timestamp** | **datetime** | The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) | [optional]
|
||||
**involved_object** | [**V1ObjectReference**](V1ObjectReference.md) | |
|
||||
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the kubernetes.client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
|
||||
**last_timestamp** | **datetime** | The time at which the most recent occurrence of this event was recorded. | [optional]
|
||||
**message** | **str** | A human-readable description of the status of this operation. | [optional]
|
||||
**metadata** | [**V1ObjectMeta**](V1ObjectMeta.md) | |
|
||||
**reason** | **str** | This should be a short, machine understandable string that gives the reason for the transition into the object's current status. | [optional]
|
||||
**related** | [**V1ObjectReference**](V1ObjectReference.md) | | [optional]
|
||||
**reporting_component** | **str** | Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. | [optional]
|
||||
**reporting_instance** | **str** | ID of the controller instance, e.g. `kubelet-xyzf`. | [optional]
|
||||
**series** | [**CoreV1EventSeries**](CoreV1EventSeries.md) | | [optional]
|
||||
**source** | [**V1EventSource**](V1EventSource.md) | | [optional]
|
||||
**type** | **str** | Type of this event (Normal, Warning), new types could be added in the future | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
kubernetes/docs/CoreV1EventList.md
Normal file
14
kubernetes/docs/CoreV1EventList.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# CoreV1EventList
|
||||
|
||||
EventList is a list of events.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
|
||||
**items** | [**list[CoreV1Event]**](CoreV1Event.md) | List of events |
|
||||
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the kubernetes.client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
|
||||
**metadata** | [**V1ListMeta**](V1ListMeta.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
12
kubernetes/docs/CoreV1EventSeries.md
Normal file
12
kubernetes/docs/CoreV1EventSeries.md
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# CoreV1EventSeries
|
||||
|
||||
EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**count** | **int** | Number of occurrences in this series up to the last heartbeat time | [optional]
|
||||
**last_observed_time** | **datetime** | Time of the last occurrence observed | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
2274
kubernetes/docs/CustomObjectsApi.md
Normal file
2274
kubernetes/docs/CustomObjectsApi.md
Normal file
File diff suppressed because it is too large
Load diff
70
kubernetes/docs/DiscoveryApi.md
Normal file
70
kubernetes/docs/DiscoveryApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.DiscoveryApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](DiscoveryApi.md#get_api_group) | **GET** /apis/discovery.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.DiscoveryApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling DiscoveryApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
731
kubernetes/docs/DiscoveryV1Api.md
Normal file
731
kubernetes/docs/DiscoveryV1Api.md
Normal file
|
|
@ -0,0 +1,731 @@
|
|||
# kubernetes.client.DiscoveryV1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_namespaced_endpoint_slice**](DiscoveryV1Api.md#create_namespaced_endpoint_slice) | **POST** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices |
|
||||
[**delete_collection_namespaced_endpoint_slice**](DiscoveryV1Api.md#delete_collection_namespaced_endpoint_slice) | **DELETE** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices |
|
||||
[**delete_namespaced_endpoint_slice**](DiscoveryV1Api.md#delete_namespaced_endpoint_slice) | **DELETE** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} |
|
||||
[**get_api_resources**](DiscoveryV1Api.md#get_api_resources) | **GET** /apis/discovery.k8s.io/v1/ |
|
||||
[**list_endpoint_slice_for_all_namespaces**](DiscoveryV1Api.md#list_endpoint_slice_for_all_namespaces) | **GET** /apis/discovery.k8s.io/v1/endpointslices |
|
||||
[**list_namespaced_endpoint_slice**](DiscoveryV1Api.md#list_namespaced_endpoint_slice) | **GET** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices |
|
||||
[**patch_namespaced_endpoint_slice**](DiscoveryV1Api.md#patch_namespaced_endpoint_slice) | **PATCH** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} |
|
||||
[**read_namespaced_endpoint_slice**](DiscoveryV1Api.md#read_namespaced_endpoint_slice) | **GET** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} |
|
||||
[**replace_namespaced_endpoint_slice**](DiscoveryV1Api.md#replace_namespaced_endpoint_slice) | **PUT** /apis/discovery.k8s.io/v1/namespaces/{namespace}/endpointslices/{name} |
|
||||
|
||||
|
||||
# **create_namespaced_endpoint_slice**
|
||||
> V1EndpointSlice create_namespaced_endpoint_slice(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create an EndpointSlice
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.DiscoveryV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V1EndpointSlice() # V1EndpointSlice |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_namespaced_endpoint_slice(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling DiscoveryV1Api->create_namespaced_endpoint_slice: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V1EndpointSlice**](V1EndpointSlice.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1EndpointSlice**](V1EndpointSlice.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_namespaced_endpoint_slice**
|
||||
> V1Status delete_collection_namespaced_endpoint_slice(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of EndpointSlice
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.DiscoveryV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_namespaced_endpoint_slice(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling DiscoveryV1Api->delete_collection_namespaced_endpoint_slice: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_namespaced_endpoint_slice**
|
||||
> V1Status delete_namespaced_endpoint_slice(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete an EndpointSlice
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.DiscoveryV1Api(api_client)
|
||||
name = 'name_example' # str | name of the EndpointSlice
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_namespaced_endpoint_slice(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling DiscoveryV1Api->delete_namespaced_endpoint_slice: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the EndpointSlice |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.DiscoveryV1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling DiscoveryV1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_endpoint_slice_for_all_namespaces**
|
||||
> V1EndpointSliceList list_endpoint_slice_for_all_namespaces(allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, pretty=pretty, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind EndpointSlice
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.DiscoveryV1Api(api_client)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_endpoint_slice_for_all_namespaces(allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, pretty=pretty, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling DiscoveryV1Api->list_endpoint_slice_for_all_namespaces: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1EndpointSliceList**](V1EndpointSliceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_namespaced_endpoint_slice**
|
||||
> V1EndpointSliceList list_namespaced_endpoint_slice(namespace, pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind EndpointSlice
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.DiscoveryV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_namespaced_endpoint_slice(namespace, pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling DiscoveryV1Api->list_namespaced_endpoint_slice: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1EndpointSliceList**](V1EndpointSliceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_namespaced_endpoint_slice**
|
||||
> V1EndpointSlice patch_namespaced_endpoint_slice(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified EndpointSlice
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.DiscoveryV1Api(api_client)
|
||||
name = 'name_example' # str | name of the EndpointSlice
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_namespaced_endpoint_slice(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling DiscoveryV1Api->patch_namespaced_endpoint_slice: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the EndpointSlice |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1EndpointSlice**](V1EndpointSlice.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_namespaced_endpoint_slice**
|
||||
> V1EndpointSlice read_namespaced_endpoint_slice(name, namespace, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified EndpointSlice
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.DiscoveryV1Api(api_client)
|
||||
name = 'name_example' # str | name of the EndpointSlice
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_namespaced_endpoint_slice(name, namespace, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling DiscoveryV1Api->read_namespaced_endpoint_slice: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the EndpointSlice |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1EndpointSlice**](V1EndpointSlice.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_namespaced_endpoint_slice**
|
||||
> V1EndpointSlice replace_namespaced_endpoint_slice(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified EndpointSlice
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.DiscoveryV1Api(api_client)
|
||||
name = 'name_example' # str | name of the EndpointSlice
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V1EndpointSlice() # V1EndpointSlice |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_namespaced_endpoint_slice(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling DiscoveryV1Api->replace_namespaced_endpoint_slice: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the EndpointSlice |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V1EndpointSlice**](V1EndpointSlice.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1EndpointSlice**](V1EndpointSlice.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
14
kubernetes/docs/DiscoveryV1EndpointPort.md
Normal file
14
kubernetes/docs/DiscoveryV1EndpointPort.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# DiscoveryV1EndpointPort
|
||||
|
||||
EndpointPort represents a Port used by an EndpointSlice
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**app_protocol** | **str** | The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either: * Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). * Kubernetes-defined prefixed names: * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 * Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol. | [optional]
|
||||
**name** | **str** | name represents the name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is derived from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string. | [optional]
|
||||
**port** | **int** | port represents the port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer. | [optional]
|
||||
**protocol** | **str** | protocol represents the IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
70
kubernetes/docs/EventsApi.md
Normal file
70
kubernetes/docs/EventsApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.EventsApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](EventsApi.md#get_api_group) | **GET** /apis/events.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.EventsApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling EventsApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
731
kubernetes/docs/EventsV1Api.md
Normal file
731
kubernetes/docs/EventsV1Api.md
Normal file
|
|
@ -0,0 +1,731 @@
|
|||
# kubernetes.client.EventsV1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_namespaced_event**](EventsV1Api.md#create_namespaced_event) | **POST** /apis/events.k8s.io/v1/namespaces/{namespace}/events |
|
||||
[**delete_collection_namespaced_event**](EventsV1Api.md#delete_collection_namespaced_event) | **DELETE** /apis/events.k8s.io/v1/namespaces/{namespace}/events |
|
||||
[**delete_namespaced_event**](EventsV1Api.md#delete_namespaced_event) | **DELETE** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} |
|
||||
[**get_api_resources**](EventsV1Api.md#get_api_resources) | **GET** /apis/events.k8s.io/v1/ |
|
||||
[**list_event_for_all_namespaces**](EventsV1Api.md#list_event_for_all_namespaces) | **GET** /apis/events.k8s.io/v1/events |
|
||||
[**list_namespaced_event**](EventsV1Api.md#list_namespaced_event) | **GET** /apis/events.k8s.io/v1/namespaces/{namespace}/events |
|
||||
[**patch_namespaced_event**](EventsV1Api.md#patch_namespaced_event) | **PATCH** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} |
|
||||
[**read_namespaced_event**](EventsV1Api.md#read_namespaced_event) | **GET** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} |
|
||||
[**replace_namespaced_event**](EventsV1Api.md#replace_namespaced_event) | **PUT** /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name} |
|
||||
|
||||
|
||||
# **create_namespaced_event**
|
||||
> EventsV1Event create_namespaced_event(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create an Event
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.EventsV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.EventsV1Event() # EventsV1Event |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_namespaced_event(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling EventsV1Api->create_namespaced_event: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**EventsV1Event**](EventsV1Event.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**EventsV1Event**](EventsV1Event.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_namespaced_event**
|
||||
> V1Status delete_collection_namespaced_event(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of Event
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.EventsV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_namespaced_event(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling EventsV1Api->delete_collection_namespaced_event: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_namespaced_event**
|
||||
> V1Status delete_namespaced_event(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete an Event
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.EventsV1Api(api_client)
|
||||
name = 'name_example' # str | name of the Event
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_namespaced_event(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling EventsV1Api->delete_namespaced_event: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the Event |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.EventsV1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling EventsV1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_event_for_all_namespaces**
|
||||
> EventsV1EventList list_event_for_all_namespaces(allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, pretty=pretty, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind Event
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.EventsV1Api(api_client)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_event_for_all_namespaces(allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, pretty=pretty, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling EventsV1Api->list_event_for_all_namespaces: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**EventsV1EventList**](EventsV1EventList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_namespaced_event**
|
||||
> EventsV1EventList list_namespaced_event(namespace, pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind Event
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.EventsV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_namespaced_event(namespace, pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling EventsV1Api->list_namespaced_event: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**EventsV1EventList**](EventsV1EventList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_namespaced_event**
|
||||
> EventsV1Event patch_namespaced_event(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified Event
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.EventsV1Api(api_client)
|
||||
name = 'name_example' # str | name of the Event
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_namespaced_event(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling EventsV1Api->patch_namespaced_event: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the Event |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**EventsV1Event**](EventsV1Event.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_namespaced_event**
|
||||
> EventsV1Event read_namespaced_event(name, namespace, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified Event
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.EventsV1Api(api_client)
|
||||
name = 'name_example' # str | name of the Event
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_namespaced_event(name, namespace, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling EventsV1Api->read_namespaced_event: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the Event |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**EventsV1Event**](EventsV1Event.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_namespaced_event**
|
||||
> EventsV1Event replace_namespaced_event(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified Event
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.EventsV1Api(api_client)
|
||||
name = 'name_example' # str | name of the Event
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.EventsV1Event() # EventsV1Event |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_namespaced_event(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling EventsV1Api->replace_namespaced_event: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the Event |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**EventsV1Event**](EventsV1Event.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**EventsV1Event**](EventsV1Event.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
27
kubernetes/docs/EventsV1Event.md
Normal file
27
kubernetes/docs/EventsV1Event.md
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
# EventsV1Event
|
||||
|
||||
Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**action** | **str** | action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters. | [optional]
|
||||
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
|
||||
**deprecated_count** | **int** | deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. | [optional]
|
||||
**deprecated_first_timestamp** | **datetime** | deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. | [optional]
|
||||
**deprecated_last_timestamp** | **datetime** | deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. | [optional]
|
||||
**deprecated_source** | [**V1EventSource**](V1EventSource.md) | | [optional]
|
||||
**event_time** | **datetime** | eventTime is the time when this Event was first observed. It is required. |
|
||||
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the kubernetes.client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
|
||||
**metadata** | [**V1ObjectMeta**](V1ObjectMeta.md) | | [optional]
|
||||
**note** | **str** | note is a human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB. | [optional]
|
||||
**reason** | **str** | reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters. | [optional]
|
||||
**regarding** | [**V1ObjectReference**](V1ObjectReference.md) | | [optional]
|
||||
**related** | [**V1ObjectReference**](V1ObjectReference.md) | | [optional]
|
||||
**reporting_controller** | **str** | reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events. | [optional]
|
||||
**reporting_instance** | **str** | reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters. | [optional]
|
||||
**series** | [**EventsV1EventSeries**](EventsV1EventSeries.md) | | [optional]
|
||||
**type** | **str** | type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. This field cannot be empty for new Events. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
kubernetes/docs/EventsV1EventList.md
Normal file
14
kubernetes/docs/EventsV1EventList.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# EventsV1EventList
|
||||
|
||||
EventList is a list of Event objects.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
|
||||
**items** | [**list[EventsV1Event]**](EventsV1Event.md) | items is a list of schema objects. |
|
||||
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the kubernetes.client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
|
||||
**metadata** | [**V1ListMeta**](V1ListMeta.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
12
kubernetes/docs/EventsV1EventSeries.md
Normal file
12
kubernetes/docs/EventsV1EventSeries.md
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# EventsV1EventSeries
|
||||
|
||||
EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. How often to update the EventSeries is up to the event reporters. The default event reporter in \"k8s.io/kubernetes.client-go/tools/events/event_broadcaster.go\" shows how this struct is updated on heartbeats and can guide customized reporter implementations.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**count** | **int** | count is the number of occurrences in this series up to the last heartbeat time. |
|
||||
**last_observed_time** | **datetime** | lastObservedTime is the time when last Event from the series was seen before last heartbeat. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
70
kubernetes/docs/FlowcontrolApiserverApi.md
Normal file
70
kubernetes/docs/FlowcontrolApiserverApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.FlowcontrolApiserverApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](FlowcontrolApiserverApi.md#get_api_group) | **GET** /apis/flowcontrol.apiserver.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.FlowcontrolApiserverApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling FlowcontrolApiserverApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
1640
kubernetes/docs/FlowcontrolApiserverV1Api.md
Normal file
1640
kubernetes/docs/FlowcontrolApiserverV1Api.md
Normal file
File diff suppressed because it is too large
Load diff
14
kubernetes/docs/FlowcontrolV1Subject.md
Normal file
14
kubernetes/docs/FlowcontrolV1Subject.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# FlowcontrolV1Subject
|
||||
|
||||
Subject matches the originator of a request, as identified by the request authentication system. There are three ways of matching an originator; by user, group, or service account.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**group** | [**V1GroupSubject**](V1GroupSubject.md) | | [optional]
|
||||
**kind** | **str** | `kind` indicates which one of the other fields is non-empty. Required |
|
||||
**service_account** | [**V1ServiceAccountSubject**](V1ServiceAccountSubject.md) | | [optional]
|
||||
**user** | [**V1UserSubject**](V1UserSubject.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
70
kubernetes/docs/InternalApiserverApi.md
Normal file
70
kubernetes/docs/InternalApiserverApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.InternalApiserverApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](InternalApiserverApi.md#get_api_group) | **GET** /apis/internal.apiserver.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.InternalApiserverApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling InternalApiserverApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
855
kubernetes/docs/InternalApiserverV1alpha1Api.md
Normal file
855
kubernetes/docs/InternalApiserverV1alpha1Api.md
Normal file
|
|
@ -0,0 +1,855 @@
|
|||
# kubernetes.client.InternalApiserverV1alpha1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_storage_version**](InternalApiserverV1alpha1Api.md#create_storage_version) | **POST** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions |
|
||||
[**delete_collection_storage_version**](InternalApiserverV1alpha1Api.md#delete_collection_storage_version) | **DELETE** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions |
|
||||
[**delete_storage_version**](InternalApiserverV1alpha1Api.md#delete_storage_version) | **DELETE** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} |
|
||||
[**get_api_resources**](InternalApiserverV1alpha1Api.md#get_api_resources) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/ |
|
||||
[**list_storage_version**](InternalApiserverV1alpha1Api.md#list_storage_version) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions |
|
||||
[**patch_storage_version**](InternalApiserverV1alpha1Api.md#patch_storage_version) | **PATCH** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} |
|
||||
[**patch_storage_version_status**](InternalApiserverV1alpha1Api.md#patch_storage_version_status) | **PATCH** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status |
|
||||
[**read_storage_version**](InternalApiserverV1alpha1Api.md#read_storage_version) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} |
|
||||
[**read_storage_version_status**](InternalApiserverV1alpha1Api.md#read_storage_version_status) | **GET** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status |
|
||||
[**replace_storage_version**](InternalApiserverV1alpha1Api.md#replace_storage_version) | **PUT** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name} |
|
||||
[**replace_storage_version_status**](InternalApiserverV1alpha1Api.md#replace_storage_version_status) | **PUT** /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status |
|
||||
|
||||
|
||||
# **create_storage_version**
|
||||
> V1alpha1StorageVersion create_storage_version(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create a StorageVersion
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.InternalApiserverV1alpha1Api(api_client)
|
||||
body = kubernetes.client.V1alpha1StorageVersion() # V1alpha1StorageVersion |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_storage_version(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling InternalApiserverV1alpha1Api->create_storage_version: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1alpha1StorageVersion**](V1alpha1StorageVersion.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersion**](V1alpha1StorageVersion.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_storage_version**
|
||||
> V1Status delete_collection_storage_version(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of StorageVersion
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.InternalApiserverV1alpha1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_storage_version(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling InternalApiserverV1alpha1Api->delete_collection_storage_version: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_storage_version**
|
||||
> V1Status delete_storage_version(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete a StorageVersion
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.InternalApiserverV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the StorageVersion
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_storage_version(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling InternalApiserverV1alpha1Api->delete_storage_version: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the StorageVersion |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.InternalApiserverV1alpha1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling InternalApiserverV1alpha1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_storage_version**
|
||||
> V1alpha1StorageVersionList list_storage_version(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind StorageVersion
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.InternalApiserverV1alpha1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_storage_version(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling InternalApiserverV1alpha1Api->list_storage_version: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersionList**](V1alpha1StorageVersionList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_storage_version**
|
||||
> V1alpha1StorageVersion patch_storage_version(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified StorageVersion
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.InternalApiserverV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the StorageVersion
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_storage_version(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling InternalApiserverV1alpha1Api->patch_storage_version: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the StorageVersion |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersion**](V1alpha1StorageVersion.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_storage_version_status**
|
||||
> V1alpha1StorageVersion patch_storage_version_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update status of the specified StorageVersion
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.InternalApiserverV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the StorageVersion
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_storage_version_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling InternalApiserverV1alpha1Api->patch_storage_version_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the StorageVersion |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersion**](V1alpha1StorageVersion.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_storage_version**
|
||||
> V1alpha1StorageVersion read_storage_version(name, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified StorageVersion
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.InternalApiserverV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the StorageVersion
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_storage_version(name, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling InternalApiserverV1alpha1Api->read_storage_version: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the StorageVersion |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersion**](V1alpha1StorageVersion.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_storage_version_status**
|
||||
> V1alpha1StorageVersion read_storage_version_status(name, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read status of the specified StorageVersion
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.InternalApiserverV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the StorageVersion
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_storage_version_status(name, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling InternalApiserverV1alpha1Api->read_storage_version_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the StorageVersion |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersion**](V1alpha1StorageVersion.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_storage_version**
|
||||
> V1alpha1StorageVersion replace_storage_version(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified StorageVersion
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.InternalApiserverV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the StorageVersion
|
||||
body = kubernetes.client.V1alpha1StorageVersion() # V1alpha1StorageVersion |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_storage_version(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling InternalApiserverV1alpha1Api->replace_storage_version: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the StorageVersion |
|
||||
**body** | [**V1alpha1StorageVersion**](V1alpha1StorageVersion.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersion**](V1alpha1StorageVersion.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_storage_version_status**
|
||||
> V1alpha1StorageVersion replace_storage_version_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace status of the specified StorageVersion
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.InternalApiserverV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the StorageVersion
|
||||
body = kubernetes.client.V1alpha1StorageVersion() # V1alpha1StorageVersion |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_storage_version_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling InternalApiserverV1alpha1Api->replace_storage_version_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the StorageVersion |
|
||||
**body** | [**V1alpha1StorageVersion**](V1alpha1StorageVersion.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersion**](V1alpha1StorageVersion.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
128
kubernetes/docs/LogsApi.md
Normal file
128
kubernetes/docs/LogsApi.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
# kubernetes.client.LogsApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**log_file_handler**](LogsApi.md#log_file_handler) | **GET** /logs/{logpath} |
|
||||
[**log_file_list_handler**](LogsApi.md#log_file_list_handler) | **GET** /logs/ |
|
||||
|
||||
|
||||
# **log_file_handler**
|
||||
> log_file_handler(logpath)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.LogsApi(api_client)
|
||||
logpath = 'logpath_example' # str | path to the log
|
||||
|
||||
try:
|
||||
api_instance.log_file_handler(logpath)
|
||||
except ApiException as e:
|
||||
print("Exception when calling LogsApi->log_file_handler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**logpath** | **str**| path to the log |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **log_file_list_handler**
|
||||
> log_file_list_handler()
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.LogsApi(api_client)
|
||||
|
||||
try:
|
||||
api_instance.log_file_list_handler()
|
||||
except ApiException as e:
|
||||
print("Exception when calling LogsApi->log_file_list_handler: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
70
kubernetes/docs/NetworkingApi.md
Normal file
70
kubernetes/docs/NetworkingApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.NetworkingApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](NetworkingApi.md#get_api_group) | **GET** /apis/networking.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.NetworkingApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling NetworkingApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
2183
kubernetes/docs/NetworkingV1Api.md
Normal file
2183
kubernetes/docs/NetworkingV1Api.md
Normal file
File diff suppressed because it is too large
Load diff
1416
kubernetes/docs/NetworkingV1beta1Api.md
Normal file
1416
kubernetes/docs/NetworkingV1beta1Api.md
Normal file
File diff suppressed because it is too large
Load diff
70
kubernetes/docs/NodeApi.md
Normal file
70
kubernetes/docs/NodeApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.NodeApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](NodeApi.md#get_api_group) | **GET** /apis/node.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.NodeApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling NodeApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
631
kubernetes/docs/NodeV1Api.md
Normal file
631
kubernetes/docs/NodeV1Api.md
Normal file
|
|
@ -0,0 +1,631 @@
|
|||
# kubernetes.client.NodeV1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_runtime_class**](NodeV1Api.md#create_runtime_class) | **POST** /apis/node.k8s.io/v1/runtimeclasses |
|
||||
[**delete_collection_runtime_class**](NodeV1Api.md#delete_collection_runtime_class) | **DELETE** /apis/node.k8s.io/v1/runtimeclasses |
|
||||
[**delete_runtime_class**](NodeV1Api.md#delete_runtime_class) | **DELETE** /apis/node.k8s.io/v1/runtimeclasses/{name} |
|
||||
[**get_api_resources**](NodeV1Api.md#get_api_resources) | **GET** /apis/node.k8s.io/v1/ |
|
||||
[**list_runtime_class**](NodeV1Api.md#list_runtime_class) | **GET** /apis/node.k8s.io/v1/runtimeclasses |
|
||||
[**patch_runtime_class**](NodeV1Api.md#patch_runtime_class) | **PATCH** /apis/node.k8s.io/v1/runtimeclasses/{name} |
|
||||
[**read_runtime_class**](NodeV1Api.md#read_runtime_class) | **GET** /apis/node.k8s.io/v1/runtimeclasses/{name} |
|
||||
[**replace_runtime_class**](NodeV1Api.md#replace_runtime_class) | **PUT** /apis/node.k8s.io/v1/runtimeclasses/{name} |
|
||||
|
||||
|
||||
# **create_runtime_class**
|
||||
> V1RuntimeClass create_runtime_class(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create a RuntimeClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.NodeV1Api(api_client)
|
||||
body = kubernetes.client.V1RuntimeClass() # V1RuntimeClass |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_runtime_class(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling NodeV1Api->create_runtime_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1RuntimeClass**](V1RuntimeClass.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1RuntimeClass**](V1RuntimeClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_runtime_class**
|
||||
> V1Status delete_collection_runtime_class(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of RuntimeClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.NodeV1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_runtime_class(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling NodeV1Api->delete_collection_runtime_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_runtime_class**
|
||||
> V1Status delete_runtime_class(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete a RuntimeClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.NodeV1Api(api_client)
|
||||
name = 'name_example' # str | name of the RuntimeClass
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_runtime_class(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling NodeV1Api->delete_runtime_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the RuntimeClass |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.NodeV1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling NodeV1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_runtime_class**
|
||||
> V1RuntimeClassList list_runtime_class(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind RuntimeClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.NodeV1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_runtime_class(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling NodeV1Api->list_runtime_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1RuntimeClassList**](V1RuntimeClassList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_runtime_class**
|
||||
> V1RuntimeClass patch_runtime_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified RuntimeClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.NodeV1Api(api_client)
|
||||
name = 'name_example' # str | name of the RuntimeClass
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_runtime_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling NodeV1Api->patch_runtime_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the RuntimeClass |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1RuntimeClass**](V1RuntimeClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_runtime_class**
|
||||
> V1RuntimeClass read_runtime_class(name, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified RuntimeClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.NodeV1Api(api_client)
|
||||
name = 'name_example' # str | name of the RuntimeClass
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_runtime_class(name, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling NodeV1Api->read_runtime_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the RuntimeClass |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1RuntimeClass**](V1RuntimeClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_runtime_class**
|
||||
> V1RuntimeClass replace_runtime_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified RuntimeClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.NodeV1Api(api_client)
|
||||
name = 'name_example' # str | name of the RuntimeClass
|
||||
body = kubernetes.client.V1RuntimeClass() # V1RuntimeClass |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_runtime_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling NodeV1Api->replace_runtime_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the RuntimeClass |
|
||||
**body** | [**V1RuntimeClass**](V1RuntimeClass.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1RuntimeClass**](V1RuntimeClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
70
kubernetes/docs/OpenidApi.md
Normal file
70
kubernetes/docs/OpenidApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.OpenidApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_service_account_issuer_open_id_keyset**](OpenidApi.md#get_service_account_issuer_open_id_keyset) | **GET** /openid/v1/jwks |
|
||||
|
||||
|
||||
# **get_service_account_issuer_open_id_keyset**
|
||||
> str get_service_account_issuer_open_id_keyset()
|
||||
|
||||
|
||||
|
||||
get service account issuer OpenID JSON Web Key Set (contains public token verification keys)
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.OpenidApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_service_account_issuer_open_id_keyset()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling OpenidApi->get_service_account_issuer_open_id_keyset: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
**str**
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/jwk-set+json
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
70
kubernetes/docs/PolicyApi.md
Normal file
70
kubernetes/docs/PolicyApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.PolicyApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](PolicyApi.md#get_api_group) | **GET** /apis/policy/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.PolicyApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling PolicyApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
961
kubernetes/docs/PolicyV1Api.md
Normal file
961
kubernetes/docs/PolicyV1Api.md
Normal file
|
|
@ -0,0 +1,961 @@
|
|||
# kubernetes.client.PolicyV1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_namespaced_pod_disruption_budget**](PolicyV1Api.md#create_namespaced_pod_disruption_budget) | **POST** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets |
|
||||
[**delete_collection_namespaced_pod_disruption_budget**](PolicyV1Api.md#delete_collection_namespaced_pod_disruption_budget) | **DELETE** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets |
|
||||
[**delete_namespaced_pod_disruption_budget**](PolicyV1Api.md#delete_namespaced_pod_disruption_budget) | **DELETE** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} |
|
||||
[**get_api_resources**](PolicyV1Api.md#get_api_resources) | **GET** /apis/policy/v1/ |
|
||||
[**list_namespaced_pod_disruption_budget**](PolicyV1Api.md#list_namespaced_pod_disruption_budget) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets |
|
||||
[**list_pod_disruption_budget_for_all_namespaces**](PolicyV1Api.md#list_pod_disruption_budget_for_all_namespaces) | **GET** /apis/policy/v1/poddisruptionbudgets |
|
||||
[**patch_namespaced_pod_disruption_budget**](PolicyV1Api.md#patch_namespaced_pod_disruption_budget) | **PATCH** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} |
|
||||
[**patch_namespaced_pod_disruption_budget_status**](PolicyV1Api.md#patch_namespaced_pod_disruption_budget_status) | **PATCH** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status |
|
||||
[**read_namespaced_pod_disruption_budget**](PolicyV1Api.md#read_namespaced_pod_disruption_budget) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} |
|
||||
[**read_namespaced_pod_disruption_budget_status**](PolicyV1Api.md#read_namespaced_pod_disruption_budget_status) | **GET** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status |
|
||||
[**replace_namespaced_pod_disruption_budget**](PolicyV1Api.md#replace_namespaced_pod_disruption_budget) | **PUT** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name} |
|
||||
[**replace_namespaced_pod_disruption_budget_status**](PolicyV1Api.md#replace_namespaced_pod_disruption_budget_status) | **PUT** /apis/policy/v1/namespaces/{namespace}/poddisruptionbudgets/{name}/status |
|
||||
|
||||
|
||||
# **create_namespaced_pod_disruption_budget**
|
||||
> V1PodDisruptionBudget create_namespaced_pod_disruption_budget(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create a PodDisruptionBudget
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.PolicyV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V1PodDisruptionBudget() # V1PodDisruptionBudget |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_namespaced_pod_disruption_budget(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling PolicyV1Api->create_namespaced_pod_disruption_budget: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V1PodDisruptionBudget**](V1PodDisruptionBudget.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1PodDisruptionBudget**](V1PodDisruptionBudget.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_namespaced_pod_disruption_budget**
|
||||
> V1Status delete_collection_namespaced_pod_disruption_budget(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of PodDisruptionBudget
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.PolicyV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_namespaced_pod_disruption_budget(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling PolicyV1Api->delete_collection_namespaced_pod_disruption_budget: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_namespaced_pod_disruption_budget**
|
||||
> V1Status delete_namespaced_pod_disruption_budget(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete a PodDisruptionBudget
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.PolicyV1Api(api_client)
|
||||
name = 'name_example' # str | name of the PodDisruptionBudget
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_namespaced_pod_disruption_budget(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling PolicyV1Api->delete_namespaced_pod_disruption_budget: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the PodDisruptionBudget |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.PolicyV1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling PolicyV1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_namespaced_pod_disruption_budget**
|
||||
> V1PodDisruptionBudgetList list_namespaced_pod_disruption_budget(namespace, pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind PodDisruptionBudget
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.PolicyV1Api(api_client)
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_namespaced_pod_disruption_budget(namespace, pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling PolicyV1Api->list_namespaced_pod_disruption_budget: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1PodDisruptionBudgetList**](V1PodDisruptionBudgetList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_pod_disruption_budget_for_all_namespaces**
|
||||
> V1PodDisruptionBudgetList list_pod_disruption_budget_for_all_namespaces(allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, pretty=pretty, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind PodDisruptionBudget
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.PolicyV1Api(api_client)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_pod_disruption_budget_for_all_namespaces(allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, pretty=pretty, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling PolicyV1Api->list_pod_disruption_budget_for_all_namespaces: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1PodDisruptionBudgetList**](V1PodDisruptionBudgetList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_namespaced_pod_disruption_budget**
|
||||
> V1PodDisruptionBudget patch_namespaced_pod_disruption_budget(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified PodDisruptionBudget
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.PolicyV1Api(api_client)
|
||||
name = 'name_example' # str | name of the PodDisruptionBudget
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_namespaced_pod_disruption_budget(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling PolicyV1Api->patch_namespaced_pod_disruption_budget: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the PodDisruptionBudget |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1PodDisruptionBudget**](V1PodDisruptionBudget.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_namespaced_pod_disruption_budget_status**
|
||||
> V1PodDisruptionBudget patch_namespaced_pod_disruption_budget_status(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update status of the specified PodDisruptionBudget
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.PolicyV1Api(api_client)
|
||||
name = 'name_example' # str | name of the PodDisruptionBudget
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_namespaced_pod_disruption_budget_status(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling PolicyV1Api->patch_namespaced_pod_disruption_budget_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the PodDisruptionBudget |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1PodDisruptionBudget**](V1PodDisruptionBudget.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_namespaced_pod_disruption_budget**
|
||||
> V1PodDisruptionBudget read_namespaced_pod_disruption_budget(name, namespace, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified PodDisruptionBudget
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.PolicyV1Api(api_client)
|
||||
name = 'name_example' # str | name of the PodDisruptionBudget
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_namespaced_pod_disruption_budget(name, namespace, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling PolicyV1Api->read_namespaced_pod_disruption_budget: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the PodDisruptionBudget |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1PodDisruptionBudget**](V1PodDisruptionBudget.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_namespaced_pod_disruption_budget_status**
|
||||
> V1PodDisruptionBudget read_namespaced_pod_disruption_budget_status(name, namespace, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read status of the specified PodDisruptionBudget
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.PolicyV1Api(api_client)
|
||||
name = 'name_example' # str | name of the PodDisruptionBudget
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_namespaced_pod_disruption_budget_status(name, namespace, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling PolicyV1Api->read_namespaced_pod_disruption_budget_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the PodDisruptionBudget |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1PodDisruptionBudget**](V1PodDisruptionBudget.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_namespaced_pod_disruption_budget**
|
||||
> V1PodDisruptionBudget replace_namespaced_pod_disruption_budget(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified PodDisruptionBudget
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.PolicyV1Api(api_client)
|
||||
name = 'name_example' # str | name of the PodDisruptionBudget
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V1PodDisruptionBudget() # V1PodDisruptionBudget |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_namespaced_pod_disruption_budget(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling PolicyV1Api->replace_namespaced_pod_disruption_budget: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the PodDisruptionBudget |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V1PodDisruptionBudget**](V1PodDisruptionBudget.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1PodDisruptionBudget**](V1PodDisruptionBudget.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_namespaced_pod_disruption_budget_status**
|
||||
> V1PodDisruptionBudget replace_namespaced_pod_disruption_budget_status(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace status of the specified PodDisruptionBudget
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.PolicyV1Api(api_client)
|
||||
name = 'name_example' # str | name of the PodDisruptionBudget
|
||||
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
||||
body = kubernetes.client.V1PodDisruptionBudget() # V1PodDisruptionBudget |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_namespaced_pod_disruption_budget_status(name, namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling PolicyV1Api->replace_namespaced_pod_disruption_budget_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the PodDisruptionBudget |
|
||||
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
||||
**body** | [**V1PodDisruptionBudget**](V1PodDisruptionBudget.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1PodDisruptionBudget**](V1PodDisruptionBudget.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
70
kubernetes/docs/RbacAuthorizationApi.md
Normal file
70
kubernetes/docs/RbacAuthorizationApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.RbacAuthorizationApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](RbacAuthorizationApi.md#get_api_group) | **GET** /apis/rbac.authorization.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.RbacAuthorizationApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling RbacAuthorizationApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
2514
kubernetes/docs/RbacAuthorizationV1Api.md
Normal file
2514
kubernetes/docs/RbacAuthorizationV1Api.md
Normal file
File diff suppressed because it is too large
Load diff
14
kubernetes/docs/RbacV1Subject.md
Normal file
14
kubernetes/docs/RbacV1Subject.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# RbacV1Subject
|
||||
|
||||
Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**api_group** | **str** | APIGroup holds the API group of the referenced subject. Defaults to \"\" for ServiceAccount subjects. Defaults to \"rbac.authorization.k8s.io\" for User and Group subjects. | [optional]
|
||||
**kind** | **str** | Kind of object being referenced. Values defined by this API group are \"User\", \"Group\", and \"ServiceAccount\". If the Authorizer does not recognized the kind value, the Authorizer should report an error. |
|
||||
**name** | **str** | Name of the object being referenced. |
|
||||
**namespace** | **str** | Namespace of the referenced object. If the object kind is non-namespace, such as \"User\" or \"Group\", and this value is not empty the Authorizer should report an error. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
70
kubernetes/docs/ResourceApi.md
Normal file
70
kubernetes/docs/ResourceApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.ResourceApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](ResourceApi.md#get_api_group) | **GET** /apis/resource.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.ResourceApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling ResourceApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
2744
kubernetes/docs/ResourceV1alpha3Api.md
Normal file
2744
kubernetes/docs/ResourceV1alpha3Api.md
Normal file
File diff suppressed because it is too large
Load diff
2744
kubernetes/docs/ResourceV1beta1Api.md
Normal file
2744
kubernetes/docs/ResourceV1beta1Api.md
Normal file
File diff suppressed because it is too large
Load diff
70
kubernetes/docs/SchedulingApi.md
Normal file
70
kubernetes/docs/SchedulingApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.SchedulingApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](SchedulingApi.md#get_api_group) | **GET** /apis/scheduling.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.SchedulingApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling SchedulingApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
631
kubernetes/docs/SchedulingV1Api.md
Normal file
631
kubernetes/docs/SchedulingV1Api.md
Normal file
|
|
@ -0,0 +1,631 @@
|
|||
# kubernetes.client.SchedulingV1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_priority_class**](SchedulingV1Api.md#create_priority_class) | **POST** /apis/scheduling.k8s.io/v1/priorityclasses |
|
||||
[**delete_collection_priority_class**](SchedulingV1Api.md#delete_collection_priority_class) | **DELETE** /apis/scheduling.k8s.io/v1/priorityclasses |
|
||||
[**delete_priority_class**](SchedulingV1Api.md#delete_priority_class) | **DELETE** /apis/scheduling.k8s.io/v1/priorityclasses/{name} |
|
||||
[**get_api_resources**](SchedulingV1Api.md#get_api_resources) | **GET** /apis/scheduling.k8s.io/v1/ |
|
||||
[**list_priority_class**](SchedulingV1Api.md#list_priority_class) | **GET** /apis/scheduling.k8s.io/v1/priorityclasses |
|
||||
[**patch_priority_class**](SchedulingV1Api.md#patch_priority_class) | **PATCH** /apis/scheduling.k8s.io/v1/priorityclasses/{name} |
|
||||
[**read_priority_class**](SchedulingV1Api.md#read_priority_class) | **GET** /apis/scheduling.k8s.io/v1/priorityclasses/{name} |
|
||||
[**replace_priority_class**](SchedulingV1Api.md#replace_priority_class) | **PUT** /apis/scheduling.k8s.io/v1/priorityclasses/{name} |
|
||||
|
||||
|
||||
# **create_priority_class**
|
||||
> V1PriorityClass create_priority_class(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create a PriorityClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.SchedulingV1Api(api_client)
|
||||
body = kubernetes.client.V1PriorityClass() # V1PriorityClass |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_priority_class(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling SchedulingV1Api->create_priority_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1PriorityClass**](V1PriorityClass.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1PriorityClass**](V1PriorityClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_priority_class**
|
||||
> V1Status delete_collection_priority_class(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of PriorityClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.SchedulingV1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_priority_class(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling SchedulingV1Api->delete_collection_priority_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_priority_class**
|
||||
> V1Status delete_priority_class(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete a PriorityClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.SchedulingV1Api(api_client)
|
||||
name = 'name_example' # str | name of the PriorityClass
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_priority_class(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling SchedulingV1Api->delete_priority_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the PriorityClass |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.SchedulingV1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling SchedulingV1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_priority_class**
|
||||
> V1PriorityClassList list_priority_class(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind PriorityClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.SchedulingV1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_priority_class(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling SchedulingV1Api->list_priority_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1PriorityClassList**](V1PriorityClassList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_priority_class**
|
||||
> V1PriorityClass patch_priority_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified PriorityClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.SchedulingV1Api(api_client)
|
||||
name = 'name_example' # str | name of the PriorityClass
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_priority_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling SchedulingV1Api->patch_priority_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the PriorityClass |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1PriorityClass**](V1PriorityClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_priority_class**
|
||||
> V1PriorityClass read_priority_class(name, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified PriorityClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.SchedulingV1Api(api_client)
|
||||
name = 'name_example' # str | name of the PriorityClass
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_priority_class(name, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling SchedulingV1Api->read_priority_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the PriorityClass |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1PriorityClass**](V1PriorityClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_priority_class**
|
||||
> V1PriorityClass replace_priority_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified PriorityClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.SchedulingV1Api(api_client)
|
||||
name = 'name_example' # str | name of the PriorityClass
|
||||
body = kubernetes.client.V1PriorityClass() # V1PriorityClass |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_priority_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling SchedulingV1Api->replace_priority_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the PriorityClass |
|
||||
**body** | [**V1PriorityClass**](V1PriorityClass.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1PriorityClass**](V1PriorityClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
70
kubernetes/docs/StorageApi.md
Normal file
70
kubernetes/docs/StorageApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.StorageApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](StorageApi.md#get_api_group) | **GET** /apis/storage.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
3199
kubernetes/docs/StorageV1Api.md
Normal file
3199
kubernetes/docs/StorageV1Api.md
Normal file
File diff suppressed because it is too large
Load diff
12
kubernetes/docs/StorageV1TokenRequest.md
Normal file
12
kubernetes/docs/StorageV1TokenRequest.md
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# StorageV1TokenRequest
|
||||
|
||||
TokenRequest contains parameters of a service account token.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**audience** | **str** | audience is the intended audience of the token in \"TokenRequestSpec\". It will default to the audiences of kube apiserver. |
|
||||
**expiration_seconds** | **int** | expirationSeconds is the duration of validity of the token in \"TokenRequestSpec\". It has the same default value of \"ExpirationSeconds\" in \"TokenRequestSpec\". | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
631
kubernetes/docs/StorageV1alpha1Api.md
Normal file
631
kubernetes/docs/StorageV1alpha1Api.md
Normal file
|
|
@ -0,0 +1,631 @@
|
|||
# kubernetes.client.StorageV1alpha1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_volume_attributes_class**](StorageV1alpha1Api.md#create_volume_attributes_class) | **POST** /apis/storage.k8s.io/v1alpha1/volumeattributesclasses |
|
||||
[**delete_collection_volume_attributes_class**](StorageV1alpha1Api.md#delete_collection_volume_attributes_class) | **DELETE** /apis/storage.k8s.io/v1alpha1/volumeattributesclasses |
|
||||
[**delete_volume_attributes_class**](StorageV1alpha1Api.md#delete_volume_attributes_class) | **DELETE** /apis/storage.k8s.io/v1alpha1/volumeattributesclasses/{name} |
|
||||
[**get_api_resources**](StorageV1alpha1Api.md#get_api_resources) | **GET** /apis/storage.k8s.io/v1alpha1/ |
|
||||
[**list_volume_attributes_class**](StorageV1alpha1Api.md#list_volume_attributes_class) | **GET** /apis/storage.k8s.io/v1alpha1/volumeattributesclasses |
|
||||
[**patch_volume_attributes_class**](StorageV1alpha1Api.md#patch_volume_attributes_class) | **PATCH** /apis/storage.k8s.io/v1alpha1/volumeattributesclasses/{name} |
|
||||
[**read_volume_attributes_class**](StorageV1alpha1Api.md#read_volume_attributes_class) | **GET** /apis/storage.k8s.io/v1alpha1/volumeattributesclasses/{name} |
|
||||
[**replace_volume_attributes_class**](StorageV1alpha1Api.md#replace_volume_attributes_class) | **PUT** /apis/storage.k8s.io/v1alpha1/volumeattributesclasses/{name} |
|
||||
|
||||
|
||||
# **create_volume_attributes_class**
|
||||
> V1alpha1VolumeAttributesClass create_volume_attributes_class(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create a VolumeAttributesClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1alpha1Api(api_client)
|
||||
body = kubernetes.client.V1alpha1VolumeAttributesClass() # V1alpha1VolumeAttributesClass |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_volume_attributes_class(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1alpha1Api->create_volume_attributes_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1alpha1VolumeAttributesClass**](V1alpha1VolumeAttributesClass.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1VolumeAttributesClass**](V1alpha1VolumeAttributesClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_volume_attributes_class**
|
||||
> V1Status delete_collection_volume_attributes_class(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of VolumeAttributesClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1alpha1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_volume_attributes_class(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1alpha1Api->delete_collection_volume_attributes_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_volume_attributes_class**
|
||||
> V1alpha1VolumeAttributesClass delete_volume_attributes_class(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete a VolumeAttributesClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the VolumeAttributesClass
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_volume_attributes_class(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1alpha1Api->delete_volume_attributes_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the VolumeAttributesClass |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1VolumeAttributesClass**](V1alpha1VolumeAttributesClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1alpha1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1alpha1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_volume_attributes_class**
|
||||
> V1alpha1VolumeAttributesClassList list_volume_attributes_class(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind VolumeAttributesClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1alpha1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_volume_attributes_class(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1alpha1Api->list_volume_attributes_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1VolumeAttributesClassList**](V1alpha1VolumeAttributesClassList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_volume_attributes_class**
|
||||
> V1alpha1VolumeAttributesClass patch_volume_attributes_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified VolumeAttributesClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the VolumeAttributesClass
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_volume_attributes_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1alpha1Api->patch_volume_attributes_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the VolumeAttributesClass |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1VolumeAttributesClass**](V1alpha1VolumeAttributesClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_volume_attributes_class**
|
||||
> V1alpha1VolumeAttributesClass read_volume_attributes_class(name, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified VolumeAttributesClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the VolumeAttributesClass
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_volume_attributes_class(name, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1alpha1Api->read_volume_attributes_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the VolumeAttributesClass |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1VolumeAttributesClass**](V1alpha1VolumeAttributesClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_volume_attributes_class**
|
||||
> V1alpha1VolumeAttributesClass replace_volume_attributes_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified VolumeAttributesClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the VolumeAttributesClass
|
||||
body = kubernetes.client.V1alpha1VolumeAttributesClass() # V1alpha1VolumeAttributesClass |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_volume_attributes_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1alpha1Api->replace_volume_attributes_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the VolumeAttributesClass |
|
||||
**body** | [**V1alpha1VolumeAttributesClass**](V1alpha1VolumeAttributesClass.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1VolumeAttributesClass**](V1alpha1VolumeAttributesClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
631
kubernetes/docs/StorageV1beta1Api.md
Normal file
631
kubernetes/docs/StorageV1beta1Api.md
Normal file
|
|
@ -0,0 +1,631 @@
|
|||
# kubernetes.client.StorageV1beta1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_volume_attributes_class**](StorageV1beta1Api.md#create_volume_attributes_class) | **POST** /apis/storage.k8s.io/v1beta1/volumeattributesclasses |
|
||||
[**delete_collection_volume_attributes_class**](StorageV1beta1Api.md#delete_collection_volume_attributes_class) | **DELETE** /apis/storage.k8s.io/v1beta1/volumeattributesclasses |
|
||||
[**delete_volume_attributes_class**](StorageV1beta1Api.md#delete_volume_attributes_class) | **DELETE** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} |
|
||||
[**get_api_resources**](StorageV1beta1Api.md#get_api_resources) | **GET** /apis/storage.k8s.io/v1beta1/ |
|
||||
[**list_volume_attributes_class**](StorageV1beta1Api.md#list_volume_attributes_class) | **GET** /apis/storage.k8s.io/v1beta1/volumeattributesclasses |
|
||||
[**patch_volume_attributes_class**](StorageV1beta1Api.md#patch_volume_attributes_class) | **PATCH** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} |
|
||||
[**read_volume_attributes_class**](StorageV1beta1Api.md#read_volume_attributes_class) | **GET** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} |
|
||||
[**replace_volume_attributes_class**](StorageV1beta1Api.md#replace_volume_attributes_class) | **PUT** /apis/storage.k8s.io/v1beta1/volumeattributesclasses/{name} |
|
||||
|
||||
|
||||
# **create_volume_attributes_class**
|
||||
> V1beta1VolumeAttributesClass create_volume_attributes_class(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create a VolumeAttributesClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1beta1Api(api_client)
|
||||
body = kubernetes.client.V1beta1VolumeAttributesClass() # V1beta1VolumeAttributesClass |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_volume_attributes_class(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1beta1Api->create_volume_attributes_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1beta1VolumeAttributesClass**](V1beta1VolumeAttributesClass.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1beta1VolumeAttributesClass**](V1beta1VolumeAttributesClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_volume_attributes_class**
|
||||
> V1Status delete_collection_volume_attributes_class(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of VolumeAttributesClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1beta1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_volume_attributes_class(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1beta1Api->delete_collection_volume_attributes_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_volume_attributes_class**
|
||||
> V1beta1VolumeAttributesClass delete_volume_attributes_class(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete a VolumeAttributesClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1beta1Api(api_client)
|
||||
name = 'name_example' # str | name of the VolumeAttributesClass
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_volume_attributes_class(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1beta1Api->delete_volume_attributes_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the VolumeAttributesClass |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1beta1VolumeAttributesClass**](V1beta1VolumeAttributesClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1beta1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1beta1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_volume_attributes_class**
|
||||
> V1beta1VolumeAttributesClassList list_volume_attributes_class(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind VolumeAttributesClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1beta1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_volume_attributes_class(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1beta1Api->list_volume_attributes_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1beta1VolumeAttributesClassList**](V1beta1VolumeAttributesClassList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_volume_attributes_class**
|
||||
> V1beta1VolumeAttributesClass patch_volume_attributes_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified VolumeAttributesClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1beta1Api(api_client)
|
||||
name = 'name_example' # str | name of the VolumeAttributesClass
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_volume_attributes_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1beta1Api->patch_volume_attributes_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the VolumeAttributesClass |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1beta1VolumeAttributesClass**](V1beta1VolumeAttributesClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_volume_attributes_class**
|
||||
> V1beta1VolumeAttributesClass read_volume_attributes_class(name, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified VolumeAttributesClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1beta1Api(api_client)
|
||||
name = 'name_example' # str | name of the VolumeAttributesClass
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_volume_attributes_class(name, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1beta1Api->read_volume_attributes_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the VolumeAttributesClass |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1beta1VolumeAttributesClass**](V1beta1VolumeAttributesClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_volume_attributes_class**
|
||||
> V1beta1VolumeAttributesClass replace_volume_attributes_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified VolumeAttributesClass
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StorageV1beta1Api(api_client)
|
||||
name = 'name_example' # str | name of the VolumeAttributesClass
|
||||
body = kubernetes.client.V1beta1VolumeAttributesClass() # V1beta1VolumeAttributesClass |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_volume_attributes_class(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StorageV1beta1Api->replace_volume_attributes_class: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the VolumeAttributesClass |
|
||||
**body** | [**V1beta1VolumeAttributesClass**](V1beta1VolumeAttributesClass.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1beta1VolumeAttributesClass**](V1beta1VolumeAttributesClass.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
70
kubernetes/docs/StoragemigrationApi.md
Normal file
70
kubernetes/docs/StoragemigrationApi.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# kubernetes.client.StoragemigrationApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_api_group**](StoragemigrationApi.md#get_api_group) | **GET** /apis/storagemigration.k8s.io/ |
|
||||
|
||||
|
||||
# **get_api_group**
|
||||
> V1APIGroup get_api_group()
|
||||
|
||||
|
||||
|
||||
get information of a group
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StoragemigrationApi(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_group()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StoragemigrationApi->get_api_group: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIGroup**](V1APIGroup.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
855
kubernetes/docs/StoragemigrationV1alpha1Api.md
Normal file
855
kubernetes/docs/StoragemigrationV1alpha1Api.md
Normal file
|
|
@ -0,0 +1,855 @@
|
|||
# kubernetes.client.StoragemigrationV1alpha1Api
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_storage_version_migration**](StoragemigrationV1alpha1Api.md#create_storage_version_migration) | **POST** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations |
|
||||
[**delete_collection_storage_version_migration**](StoragemigrationV1alpha1Api.md#delete_collection_storage_version_migration) | **DELETE** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations |
|
||||
[**delete_storage_version_migration**](StoragemigrationV1alpha1Api.md#delete_storage_version_migration) | **DELETE** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name} |
|
||||
[**get_api_resources**](StoragemigrationV1alpha1Api.md#get_api_resources) | **GET** /apis/storagemigration.k8s.io/v1alpha1/ |
|
||||
[**list_storage_version_migration**](StoragemigrationV1alpha1Api.md#list_storage_version_migration) | **GET** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations |
|
||||
[**patch_storage_version_migration**](StoragemigrationV1alpha1Api.md#patch_storage_version_migration) | **PATCH** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name} |
|
||||
[**patch_storage_version_migration_status**](StoragemigrationV1alpha1Api.md#patch_storage_version_migration_status) | **PATCH** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status |
|
||||
[**read_storage_version_migration**](StoragemigrationV1alpha1Api.md#read_storage_version_migration) | **GET** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name} |
|
||||
[**read_storage_version_migration_status**](StoragemigrationV1alpha1Api.md#read_storage_version_migration_status) | **GET** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status |
|
||||
[**replace_storage_version_migration**](StoragemigrationV1alpha1Api.md#replace_storage_version_migration) | **PUT** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name} |
|
||||
[**replace_storage_version_migration_status**](StoragemigrationV1alpha1Api.md#replace_storage_version_migration_status) | **PUT** /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status |
|
||||
|
||||
|
||||
# **create_storage_version_migration**
|
||||
> V1alpha1StorageVersionMigration create_storage_version_migration(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
create a StorageVersionMigration
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StoragemigrationV1alpha1Api(api_client)
|
||||
body = kubernetes.client.V1alpha1StorageVersionMigration() # V1alpha1StorageVersionMigration |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.create_storage_version_migration(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StoragemigrationV1alpha1Api->create_storage_version_migration: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**V1alpha1StorageVersionMigration**](V1alpha1StorageVersionMigration.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersionMigration**](V1alpha1StorageVersionMigration.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_collection_storage_version_migration**
|
||||
> V1Status delete_collection_storage_version_migration(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
|
||||
|
||||
|
||||
delete collection of StorageVersionMigration
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StoragemigrationV1alpha1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_collection_storage_version_migration(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StoragemigrationV1alpha1Api->delete_collection_storage_version_migration: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_storage_version_migration**
|
||||
> V1Status delete_storage_version_migration(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
|
||||
|
||||
|
||||
delete a StorageVersionMigration
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StoragemigrationV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the StorageVersionMigration
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
||||
ignore_store_read_error_with_cluster_breaking_potential = True # 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 (optional)
|
||||
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
|
||||
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. (optional)
|
||||
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions | (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.delete_storage_version_migration(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, ignore_store_read_error_with_cluster_breaking_potential=ignore_store_read_error_with_cluster_breaking_potential, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StoragemigrationV1alpha1Api->delete_storage_version_migration: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the StorageVersionMigration |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
||||
**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 | [optional]
|
||||
**orphan_dependents** | **bool**| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional]
|
||||
**propagation_policy** | **str**| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. 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. | [optional]
|
||||
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1Status**](V1Status.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**202** | Accepted | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_api_resources**
|
||||
> V1APIResourceList get_api_resources()
|
||||
|
||||
|
||||
|
||||
get available resources
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StoragemigrationV1alpha1Api(api_client)
|
||||
|
||||
try:
|
||||
api_response = api_instance.get_api_resources()
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StoragemigrationV1alpha1Api->get_api_resources: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1APIResourceList**](V1APIResourceList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **list_storage_version_migration**
|
||||
> V1alpha1StorageVersionMigrationList list_storage_version_migration(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind StorageVersionMigration
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StoragemigrationV1alpha1Api(api_client)
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
allow_watch_bookmarks = True # 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. (optional)
|
||||
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. (optional)
|
||||
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
||||
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
||||
limit = 56 # 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 kubernetes.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, kubernetes.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 kubernetes.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. (optional)
|
||||
resource_version = 'resource_version_example' # 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 (optional)
|
||||
resource_version_match = 'resource_version_match_example' # 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 (optional)
|
||||
send_initial_events = True # 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. (optional)
|
||||
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
|
||||
watch = True # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.list_storage_version_migration(pretty=pretty, allow_watch_bookmarks=allow_watch_bookmarks, _continue=_continue, field_selector=field_selector, label_selector=label_selector, limit=limit, resource_version=resource_version, resource_version_match=resource_version_match, send_initial_events=send_initial_events, timeout_seconds=timeout_seconds, watch=watch)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StoragemigrationV1alpha1Api->list_storage_version_migration: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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. | [optional]
|
||||
**_continue** | **str**| The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes.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 kubernetes.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes.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. | [optional]
|
||||
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
||||
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
||||
**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 kubernetes.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, kubernetes.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 kubernetes.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. | [optional]
|
||||
**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 | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**timeout_seconds** | **int**| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional]
|
||||
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersionMigrationList**](V1alpha1StorageVersionMigrationList.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch, application/cbor-seq
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_storage_version_migration**
|
||||
> V1alpha1StorageVersionMigration patch_storage_version_migration(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update the specified StorageVersionMigration
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StoragemigrationV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the StorageVersionMigration
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_storage_version_migration(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StoragemigrationV1alpha1Api->patch_storage_version_migration: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the StorageVersionMigration |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersionMigration**](V1alpha1StorageVersionMigration.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **patch_storage_version_migration_status**
|
||||
> V1alpha1StorageVersionMigration patch_storage_version_migration_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
|
||||
|
||||
|
||||
partially update status of the specified StorageVersionMigration
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StoragemigrationV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the StorageVersionMigration
|
||||
body = None # object |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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). (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
force = True # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.patch_storage_version_migration_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation, force=force)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StoragemigrationV1alpha1Api->patch_storage_version_migration_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the StorageVersionMigration |
|
||||
**body** | **object**| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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). | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersionMigration**](V1alpha1StorageVersionMigration.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml, application/apply-patch+cbor
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_storage_version_migration**
|
||||
> V1alpha1StorageVersionMigration read_storage_version_migration(name, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read the specified StorageVersionMigration
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StoragemigrationV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the StorageVersionMigration
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_storage_version_migration(name, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StoragemigrationV1alpha1Api->read_storage_version_migration: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the StorageVersionMigration |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersionMigration**](V1alpha1StorageVersionMigration.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **read_storage_version_migration_status**
|
||||
> V1alpha1StorageVersionMigration read_storage_version_migration_status(name, pretty=pretty)
|
||||
|
||||
|
||||
|
||||
read status of the specified StorageVersionMigration
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StoragemigrationV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the StorageVersionMigration
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.read_storage_version_migration_status(name, pretty=pretty)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StoragemigrationV1alpha1Api->read_storage_version_migration_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the StorageVersionMigration |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersionMigration**](V1alpha1StorageVersionMigration.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_storage_version_migration**
|
||||
> V1alpha1StorageVersionMigration replace_storage_version_migration(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace the specified StorageVersionMigration
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StoragemigrationV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the StorageVersionMigration
|
||||
body = kubernetes.client.V1alpha1StorageVersionMigration() # V1alpha1StorageVersionMigration |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_storage_version_migration(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StoragemigrationV1alpha1Api->replace_storage_version_migration: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the StorageVersionMigration |
|
||||
**body** | [**V1alpha1StorageVersionMigration**](V1alpha1StorageVersionMigration.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersionMigration**](V1alpha1StorageVersionMigration.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **replace_storage_version_migration_status**
|
||||
> V1alpha1StorageVersionMigration replace_storage_version_migration_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
|
||||
|
||||
|
||||
replace status of the specified StorageVersionMigration
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (BearerToken):
|
||||
```python
|
||||
from __future__ import print_function
|
||||
import time
|
||||
import kubernetes.client
|
||||
from kubernetes.client.rest import ApiException
|
||||
from pprint import pprint
|
||||
configuration = kubernetes.client.Configuration()
|
||||
# Configure API key authorization: BearerToken
|
||||
configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['authorization'] = 'Bearer'
|
||||
|
||||
# Defining host is optional and default to http://localhost
|
||||
configuration.host = "http://localhost"
|
||||
|
||||
# Enter a context with an instance of the API kubernetes.client
|
||||
with kubernetes.client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = kubernetes.client.StoragemigrationV1alpha1Api(api_client)
|
||||
name = 'name_example' # str | name of the StorageVersionMigration
|
||||
body = kubernetes.client.V1alpha1StorageVersionMigration() # V1alpha1StorageVersionMigration |
|
||||
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
|
||||
dry_run = 'dry_run_example' # 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 (optional)
|
||||
field_manager = 'field_manager_example' # 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. (optional)
|
||||
field_validation = 'field_validation_example' # 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. (optional)
|
||||
|
||||
try:
|
||||
api_response = api_instance.replace_storage_version_migration_status(name, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager, field_validation=field_validation)
|
||||
pprint(api_response)
|
||||
except ApiException as e:
|
||||
print("Exception when calling StoragemigrationV1alpha1Api->replace_storage_version_migration_status: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| name of the StorageVersionMigration |
|
||||
**body** | [**V1alpha1StorageVersionMigration**](V1alpha1StorageVersionMigration.md)| |
|
||||
**pretty** | **str**| If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). | [optional]
|
||||
**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 | [optional]
|
||||
**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. | [optional]
|
||||
**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. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**V1alpha1StorageVersionMigration**](V1alpha1StorageVersionMigration.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BearerToken](../README.md#BearerToken)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/cbor
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**201** | Created | - |
|
||||
**401** | Unauthorized | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
16
kubernetes/docs/V1APIGroup.md
Normal file
16
kubernetes/docs/V1APIGroup.md
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
# V1APIGroup
|
||||
|
||||
APIGroup contains the name, the supported versions, and the preferred version of a group.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
|
||||
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the kubernetes.client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
|
||||
**name** | **str** | name is the name of the group. |
|
||||
**preferred_version** | [**V1GroupVersionForDiscovery**](V1GroupVersionForDiscovery.md) | | [optional]
|
||||
**server_address_by_client_cid_rs** | [**list[V1ServerAddressByClientCIDR]**](V1ServerAddressByClientCIDR.md) | a map of kubernetes.client CIDR to server address that is serving this group. This is to help kubernetes.clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, kubernetes.clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the kubernetes.client can match. For example: the master will return an internal IP CIDR only, if the kubernetes.client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the kubernetes.client IP. | [optional]
|
||||
**versions** | [**list[V1GroupVersionForDiscovery]**](V1GroupVersionForDiscovery.md) | versions are the versions supported in this group. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
13
kubernetes/docs/V1APIGroupList.md
Normal file
13
kubernetes/docs/V1APIGroupList.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# V1APIGroupList
|
||||
|
||||
APIGroupList is a list of APIGroup, to allow kubernetes.clients to discover the API at /apis.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
|
||||
**groups** | [**list[V1APIGroup]**](V1APIGroup.md) | groups is a list of APIGroup. |
|
||||
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the kubernetes.client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
kubernetes/docs/V1APIResource.md
Normal file
20
kubernetes/docs/V1APIResource.md
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
# V1APIResource
|
||||
|
||||
APIResource specifies the name of a resource and whether it is namespaced.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**categories** | **list[str]** | categories is a list of the grouped resources this resource belongs to (e.g. 'all') | [optional]
|
||||
**group** | **str** | group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale\". | [optional]
|
||||
**kind** | **str** | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo') |
|
||||
**name** | **str** | name is the plural name of the resource. |
|
||||
**namespaced** | **bool** | namespaced indicates if a resource is namespaced or not. |
|
||||
**short_names** | **list[str]** | shortNames is a list of suggested short names of the resource. | [optional]
|
||||
**singular_name** | **str** | singularName is the singular name of the resource. This allows kubernetes.clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface. |
|
||||
**storage_version_hash** | **str** | The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by kubernetes.clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates. | [optional]
|
||||
**verbs** | **list[str]** | verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy) |
|
||||
**version** | **str** | version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)\". | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
kubernetes/docs/V1APIResourceList.md
Normal file
14
kubernetes/docs/V1APIResourceList.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# V1APIResourceList
|
||||
|
||||
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
|
||||
**group_version** | **str** | groupVersion is the group and version this APIResourceList is for. |
|
||||
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the kubernetes.client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
|
||||
**resources** | [**list[V1APIResource]**](V1APIResource.md) | resources contains the name of the resources and if they are namespaced. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
kubernetes/docs/V1APIService.md
Normal file
15
kubernetes/docs/V1APIService.md
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# V1APIService
|
||||
|
||||
APIService represents a server for a particular GroupVersion. Name must be \"version.group\".
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
|
||||
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the kubernetes.client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
|
||||
**metadata** | [**V1ObjectMeta**](V1ObjectMeta.md) | | [optional]
|
||||
**spec** | [**V1APIServiceSpec**](V1APIServiceSpec.md) | | [optional]
|
||||
**status** | [**V1APIServiceStatus**](V1APIServiceStatus.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
kubernetes/docs/V1APIServiceCondition.md
Normal file
15
kubernetes/docs/V1APIServiceCondition.md
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# V1APIServiceCondition
|
||||
|
||||
APIServiceCondition describes the state of an APIService at a particular point
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**last_transition_time** | **datetime** | Last time the condition transitioned from one status to another. | [optional]
|
||||
**message** | **str** | Human-readable message indicating details about last transition. | [optional]
|
||||
**reason** | **str** | Unique, one-word, CamelCase reason for the condition's last transition. | [optional]
|
||||
**status** | **str** | Status is the status of the condition. Can be True, False, Unknown. |
|
||||
**type** | **str** | Type is the type of the condition. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
kubernetes/docs/V1APIServiceList.md
Normal file
14
kubernetes/docs/V1APIServiceList.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# V1APIServiceList
|
||||
|
||||
APIServiceList is a list of APIService objects.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
|
||||
**items** | [**list[V1APIService]**](V1APIService.md) | Items is the list of APIService |
|
||||
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the kubernetes.client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
|
||||
**metadata** | [**V1ListMeta**](V1ListMeta.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
17
kubernetes/docs/V1APIServiceSpec.md
Normal file
17
kubernetes/docs/V1APIServiceSpec.md
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
# V1APIServiceSpec
|
||||
|
||||
APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ca_bundle** | **str** | CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used. | [optional]
|
||||
**group** | **str** | Group is the API group name this server hosts | [optional]
|
||||
**group_priority_minimum** | **int** | GroupPriorityMinimum is the priority this group should have at least. Higher priority means that the group is preferred by kubernetes.clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMinimum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s |
|
||||
**insecure_skip_tls_verify** | **bool** | InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead. | [optional]
|
||||
**service** | [**ApiregistrationV1ServiceReference**](ApiregistrationV1ServiceReference.md) | | [optional]
|
||||
**version** | **str** | Version is the API version this server hosts. For example, \"v1\" | [optional]
|
||||
**version_priority** | **int** | VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is \"kube-like\", it will sort above non \"kube-like\" version strings, which are ordered lexicographically. \"Kube-like\" versions start with a \"v\", then are followed by a number (the major version), then optionally the string \"alpha\" or \"beta\" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
11
kubernetes/docs/V1APIServiceStatus.md
Normal file
11
kubernetes/docs/V1APIServiceStatus.md
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# V1APIServiceStatus
|
||||
|
||||
APIServiceStatus contains derived information about an API server
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**conditions** | [**list[V1APIServiceCondition]**](V1APIServiceCondition.md) | Current service state of apiService. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
kubernetes/docs/V1APIVersions.md
Normal file
14
kubernetes/docs/V1APIVersions.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# V1APIVersions
|
||||
|
||||
APIVersions lists the versions that are available, to allow kubernetes.clients to discover the API at /api, which is the root path of the legacy v1 API.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
|
||||
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the kubernetes.client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
|
||||
**server_address_by_client_cid_rs** | [**list[V1ServerAddressByClientCIDR]**](V1ServerAddressByClientCIDR.md) | a map of kubernetes.client CIDR to server address that is serving this group. This is to help kubernetes.clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, kubernetes.clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the kubernetes.client can match. For example: the master will return an internal IP CIDR only, if the kubernetes.client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the kubernetes.client IP. |
|
||||
**versions** | **list[str]** | versions are the api versions that are available. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
kubernetes/docs/V1AWSElasticBlockStoreVolumeSource.md
Normal file
14
kubernetes/docs/V1AWSElasticBlockStoreVolumeSource.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# V1AWSElasticBlockStoreVolumeSource
|
||||
|
||||
Represents a Persistent Disk resource in AWS. An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**fs_type** | **str** | fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | [optional]
|
||||
**partition** | **int** | partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). | [optional]
|
||||
**read_only** | **bool** | readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | [optional]
|
||||
**volume_id** | **str** | volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
13
kubernetes/docs/V1Affinity.md
Normal file
13
kubernetes/docs/V1Affinity.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# V1Affinity
|
||||
|
||||
Affinity is a group of affinity scheduling rules.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**node_affinity** | [**V1NodeAffinity**](V1NodeAffinity.md) | | [optional]
|
||||
**pod_affinity** | [**V1PodAffinity**](V1PodAffinity.md) | | [optional]
|
||||
**pod_anti_affinity** | [**V1PodAntiAffinity**](V1PodAntiAffinity.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
11
kubernetes/docs/V1AggregationRule.md
Normal file
11
kubernetes/docs/V1AggregationRule.md
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# V1AggregationRule
|
||||
|
||||
AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**cluster_role_selectors** | [**list[V1LabelSelector]**](V1LabelSelector.md) | ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
12
kubernetes/docs/V1AppArmorProfile.md
Normal file
12
kubernetes/docs/V1AppArmorProfile.md
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# V1AppArmorProfile
|
||||
|
||||
AppArmorProfile defines a pod or container's AppArmor settings.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**localhost_profile** | **str** | localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is \"Localhost\". | [optional]
|
||||
**type** | **str** | type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. Unconfined - no AppArmor enforcement. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
12
kubernetes/docs/V1AttachedVolume.md
Normal file
12
kubernetes/docs/V1AttachedVolume.md
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# V1AttachedVolume
|
||||
|
||||
AttachedVolume describes a volume attached to a node
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**device_path** | **str** | DevicePath represents the device path where the volume should be available |
|
||||
**name** | **str** | Name of the attached volume |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
12
kubernetes/docs/V1AuditAnnotation.md
Normal file
12
kubernetes/docs/V1AuditAnnotation.md
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# V1AuditAnnotation
|
||||
|
||||
AuditAnnotation describes how to produce an audit annotation for an API request.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**key** | **str** | key specifies the audit annotation key. The audit annotation keys of a ValidatingAdmissionPolicy must be unique. The key must be a qualified name ([A-Za-z0-9][-A-Za-z0-9_.]*) no more than 63 bytes in length. The key is combined with the resource name of the ValidatingAdmissionPolicy to construct an audit annotation key: \"{ValidatingAdmissionPolicy name}/{key}\". If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy and the same audit annotation key, the annotation key will be identical. In this case, the first annotation written with the key will be included in the audit event and all subsequent annotations with the same key will be discarded. Required. |
|
||||
**value_expression** | **str** | valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. The expression must evaluate to either a string or null value. If the expression evaluates to a string, the audit annotation is included with the string value. If the expression evaluates to null or empty string the audit annotation will be omitted. The valueExpression may be no longer than 5kb in length. If the result of the valueExpression is more than 10kb in length, it will be truncated to 10kb. If multiple ValidatingAdmissionPolicyBinding resources match an API request, then the valueExpression will be evaluated for each binding. All unique values produced by the valueExpressions will be joined together in a comma-separated list. Required. |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
16
kubernetes/docs/V1AzureDiskVolumeSource.md
Normal file
16
kubernetes/docs/V1AzureDiskVolumeSource.md
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
# V1AzureDiskVolumeSource
|
||||
|
||||
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**caching_mode** | **str** | cachingMode is the Host Caching mode: None, Read Only, Read Write. | [optional]
|
||||
**disk_name** | **str** | diskName is the Name of the data disk in the blob storage |
|
||||
**disk_uri** | **str** | diskURI is the URI of data disk in the blob storage |
|
||||
**fs_type** | **str** | fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. | [optional]
|
||||
**kind** | **str** | kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared | [optional]
|
||||
**read_only** | **bool** | readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
kubernetes/docs/V1AzureFilePersistentVolumeSource.md
Normal file
14
kubernetes/docs/V1AzureFilePersistentVolumeSource.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# V1AzureFilePersistentVolumeSource
|
||||
|
||||
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**read_only** | **bool** | readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | [optional]
|
||||
**secret_name** | **str** | secretName is the name of secret that contains Azure Storage Account Name and Key |
|
||||
**secret_namespace** | **str** | secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod | [optional]
|
||||
**share_name** | **str** | shareName is the azure Share Name |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
13
kubernetes/docs/V1AzureFileVolumeSource.md
Normal file
13
kubernetes/docs/V1AzureFileVolumeSource.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# V1AzureFileVolumeSource
|
||||
|
||||
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**read_only** | **bool** | readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. | [optional]
|
||||
**secret_name** | **str** | secretName is the name of secret that contains Azure Storage Account Name and Key |
|
||||
**share_name** | **str** | shareName is the azure share Name |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
kubernetes/docs/V1Binding.md
Normal file
14
kubernetes/docs/V1Binding.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# V1Binding
|
||||
|
||||
Binding ties one object to another; for example, a pod is bound to a node by a scheduler.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
|
||||
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the kubernetes.client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
|
||||
**metadata** | [**V1ObjectMeta**](V1ObjectMeta.md) | | [optional]
|
||||
**target** | [**V1ObjectReference**](V1ObjectReference.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
kubernetes/docs/V1BoundObjectReference.md
Normal file
14
kubernetes/docs/V1BoundObjectReference.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# V1BoundObjectReference
|
||||
|
||||
BoundObjectReference is a reference to an object that a token is bound to.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**api_version** | **str** | API version of the referent. | [optional]
|
||||
**kind** | **str** | Kind of the referent. Valid kinds are 'Pod' and 'Secret'. | [optional]
|
||||
**name** | **str** | Name of the referent. | [optional]
|
||||
**uid** | **str** | UID of the referent. | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
kubernetes/docs/V1CSIDriver.md
Normal file
14
kubernetes/docs/V1CSIDriver.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# V1CSIDriver
|
||||
|
||||
CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
|
||||
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the kubernetes.client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
|
||||
**metadata** | [**V1ObjectMeta**](V1ObjectMeta.md) | | [optional]
|
||||
**spec** | [**V1CSIDriverSpec**](V1CSIDriverSpec.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
14
kubernetes/docs/V1CSIDriverList.md
Normal file
14
kubernetes/docs/V1CSIDriverList.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
# V1CSIDriverList
|
||||
|
||||
CSIDriverList is a collection of CSIDriver objects.
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**api_version** | **str** | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | [optional]
|
||||
**items** | [**list[V1CSIDriver]**](V1CSIDriver.md) | items is the list of CSIDriver |
|
||||
**kind** | **str** | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the kubernetes.client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | [optional]
|
||||
**metadata** | [**V1ListMeta**](V1ListMeta.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show more
Reference in a new issue