kubernetes.client.api.custom_objects_api module¶

Kubernetes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: release-1.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class kubernetes.client.api.custom_objects_api.CustomObjectsApi(api_client=None)¶

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

close() → None¶

create_cluster_custom_object()¶

Creates a cluster scoped Custom object

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
plural (str) – The custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
body (object) – The JSON schema of the Resource to create. (required)
pretty (str) – If ‘true’, then the output is pretty printed.
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_cluster_custom_object_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's group name")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's version")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's plural name. For TPRs this would be lowercase plural kind.")], body: Annotated[Dict[str, Any], FieldInfo(annotation=NoneType, required=True, description='The JSON schema of the Resource to create.')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="If 'true', then the output is pretty printed.")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

create_cluster_custom_object

Creates a cluster scoped Custom object

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
plural (str) – The custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
body (object) – The JSON schema of the Resource to create. (required)
pretty (str) – If ‘true’, then the output is pretty printed.
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_namespaced_custom_object()¶

Creates a namespace scoped Custom object

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – The custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
body (object) – The JSON schema of the Resource to create. (required)
pretty (str) – If ‘true’, then the output is pretty printed.
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

create_namespaced_custom_object_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's group name")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's version")], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's namespace")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's plural name. For TPRs this would be lowercase plural kind.")], body: Annotated[Dict[str, Any], FieldInfo(annotation=NoneType, required=True, description='The JSON schema of the Resource to create.')], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="If 'true', then the output is pretty printed.")] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

create_namespaced_custom_object

Creates a namespace scoped Custom object

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – The custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
body (object) – The JSON schema of the Resource to create. (required)
pretty (str) – If ‘true’, then the output is pretty printed.
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_cluster_custom_object()¶

Deletes the specified cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom object’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
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.
orphan_dependents (bool) – Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagation_policy (str) – Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_cluster_custom_object_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

delete_cluster_custom_object

Deletes the specified cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom object’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
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.
orphan_dependents (bool) – Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagation_policy (str) – Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_collection_cluster_custom_object()¶

Delete collection of cluster scoped custom objects

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
plural (str) – The custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
pretty (str) – If ‘true’, then the output is pretty printed.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
grace_period_seconds (int) – The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphan_dependents (bool) – Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagation_policy (str) – Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_collection_cluster_custom_object_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's group name")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's version")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's plural name. For TPRs this would be lowercase plural kind.")], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="If 'true', then the output is pretty printed.")] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

delete_collection_cluster_custom_object

Delete collection of cluster scoped custom objects

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
plural (str) – The custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
pretty (str) – If ‘true’, then the output is pretty printed.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
grace_period_seconds (int) – The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphan_dependents (bool) – Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagation_policy (str) – Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_collection_namespaced_custom_object()¶

Delete collection of namespace scoped custom objects

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – The custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
pretty (str) – If ‘true’, then the output is pretty printed.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
grace_period_seconds (int) – The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphan_dependents (bool) – Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagation_policy (str) – Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_collection_namespaced_custom_object_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's group name")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's version")], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's namespace")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's plural name. For TPRs this would be lowercase plural kind.")], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="If 'true', then the output is pretty printed.")] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

delete_collection_namespaced_custom_object

Delete collection of namespace scoped custom objects

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – The custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
pretty (str) – If ‘true’, then the output is pretty printed.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
grace_period_seconds (int) – The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphan_dependents (bool) – Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagation_policy (str) – Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_namespaced_custom_object()¶

Deletes the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
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.
orphan_dependents (bool) – Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagation_policy (str) – Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

delete_namespaced_custom_object_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's namespace")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], grace_period_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.')] = None, orphan_dependents: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both.')] = None, propagation_policy: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.')] = None, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, body: V1DeleteOptions | None = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

delete_namespaced_custom_object

Deletes the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
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.
orphan_dependents (bool) – Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagation_policy (str) – Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
body (V1DeleteOptions)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_api_resources()¶

get available resources

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_api_resources_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's group name")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's version")], async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[V1APIResourceList, int, Any]¶

get_api_resources

get available resources

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_cluster_custom_object()¶

Returns a cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom object’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_cluster_custom_object_scale()¶

read scale of the specified custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_cluster_custom_object_scale_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

get_cluster_custom_object_scale

