725 lines
32 KiB
Markdown
725 lines
32 KiB
Markdown
# kubernetes.client.AppsV1beta1Api
|
|
|
|
All URIs are relative to *https://localhost*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**create_namespaced_stateful_set**](AppsV1beta1Api.md#create_namespaced_stateful_set) | **POST** /apis/apps/v1beta1/namespaces/{namespace}/statefulsets |
|
|
[**delete_collection_namespaced_stateful_set**](AppsV1beta1Api.md#delete_collection_namespaced_stateful_set) | **DELETE** /apis/apps/v1beta1/namespaces/{namespace}/statefulsets |
|
|
[**delete_namespaced_stateful_set**](AppsV1beta1Api.md#delete_namespaced_stateful_set) | **DELETE** /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name} |
|
|
[**get_api_resources**](AppsV1beta1Api.md#get_api_resources) | **GET** /apis/apps/v1beta1/ |
|
|
[**list_namespaced_stateful_set**](AppsV1beta1Api.md#list_namespaced_stateful_set) | **GET** /apis/apps/v1beta1/namespaces/{namespace}/statefulsets |
|
|
[**list_stateful_set_for_all_namespaces**](AppsV1beta1Api.md#list_stateful_set_for_all_namespaces) | **GET** /apis/apps/v1beta1/statefulsets |
|
|
[**patch_namespaced_stateful_set**](AppsV1beta1Api.md#patch_namespaced_stateful_set) | **PATCH** /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name} |
|
|
[**patch_namespaced_stateful_set_status**](AppsV1beta1Api.md#patch_namespaced_stateful_set_status) | **PATCH** /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status |
|
|
[**read_namespaced_stateful_set**](AppsV1beta1Api.md#read_namespaced_stateful_set) | **GET** /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name} |
|
|
[**read_namespaced_stateful_set_status**](AppsV1beta1Api.md#read_namespaced_stateful_set_status) | **GET** /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status |
|
|
[**replace_namespaced_stateful_set**](AppsV1beta1Api.md#replace_namespaced_stateful_set) | **PUT** /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name} |
|
|
[**replace_namespaced_stateful_set_status**](AppsV1beta1Api.md#replace_namespaced_stateful_set_status) | **PUT** /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status |
|
|
|
|
|
|
# **create_namespaced_stateful_set**
|
|
> V1beta1StatefulSet create_namespaced_stateful_set(namespace, body, pretty=pretty)
|
|
|
|
|
|
|
|
create a StatefulSet
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_statement
|
|
import time
|
|
import kubernetes.client
|
|
from kubernetes.client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: BearerToken
|
|
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = kubernetes.client.AppsV1beta1Api()
|
|
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
|
body = kubernetes.client.V1beta1StatefulSet() # V1beta1StatefulSet |
|
|
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
|
|
|
|
try:
|
|
api_response = api_instance.create_namespaced_stateful_set(namespace, body, pretty=pretty)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling AppsV1beta1Api->create_namespaced_stateful_set: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
|
**body** | [**V1beta1StatefulSet**](V1beta1StatefulSet.md)| |
|
|
**pretty** | **str**| If 'true', then the output is pretty printed. | [optional]
|
|
|
|
### Return type
|
|
|
|
[**V1beta1StatefulSet**](V1beta1StatefulSet.md)
|
|
|
|
### Authorization
|
|
|
|
[BearerToken](../README.md#BearerToken)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: */*
|
|
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
|
|
|
[[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_stateful_set**
|
|
> UnversionedStatus delete_collection_namespaced_stateful_set(namespace, pretty=pretty, field_selector=field_selector, label_selector=label_selector, resource_version=resource_version, timeout_seconds=timeout_seconds, watch=watch)
|
|
|
|
|
|
|
|
delete collection of StatefulSet
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_statement
|
|
import time
|
|
import kubernetes.client
|
|
from kubernetes.client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: BearerToken
|
|
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = kubernetes.client.AppsV1beta1Api()
|
|
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
|
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
|
|
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
|
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
|
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. (optional)
|
|
timeout_seconds = 56 # int | Timeout for the list/watch call. (optional)
|
|
watch = true # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
|
|
|
try:
|
|
api_response = api_instance.delete_collection_namespaced_stateful_set(namespace, pretty=pretty, field_selector=field_selector, label_selector=label_selector, resource_version=resource_version, timeout_seconds=timeout_seconds, watch=watch)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling AppsV1beta1Api->delete_collection_namespaced_stateful_set: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
|
**pretty** | **str**| If 'true', then the output is pretty printed. | [optional]
|
|
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
|
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
|
**resource_version** | **str**| When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | [optional]
|
|
**timeout_seconds** | **int**| Timeout for the list/watch call. | [optional]
|
|
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
|
|
|
### Return type
|
|
|
|
[**UnversionedStatus**](UnversionedStatus.md)
|
|
|
|
### Authorization
|
|
|
|
[BearerToken](../README.md#BearerToken)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: */*
|
|
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
|
|
|
[[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_stateful_set**
|
|
> UnversionedStatus delete_namespaced_stateful_set(name, namespace, body, pretty=pretty, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents)
|
|
|
|
|
|
|
|
delete a StatefulSet
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_statement
|
|
import time
|
|
import kubernetes.client
|
|
from kubernetes.client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: BearerToken
|
|
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = kubernetes.client.AppsV1beta1Api()
|
|
name = 'name_example' # str | name of the StatefulSet
|
|
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
|
body = kubernetes.client.V1DeleteOptions() # V1DeleteOptions |
|
|
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
|
|
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
|
|
orphan_dependents = true # bool | Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. (optional)
|
|
|
|
try:
|
|
api_response = api_instance.delete_namespaced_stateful_set(name, namespace, body, pretty=pretty, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling AppsV1beta1Api->delete_namespaced_stateful_set: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name** | **str**| name of the StatefulSet |
|
|
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
|
**body** | [**V1DeleteOptions**](V1DeleteOptions.md)| |
|
|
**pretty** | **str**| If 'true', then the output is pretty printed. | [optional]
|
|
**grace_period_seconds** | **int**| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional]
|
|
**orphan_dependents** | **bool**| Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. | [optional]
|
|
|
|
### Return type
|
|
|
|
[**UnversionedStatus**](UnversionedStatus.md)
|
|
|
|
### Authorization
|
|
|
|
[BearerToken](../README.md#BearerToken)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: */*
|
|
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
|
|
|
[[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**
|
|
> UnversionedAPIResourceList get_api_resources()
|
|
|
|
|
|
|
|
get available resources
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_statement
|
|
import time
|
|
import kubernetes.client
|
|
from kubernetes.client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: BearerToken
|
|
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = kubernetes.client.AppsV1beta1Api()
|
|
|
|
try:
|
|
api_response = api_instance.get_api_resources()
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling AppsV1beta1Api->get_api_resources: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**UnversionedAPIResourceList**](UnversionedAPIResourceList.md)
|
|
|
|
### Authorization
|
|
|
|
[BearerToken](../README.md#BearerToken)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
|
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **list_namespaced_stateful_set**
|
|
> V1beta1StatefulSetList list_namespaced_stateful_set(namespace, pretty=pretty, field_selector=field_selector, label_selector=label_selector, resource_version=resource_version, timeout_seconds=timeout_seconds, watch=watch)
|
|
|
|
|
|
|
|
list or watch objects of kind StatefulSet
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_statement
|
|
import time
|
|
import kubernetes.client
|
|
from kubernetes.client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: BearerToken
|
|
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = kubernetes.client.AppsV1beta1Api()
|
|
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
|
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
|
|
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
|
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
|
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. (optional)
|
|
timeout_seconds = 56 # int | Timeout for the list/watch call. (optional)
|
|
watch = true # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
|
|
|
try:
|
|
api_response = api_instance.list_namespaced_stateful_set(namespace, pretty=pretty, field_selector=field_selector, label_selector=label_selector, resource_version=resource_version, timeout_seconds=timeout_seconds, watch=watch)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling AppsV1beta1Api->list_namespaced_stateful_set: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
|
**pretty** | **str**| If 'true', then the output is pretty printed. | [optional]
|
|
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
|
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
|
**resource_version** | **str**| When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | [optional]
|
|
**timeout_seconds** | **int**| Timeout for the list/watch call. | [optional]
|
|
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
|
|
|
### Return type
|
|
|
|
[**V1beta1StatefulSetList**](V1beta1StatefulSetList.md)
|
|
|
|
### Authorization
|
|
|
|
[BearerToken](../README.md#BearerToken)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: */*
|
|
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **list_stateful_set_for_all_namespaces**
|
|
> V1beta1StatefulSetList list_stateful_set_for_all_namespaces(field_selector=field_selector, label_selector=label_selector, pretty=pretty, resource_version=resource_version, timeout_seconds=timeout_seconds, watch=watch)
|
|
|
|
|
|
|
|
list or watch objects of kind StatefulSet
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_statement
|
|
import time
|
|
import kubernetes.client
|
|
from kubernetes.client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: BearerToken
|
|
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = kubernetes.client.AppsV1beta1Api()
|
|
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
|
|
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
|
|
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
|
|
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. (optional)
|
|
timeout_seconds = 56 # int | Timeout for the list/watch call. (optional)
|
|
watch = true # bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
|
|
|
|
try:
|
|
api_response = api_instance.list_stateful_set_for_all_namespaces(field_selector=field_selector, label_selector=label_selector, pretty=pretty, resource_version=resource_version, timeout_seconds=timeout_seconds, watch=watch)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling AppsV1beta1Api->list_stateful_set_for_all_namespaces: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**field_selector** | **str**| A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional]
|
|
**label_selector** | **str**| A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional]
|
|
**pretty** | **str**| If 'true', then the output is pretty printed. | [optional]
|
|
**resource_version** | **str**| When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. | [optional]
|
|
**timeout_seconds** | **int**| Timeout for the list/watch call. | [optional]
|
|
**watch** | **bool**| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. | [optional]
|
|
|
|
### Return type
|
|
|
|
[**V1beta1StatefulSetList**](V1beta1StatefulSetList.md)
|
|
|
|
### Authorization
|
|
|
|
[BearerToken](../README.md#BearerToken)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: */*
|
|
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **patch_namespaced_stateful_set**
|
|
> V1beta1StatefulSet patch_namespaced_stateful_set(name, namespace, body, pretty=pretty)
|
|
|
|
|
|
|
|
partially update the specified StatefulSet
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_statement
|
|
import time
|
|
import kubernetes.client
|
|
from kubernetes.client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: BearerToken
|
|
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = kubernetes.client.AppsV1beta1Api()
|
|
name = 'name_example' # str | name of the StatefulSet
|
|
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
|
body = kubernetes.client.UnversionedPatch() # UnversionedPatch |
|
|
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
|
|
|
|
try:
|
|
api_response = api_instance.patch_namespaced_stateful_set(name, namespace, body, pretty=pretty)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling AppsV1beta1Api->patch_namespaced_stateful_set: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name** | **str**| name of the StatefulSet |
|
|
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
|
**body** | [**UnversionedPatch**](UnversionedPatch.md)| |
|
|
**pretty** | **str**| If 'true', then the output is pretty printed. | [optional]
|
|
|
|
### Return type
|
|
|
|
[**V1beta1StatefulSet**](V1beta1StatefulSet.md)
|
|
|
|
### Authorization
|
|
|
|
[BearerToken](../README.md#BearerToken)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
|
|
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **patch_namespaced_stateful_set_status**
|
|
> V1beta1StatefulSet patch_namespaced_stateful_set_status(name, namespace, body, pretty=pretty)
|
|
|
|
|
|
|
|
partially update status of the specified StatefulSet
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_statement
|
|
import time
|
|
import kubernetes.client
|
|
from kubernetes.client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: BearerToken
|
|
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = kubernetes.client.AppsV1beta1Api()
|
|
name = 'name_example' # str | name of the StatefulSet
|
|
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
|
body = kubernetes.client.UnversionedPatch() # UnversionedPatch |
|
|
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
|
|
|
|
try:
|
|
api_response = api_instance.patch_namespaced_stateful_set_status(name, namespace, body, pretty=pretty)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling AppsV1beta1Api->patch_namespaced_stateful_set_status: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name** | **str**| name of the StatefulSet |
|
|
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
|
**body** | [**UnversionedPatch**](UnversionedPatch.md)| |
|
|
**pretty** | **str**| If 'true', then the output is pretty printed. | [optional]
|
|
|
|
### Return type
|
|
|
|
[**V1beta1StatefulSet**](V1beta1StatefulSet.md)
|
|
|
|
### Authorization
|
|
|
|
[BearerToken](../README.md#BearerToken)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
|
|
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **read_namespaced_stateful_set**
|
|
> V1beta1StatefulSet read_namespaced_stateful_set(name, namespace, pretty=pretty, exact=exact, export=export)
|
|
|
|
|
|
|
|
read the specified StatefulSet
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_statement
|
|
import time
|
|
import kubernetes.client
|
|
from kubernetes.client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: BearerToken
|
|
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = kubernetes.client.AppsV1beta1Api()
|
|
name = 'name_example' # str | name of the StatefulSet
|
|
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
|
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
|
|
exact = true # bool | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' (optional)
|
|
export = true # bool | Should this value be exported. Export strips fields that a user can not specify. (optional)
|
|
|
|
try:
|
|
api_response = api_instance.read_namespaced_stateful_set(name, namespace, pretty=pretty, exact=exact, export=export)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling AppsV1beta1Api->read_namespaced_stateful_set: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name** | **str**| name of the StatefulSet |
|
|
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
|
**pretty** | **str**| If 'true', then the output is pretty printed. | [optional]
|
|
**exact** | **bool**| Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' | [optional]
|
|
**export** | **bool**| Should this value be exported. Export strips fields that a user can not specify. | [optional]
|
|
|
|
### Return type
|
|
|
|
[**V1beta1StatefulSet**](V1beta1StatefulSet.md)
|
|
|
|
### Authorization
|
|
|
|
[BearerToken](../README.md#BearerToken)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: */*
|
|
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
|
|
|
[[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_stateful_set_status**
|
|
> V1beta1StatefulSet read_namespaced_stateful_set_status(name, namespace, pretty=pretty)
|
|
|
|
|
|
|
|
read status of the specified StatefulSet
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_statement
|
|
import time
|
|
import kubernetes.client
|
|
from kubernetes.client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: BearerToken
|
|
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = kubernetes.client.AppsV1beta1Api()
|
|
name = 'name_example' # str | name of the StatefulSet
|
|
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
|
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
|
|
|
|
try:
|
|
api_response = api_instance.read_namespaced_stateful_set_status(name, namespace, pretty=pretty)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling AppsV1beta1Api->read_namespaced_stateful_set_status: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name** | **str**| name of the StatefulSet |
|
|
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
|
**pretty** | **str**| If 'true', then the output is pretty printed. | [optional]
|
|
|
|
### Return type
|
|
|
|
[**V1beta1StatefulSet**](V1beta1StatefulSet.md)
|
|
|
|
### Authorization
|
|
|
|
[BearerToken](../README.md#BearerToken)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: */*
|
|
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
|
|
|
[[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_stateful_set**
|
|
> V1beta1StatefulSet replace_namespaced_stateful_set(name, namespace, body, pretty=pretty)
|
|
|
|
|
|
|
|
replace the specified StatefulSet
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_statement
|
|
import time
|
|
import kubernetes.client
|
|
from kubernetes.client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: BearerToken
|
|
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = kubernetes.client.AppsV1beta1Api()
|
|
name = 'name_example' # str | name of the StatefulSet
|
|
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
|
body = kubernetes.client.V1beta1StatefulSet() # V1beta1StatefulSet |
|
|
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
|
|
|
|
try:
|
|
api_response = api_instance.replace_namespaced_stateful_set(name, namespace, body, pretty=pretty)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling AppsV1beta1Api->replace_namespaced_stateful_set: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name** | **str**| name of the StatefulSet |
|
|
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
|
**body** | [**V1beta1StatefulSet**](V1beta1StatefulSet.md)| |
|
|
**pretty** | **str**| If 'true', then the output is pretty printed. | [optional]
|
|
|
|
### Return type
|
|
|
|
[**V1beta1StatefulSet**](V1beta1StatefulSet.md)
|
|
|
|
### Authorization
|
|
|
|
[BearerToken](../README.md#BearerToken)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: */*
|
|
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
|
|
|
[[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_stateful_set_status**
|
|
> V1beta1StatefulSet replace_namespaced_stateful_set_status(name, namespace, body, pretty=pretty)
|
|
|
|
|
|
|
|
replace status of the specified StatefulSet
|
|
|
|
### Example
|
|
```python
|
|
from __future__ import print_statement
|
|
import time
|
|
import kubernetes.client
|
|
from kubernetes.client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Configure API key authorization: BearerToken
|
|
kubernetes.client.configuration.api_key['authorization'] = 'YOUR_API_KEY'
|
|
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
# kubernetes.client.configuration.api_key_prefix['authorization'] = 'Bearer'
|
|
|
|
# create an instance of the API class
|
|
api_instance = kubernetes.client.AppsV1beta1Api()
|
|
name = 'name_example' # str | name of the StatefulSet
|
|
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
|
|
body = kubernetes.client.V1beta1StatefulSet() # V1beta1StatefulSet |
|
|
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
|
|
|
|
try:
|
|
api_response = api_instance.replace_namespaced_stateful_set_status(name, namespace, body, pretty=pretty)
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling AppsV1beta1Api->replace_namespaced_stateful_set_status: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**name** | **str**| name of the StatefulSet |
|
|
**namespace** | **str**| object name and auth scope, such as for teams and projects |
|
|
**body** | [**V1beta1StatefulSet**](V1beta1StatefulSet.md)| |
|
|
**pretty** | **str**| If 'true', then the output is pretty printed. | [optional]
|
|
|
|
### Return type
|
|
|
|
[**V1beta1StatefulSet**](V1beta1StatefulSet.md)
|
|
|
|
### Authorization
|
|
|
|
[BearerToken](../README.md#BearerToken)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: */*
|
|
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
|
|
|
|
[[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)
|
|
|