read scale of the specified custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_cluster_custom_object_status()¶

read status of the specified cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_cluster_custom_object_status_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

get_cluster_custom_object_status

read status of the specified cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_cluster_custom_object_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

get_cluster_custom_object

Returns a cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom object’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_namespaced_custom_object()¶

Returns a namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_namespaced_custom_object_scale()¶

read scale of the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_namespaced_custom_object_scale_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's namespace")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

get_namespaced_custom_object_scale

read scale of the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_namespaced_custom_object_status()¶

read status of the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_namespaced_custom_object_status_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's namespace")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

get_namespaced_custom_object_status

read status of the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

get_namespaced_custom_object_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's namespace")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

get_namespaced_custom_object

Returns a namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_cluster_custom_object()¶

list or watch cluster scoped custom objects

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
plural (str) – The custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
pretty (str) – If ‘true’, then the output is pretty printed.
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. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
_continue (str) – The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resource_version (str) – When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
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
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_cluster_custom_object_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's group name")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's version")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's plural name. For TPRs this would be lowercase plural kind.")], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="If 'true', then the output is pretty printed.")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.")] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

list_cluster_custom_object

list or watch cluster scoped custom objects

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
plural (str) – The custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
pretty (str) – If ‘true’, then the output is pretty printed.
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. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
_continue (str) – The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resource_version (str) – When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
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
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_custom_object_for_all_namespaces()¶

list or watch namespace scoped custom objects

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
resource_plural (str) – The custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
pretty (str) – If ‘true’, then the output is pretty printed.
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. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
_continue (str) – The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resource_version (str) – When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
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
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_custom_object_for_all_namespaces_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's group name")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's version")], resource_plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's plural name. For TPRs this would be lowercase plural kind.")], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="If 'true', then the output is pretty printed.")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.")] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

list_custom_object_for_all_namespaces

list or watch namespace scoped custom objects

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
resource_plural (str) – The custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
pretty (str) – If ‘true’, then the output is pretty printed.
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. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
_continue (str) – The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resource_version (str) – When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
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
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_namespaced_custom_object()¶

list or watch namespace scoped custom objects

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – The custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
pretty (str) – If ‘true’, then the output is pretty printed.
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. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
_continue (str) – The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resource_version (str) – When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
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
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

list_namespaced_custom_object_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's group name")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's version")], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's namespace")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's plural name. For TPRs this would be lowercase plural kind.")], pretty: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="If 'true', then the output is pretty printed.")] = None, allow_watch_bookmarks: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.')] = None, _continue: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.')] = None, field_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their fields. Defaults to everything.')] = None, label_selector: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='A selector to restrict the list of returned objects by their labels. Defaults to everything.')] = None, limit: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.')] = None, resource_version: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description="When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.")] = None, resource_version_match: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset')] = None, timeout_seconds: Annotated[Annotated[int, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.')] = None, watch: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

list_namespaced_custom_object

list or watch namespace scoped custom objects

Parameters:

group (str) – The custom resource’s group name (required)
version (str) – The custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – The custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
pretty (str) – If ‘true’, then the output is pretty printed.
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. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
_continue (str) – The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
field_selector (str) – A selector to restrict the list of returned objects by their fields. Defaults to everything.
label_selector (str) – A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit (int) – limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resource_version (str) – When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
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
timeout_seconds (int) – Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch (bool) – Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_cluster_custom_object()¶

patch the specified cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom object’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – The JSON schema of the Resource to patch. (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_cluster_custom_object_scale()¶

partially update scale of the specified cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_cluster_custom_object_scale_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

patch_cluster_custom_object_scale

partially update scale of the specified cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_cluster_custom_object_status()¶

partially update status of the specified cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_cluster_custom_object_status_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

patch_cluster_custom_object_status

partially update status of the specified cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_cluster_custom_object_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], body: Annotated[Dict[str, Any] | List[Dict[str, Any]] | BaseModel, FieldInfo(annotation=NoneType, required=True, description='The JSON schema of the Resource to patch.')], dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

patch_cluster_custom_object

patch the specified cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom object’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – The JSON schema of the Resource to patch. (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_namespaced_custom_object()¶

patch the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – The JSON schema of the Resource to patch. (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_namespaced_custom_object_scale()¶

partially update scale of the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_namespaced_custom_object_scale_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's namespace")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

patch_namespaced_custom_object_scale

partially update scale of the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_namespaced_custom_object_status()¶

partially update status of the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_namespaced_custom_object_status_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's namespace")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], body: Dict[str, Any] | List[Dict[str, Any]] | BaseModel, dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

patch_namespaced_custom_object_status

partially update status of the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

patch_namespaced_custom_object_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's namespace")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], body: Annotated[Dict[str, Any] | List[Dict[str, Any]] | BaseModel, FieldInfo(annotation=NoneType, required=True, description='The JSON schema of the Resource to patch.')], dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)')] = None, force: Annotated[Annotated[bool, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

patch_namespaced_custom_object

patch the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – The JSON schema of the Resource to patch. (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (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.
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

replace_cluster_custom_object()¶

replace the specified cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom object’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – The JSON schema of the Resource to replace. (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

replace_cluster_custom_object_scale()¶

replace scale of the specified cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

replace_cluster_custom_object_scale_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], body: Dict[str, Any], dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

replace_cluster_custom_object_scale

replace scale of the specified cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

replace_cluster_custom_object_status()¶

replace status of the cluster scoped specified custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

replace_cluster_custom_object_status_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], body: Dict[str, Any], dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

replace_cluster_custom_object_status

replace status of the cluster scoped specified custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

replace_cluster_custom_object_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], body: Annotated[Dict[str, Any], FieldInfo(annotation=NoneType, required=True, description='The JSON schema of the Resource to replace.')], dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

replace_cluster_custom_object

replace the specified cluster scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
plural (str) – the custom object’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – The JSON schema of the Resource to replace. (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

replace_namespaced_custom_object()¶

replace the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – The JSON schema of the Resource to replace. (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

replace_namespaced_custom_object_scale()¶

replace scale of the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

replace_namespaced_custom_object_scale_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's namespace")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], body: Dict[str, Any], dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

replace_namespaced_custom_object_scale

replace scale of the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

replace_namespaced_custom_object_status()¶

replace status of the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

replace_namespaced_custom_object_status_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's namespace")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], body: Dict[str, Any], dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

replace_namespaced_custom_object_status

replace status of the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

replace_namespaced_custom_object_with_http_info(group: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's group")], version: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's version")], namespace: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="The custom resource's namespace")], plural: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom resource's plural name. For TPRs this would be lowercase plural kind.")], name: Annotated[str, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, description="the custom object's name")], body: Annotated[Dict[str, Any], FieldInfo(annotation=NoneType, required=True, description='The JSON schema of the Resource to replace.')], dry_run: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed')] = None, field_manager: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.')] = None, field_validation: Annotated[Annotated[str, Strict(strict=True)] | None, FieldInfo(annotation=NoneType, required=True, description='fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)')] = None, async_req: bool | None = None, _return_http_data_only: bool | None = None, _preload_content: bool = True, _request_timeout: None | Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])] | Tuple[Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])], Annotated[Annotated[float, Strict(strict=True)] | Annotated[int, Strict(strict=True)], FieldInfo(annotation=NoneType, required=True, metadata=[Gt(gt=0)])]] = None, _request_auth: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _content_type: Annotated[str, Strict(strict=True)] | None = None, _headers: Dict[Annotated[str, Strict(strict=True)], Any] | None = None, _host_index: Annotated[int, Strict(strict=True), FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=0), Le(le=0)])] = 0) → Tuple[object, int, Any]¶

replace_namespaced_custom_object

replace the specified namespace scoped custom object

Parameters:

group (str) – the custom resource’s group (required)
version (str) – the custom resource’s version (required)
namespace (str) – The custom resource’s namespace (required)
plural (str) – the custom resource’s plural name. For TPRs this would be lowercase plural kind. (required)
name (str) – the custom object’s name (required)
body (object) – The JSON schema of the Resource to replace. (required)
dry_run (str) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
field_manager (str) – fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
field_validation (str) – fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional)
async_req (bool, optional) – Whether to execute the request asynchronously.
_return_http_data_only (bool, optional) – only affects with_http_info; ordinary methods always return data only.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns:

Returns the result object.

kubernetes.client.api.custom_objects_api module¶

kubernetes-python-client

Navigation

Related Topics