Show / Hide Table of Contents

Class CustomObjectsOperationsExtensions

Extension methods for Kubernetes.

Inheritance
object
CustomObjectsOperationsExtensions
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: k8s
Assembly: KubernetesClient.dll
Syntax
public static class CustomObjectsOperationsExtensions

Methods

View Source

CreateClusterCustomObject(ICustomObjectsOperations, object, string, string, string, string, string, string, bool?)

Creates a cluster scoped Custom object

Declaration
public static object CreateClusterCustomObject(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? pretty = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to create.

string group

The custom resource's group name

string version

The custom resource's version

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? pretty

If 'true', then the output is pretty printed.

Returns
Type Description
object
View Source

CreateClusterCustomObjectAsync(ICustomObjectsOperations, object, string, string, string, string, string, string, bool?, CancellationToken)

Creates a cluster scoped Custom object

Declaration
public static Task<object> CreateClusterCustomObjectAsync(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to create.

string group

The custom resource's group name

string version

The custom resource's version

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? pretty

If 'true', then the output is pretty printed.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

CreateClusterCustomObjectAsync<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, bool?, CancellationToken)

Creates a cluster scoped Custom object

Declaration
public static Task<T> CreateClusterCustomObjectAsync<T>(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to create.

string group

The custom resource's group name

string version

The custom resource's version

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? pretty

If 'true', then the output is pretty printed.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

CreateClusterCustomObject<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, bool?)

Creates a cluster scoped Custom object

Declaration
public static T CreateClusterCustomObject<T>(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? pretty = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to create.

string group

The custom resource's group name

string version

The custom resource's version

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? pretty

If 'true', then the output is pretty printed.

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

CreateNamespacedCustomObject(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?)

Creates a namespace scoped Custom object

Declaration
public static object CreateNamespacedCustomObject(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? pretty = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to create.

string group

The custom resource's group name

string version

The custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? pretty

If 'true', then the output is pretty printed.

Returns
Type Description
object
View Source

CreateNamespacedCustomObjectAsync(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?, CancellationToken)

Creates a namespace scoped Custom object

Declaration
public static Task<object> CreateNamespacedCustomObjectAsync(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to create.

string group

The custom resource's group name

string version

The custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? pretty

If 'true', then the output is pretty printed.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

CreateNamespacedCustomObjectAsync<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?, CancellationToken)

Creates a namespace scoped Custom object

Declaration
public static Task<T> CreateNamespacedCustomObjectAsync<T>(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to create.

string group

The custom resource's group name

string version

The custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? pretty

If 'true', then the output is pretty printed.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

CreateNamespacedCustomObject<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?)

Creates a namespace scoped Custom object

Declaration
public static T CreateNamespacedCustomObject<T>(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? pretty = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to create.

string group

The custom resource's group name

string version

The custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? pretty

If 'true', then the output is pretty printed.

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

DeleteClusterCustomObject(ICustomObjectsOperations, string, string, string, string, V1DeleteOptions, int?, bool?, string, string)

Deletes the specified cluster scoped custom object

Declaration
public static object DeleteClusterCustomObject(this ICustomObjectsOperations operations, string group, string version, string plural, string name, V1DeleteOptions body = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

V1DeleteOptions body
int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Returns
Type Description
object
View Source

DeleteClusterCustomObjectAsync(ICustomObjectsOperations, string, string, string, string, V1DeleteOptions, int?, bool?, string, string, CancellationToken)

Deletes the specified cluster scoped custom object

Declaration
public static Task<object> DeleteClusterCustomObjectAsync(this ICustomObjectsOperations operations, string group, string version, string plural, string name, V1DeleteOptions body = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

V1DeleteOptions body
int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

DeleteClusterCustomObjectAsync<T>(ICustomObjectsOperations, string, string, string, string, V1DeleteOptions, int?, bool?, string, string, CancellationToken)

Deletes the specified cluster scoped custom object

Declaration
public static Task<T> DeleteClusterCustomObjectAsync<T>(this ICustomObjectsOperations operations, string group, string version, string plural, string name, V1DeleteOptions body = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

V1DeleteOptions body
int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

DeleteClusterCustomObject<T>(ICustomObjectsOperations, string, string, string, string, V1DeleteOptions, int?, bool?, string, string)

Deletes the specified cluster scoped custom object

Declaration
public static T DeleteClusterCustomObject<T>(this ICustomObjectsOperations operations, string group, string version, string plural, string name, V1DeleteOptions body = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

V1DeleteOptions body
int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

DeleteCollectionClusterCustomObject(ICustomObjectsOperations, string, string, string, V1DeleteOptions, string, int?, bool?, string, string, bool?)

Delete collection of cluster scoped custom objects

Declaration
public static object DeleteCollectionClusterCustomObject(this ICustomObjectsOperations operations, string group, string version, string plural, V1DeleteOptions body = null, string labelSelector = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null, bool? pretty = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

V1DeleteOptions body
string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

bool? pretty

If 'true', then the output is pretty printed.

Returns
Type Description
object
View Source

DeleteCollectionClusterCustomObjectAsync(ICustomObjectsOperations, string, string, string, V1DeleteOptions, string, int?, bool?, string, string, bool?, CancellationToken)

Delete collection of cluster scoped custom objects

Declaration
public static Task<object> DeleteCollectionClusterCustomObjectAsync(this ICustomObjectsOperations operations, string group, string version, string plural, V1DeleteOptions body = null, string labelSelector = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

V1DeleteOptions body
string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

bool? pretty

If 'true', then the output is pretty printed.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

DeleteCollectionClusterCustomObjectAsync<T>(ICustomObjectsOperations, string, string, string, V1DeleteOptions, string, int?, bool?, string, string, bool?, CancellationToken)

Delete collection of cluster scoped custom objects

Declaration
public static Task<T> DeleteCollectionClusterCustomObjectAsync<T>(this ICustomObjectsOperations operations, string group, string version, string plural, V1DeleteOptions body = null, string labelSelector = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

V1DeleteOptions body
string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

bool? pretty

If 'true', then the output is pretty printed.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

DeleteCollectionClusterCustomObject<T>(ICustomObjectsOperations, string, string, string, V1DeleteOptions, string, int?, bool?, string, string, bool?)

Delete collection of cluster scoped custom objects

Declaration
public static T DeleteCollectionClusterCustomObject<T>(this ICustomObjectsOperations operations, string group, string version, string plural, V1DeleteOptions body = null, string labelSelector = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null, bool? pretty = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

V1DeleteOptions body
string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

bool? pretty

If 'true', then the output is pretty printed.

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

DeleteCollectionNamespacedCustomObject(ICustomObjectsOperations, string, string, string, string, V1DeleteOptions, string, int?, bool?, string, string, string, bool?)

Delete collection of namespace scoped custom objects

Declaration
public static object DeleteCollectionNamespacedCustomObject(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, V1DeleteOptions body = null, string labelSelector = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null, string fieldSelector = null, bool? pretty = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

V1DeleteOptions body
string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

bool? pretty

If 'true', then the output is pretty printed.

Returns
Type Description
object
View Source

DeleteCollectionNamespacedCustomObjectAsync(ICustomObjectsOperations, string, string, string, string, V1DeleteOptions, string, int?, bool?, string, string, string, bool?, CancellationToken)

Delete collection of namespace scoped custom objects

Declaration
public static Task<object> DeleteCollectionNamespacedCustomObjectAsync(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, V1DeleteOptions body = null, string labelSelector = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null, string fieldSelector = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

V1DeleteOptions body
string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

bool? pretty

If 'true', then the output is pretty printed.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

DeleteCollectionNamespacedCustomObjectAsync<T>(ICustomObjectsOperations, string, string, string, string, V1DeleteOptions, string, int?, bool?, string, string, string, bool?, CancellationToken)

Delete collection of namespace scoped custom objects

Declaration
public static Task<T> DeleteCollectionNamespacedCustomObjectAsync<T>(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, V1DeleteOptions body = null, string labelSelector = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null, string fieldSelector = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

V1DeleteOptions body
string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

bool? pretty

If 'true', then the output is pretty printed.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

DeleteCollectionNamespacedCustomObject<T>(ICustomObjectsOperations, string, string, string, string, V1DeleteOptions, string, int?, bool?, string, string, string, bool?)

Delete collection of namespace scoped custom objects

Declaration
public static T DeleteCollectionNamespacedCustomObject<T>(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, V1DeleteOptions body = null, string labelSelector = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null, string fieldSelector = null, bool? pretty = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

V1DeleteOptions body
string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

bool? pretty

If 'true', then the output is pretty printed.

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

DeleteNamespacedCustomObject(ICustomObjectsOperations, string, string, string, string, string, V1DeleteOptions, int?, bool?, string, string)

Deletes the specified namespace scoped custom object

Declaration
public static object DeleteNamespacedCustomObject(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name, V1DeleteOptions body = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

V1DeleteOptions body
int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Returns
Type Description
object
View Source

DeleteNamespacedCustomObjectAsync(ICustomObjectsOperations, string, string, string, string, string, V1DeleteOptions, int?, bool?, string, string, CancellationToken)

Deletes the specified namespace scoped custom object

Declaration
public static Task<object> DeleteNamespacedCustomObjectAsync(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name, V1DeleteOptions body = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

V1DeleteOptions body
int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

DeleteNamespacedCustomObjectAsync<T>(ICustomObjectsOperations, string, string, string, string, string, V1DeleteOptions, int?, bool?, string, string, CancellationToken)

Deletes the specified namespace scoped custom object

Declaration
public static Task<T> DeleteNamespacedCustomObjectAsync<T>(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name, V1DeleteOptions body = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

V1DeleteOptions body
int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

DeleteNamespacedCustomObject<T>(ICustomObjectsOperations, string, string, string, string, string, V1DeleteOptions, int?, bool?, string, string)

Deletes the specified namespace scoped custom object

Declaration
public static T DeleteNamespacedCustomObject<T>(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name, V1DeleteOptions body = null, int? gracePeriodSeconds = null, bool? orphanDependents = null, string propagationPolicy = null, string dryRun = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

V1DeleteOptions body
int? gracePeriodSeconds

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.

bool? orphanDependents

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.

string propagationPolicy

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.

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

GetAPIResources(ICustomObjectsOperations, string, string)

get available resources

Declaration
public static V1APIResourceList GetAPIResources(this ICustomObjectsOperations operations, string group, string version)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

Returns
Type Description
V1APIResourceList
View Source

GetAPIResourcesAsync(ICustomObjectsOperations, string, string, CancellationToken)

get available resources

Declaration
public static Task<V1APIResourceList> GetAPIResourcesAsync(this ICustomObjectsOperations operations, string group, string version, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<V1APIResourceList>
View Source

GetClusterCustomObject(ICustomObjectsOperations, string, string, string, string)

Returns a cluster scoped custom object

Declaration
public static object GetClusterCustomObject(this ICustomObjectsOperations operations, string group, string version, string plural, string name)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

Returns
Type Description
object
View Source

GetClusterCustomObjectAsync(ICustomObjectsOperations, string, string, string, string, CancellationToken)

Returns a cluster scoped custom object

Declaration
public static Task<object> GetClusterCustomObjectAsync(this ICustomObjectsOperations operations, string group, string version, string plural, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

GetClusterCustomObjectAsync<T>(ICustomObjectsOperations, string, string, string, string, CancellationToken)

Returns a cluster scoped custom object

Declaration
public static Task<T> GetClusterCustomObjectAsync<T>(this ICustomObjectsOperations operations, string group, string version, string plural, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

GetClusterCustomObjectScale(ICustomObjectsOperations, string, string, string, string)

read scale of the specified custom object

Declaration
public static object GetClusterCustomObjectScale(this ICustomObjectsOperations operations, string group, string version, string plural, string name)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

Returns
Type Description
object
View Source

GetClusterCustomObjectScaleAsync(ICustomObjectsOperations, string, string, string, string, CancellationToken)

read scale of the specified custom object

Declaration
public static Task<object> GetClusterCustomObjectScaleAsync(this ICustomObjectsOperations operations, string group, string version, string plural, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

GetClusterCustomObjectScaleAsync<T>(ICustomObjectsOperations, string, string, string, string, CancellationToken)

read scale of the specified custom object

Declaration
public static Task<T> GetClusterCustomObjectScaleAsync<T>(this ICustomObjectsOperations operations, string group, string version, string plural, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

GetClusterCustomObjectScale<T>(ICustomObjectsOperations, string, string, string, string)

read scale of the specified custom object

Declaration
public static T GetClusterCustomObjectScale<T>(this ICustomObjectsOperations operations, string group, string version, string plural, string name)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

GetClusterCustomObjectStatus(ICustomObjectsOperations, string, string, string, string)

read status of the specified cluster scoped custom object

Declaration
public static object GetClusterCustomObjectStatus(this ICustomObjectsOperations operations, string group, string version, string plural, string name)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

Returns
Type Description
object
View Source

GetClusterCustomObjectStatusAsync(ICustomObjectsOperations, string, string, string, string, CancellationToken)

read status of the specified cluster scoped custom object

Declaration
public static Task<object> GetClusterCustomObjectStatusAsync(this ICustomObjectsOperations operations, string group, string version, string plural, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

GetClusterCustomObjectStatusAsync<T>(ICustomObjectsOperations, string, string, string, string, CancellationToken)

read status of the specified cluster scoped custom object

Declaration
public static Task<T> GetClusterCustomObjectStatusAsync<T>(this ICustomObjectsOperations operations, string group, string version, string plural, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

GetClusterCustomObjectStatus<T>(ICustomObjectsOperations, string, string, string, string)

read status of the specified cluster scoped custom object

Declaration
public static T GetClusterCustomObjectStatus<T>(this ICustomObjectsOperations operations, string group, string version, string plural, string name)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

GetClusterCustomObject<T>(ICustomObjectsOperations, string, string, string, string)

Returns a cluster scoped custom object

Declaration
public static T GetClusterCustomObject<T>(this ICustomObjectsOperations operations, string group, string version, string plural, string name)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

GetNamespacedCustomObject(ICustomObjectsOperations, string, string, string, string, string)

Returns a namespace scoped custom object

Declaration
public static object GetNamespacedCustomObject(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

Returns
Type Description
object
View Source

GetNamespacedCustomObjectAsync(ICustomObjectsOperations, string, string, string, string, string, CancellationToken)

Returns a namespace scoped custom object

Declaration
public static Task<object> GetNamespacedCustomObjectAsync(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

GetNamespacedCustomObjectAsync<T>(ICustomObjectsOperations, string, string, string, string, string, CancellationToken)

Returns a namespace scoped custom object

Declaration
public static Task<T> GetNamespacedCustomObjectAsync<T>(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

GetNamespacedCustomObjectScale(ICustomObjectsOperations, string, string, string, string, string)

read scale of the specified namespace scoped custom object

Declaration
public static object GetNamespacedCustomObjectScale(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

Returns
Type Description
object
View Source

GetNamespacedCustomObjectScaleAsync(ICustomObjectsOperations, string, string, string, string, string, CancellationToken)

read scale of the specified namespace scoped custom object

Declaration
public static Task<object> GetNamespacedCustomObjectScaleAsync(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

GetNamespacedCustomObjectScaleAsync<T>(ICustomObjectsOperations, string, string, string, string, string, CancellationToken)

read scale of the specified namespace scoped custom object

Declaration
public static Task<T> GetNamespacedCustomObjectScaleAsync<T>(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

GetNamespacedCustomObjectScale<T>(ICustomObjectsOperations, string, string, string, string, string)

read scale of the specified namespace scoped custom object

Declaration
public static T GetNamespacedCustomObjectScale<T>(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

GetNamespacedCustomObjectStatus(ICustomObjectsOperations, string, string, string, string, string)

read status of the specified namespace scoped custom object

Declaration
public static object GetNamespacedCustomObjectStatus(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

Returns
Type Description
object
View Source

GetNamespacedCustomObjectStatusAsync(ICustomObjectsOperations, string, string, string, string, string, CancellationToken)

read status of the specified namespace scoped custom object

Declaration
public static Task<object> GetNamespacedCustomObjectStatusAsync(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

GetNamespacedCustomObjectStatusAsync<T>(ICustomObjectsOperations, string, string, string, string, string, CancellationToken)

read status of the specified namespace scoped custom object

Declaration
public static Task<T> GetNamespacedCustomObjectStatusAsync<T>(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

GetNamespacedCustomObjectStatus<T>(ICustomObjectsOperations, string, string, string, string, string)

read status of the specified namespace scoped custom object

Declaration
public static T GetNamespacedCustomObjectStatus<T>(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

GetNamespacedCustomObject<T>(ICustomObjectsOperations, string, string, string, string, string)

Returns a namespace scoped custom object

Declaration
public static T GetNamespacedCustomObject<T>(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, string name)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

ListClusterCustomObject(ICustomObjectsOperations, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?)

list or watch cluster scoped custom objects

Declaration
public static object ListClusterCustomObject(this ICustomObjectsOperations operations, string group, string version, string plural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

Returns
Type Description
object
View Source

ListClusterCustomObjectAsync(ICustomObjectsOperations, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?, CancellationToken)

list or watch cluster scoped custom objects

Declaration
public static Task<object> ListClusterCustomObjectAsync(this ICustomObjectsOperations operations, string group, string version, string plural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

ListClusterCustomObjectAsync<T>(ICustomObjectsOperations, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?, CancellationToken)

list or watch cluster scoped custom objects

Declaration
public static Task<T> ListClusterCustomObjectAsync<T>(this ICustomObjectsOperations operations, string group, string version, string plural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

ListClusterCustomObject<T>(ICustomObjectsOperations, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?)

list or watch cluster scoped custom objects

Declaration
public static T ListClusterCustomObject<T>(this ICustomObjectsOperations operations, string group, string version, string plural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

ListCustomObjectForAllNamespaces(ICustomObjectsOperations, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?)

list or watch namespace scoped custom objects

Declaration
public static object ListCustomObjectForAllNamespaces(this ICustomObjectsOperations operations, string group, string version, string resourcePlural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string resourcePlural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

Returns
Type Description
object
View Source

ListCustomObjectForAllNamespacesAsync(ICustomObjectsOperations, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?, CancellationToken)

list or watch namespace scoped custom objects

Declaration
public static Task<object> ListCustomObjectForAllNamespacesAsync(this ICustomObjectsOperations operations, string group, string version, string resourcePlural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string resourcePlural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

ListCustomObjectForAllNamespacesAsync<T>(ICustomObjectsOperations, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?, CancellationToken)

list or watch namespace scoped custom objects

Declaration
public static Task<T> ListCustomObjectForAllNamespacesAsync<T>(this ICustomObjectsOperations operations, string group, string version, string resourcePlural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string resourcePlural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

ListCustomObjectForAllNamespaces<T>(ICustomObjectsOperations, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?)

list or watch namespace scoped custom objects

Declaration
public static T ListCustomObjectForAllNamespaces<T>(this ICustomObjectsOperations operations, string group, string version, string resourcePlural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string resourcePlural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

ListNamespacedCustomObject(ICustomObjectsOperations, string, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?)

list or watch namespace scoped custom objects

Declaration
public static object ListNamespacedCustomObject(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

Returns
Type Description
object
View Source

ListNamespacedCustomObjectAsync(ICustomObjectsOperations, string, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?, CancellationToken)

list or watch namespace scoped custom objects

Declaration
public static Task<object> ListNamespacedCustomObjectAsync(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

ListNamespacedCustomObjectAsync<T>(ICustomObjectsOperations, string, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?, CancellationToken)

list or watch namespace scoped custom objects

Declaration
public static Task<T> ListNamespacedCustomObjectAsync<T>(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

ListNamespacedCustomObject<T>(ICustomObjectsOperations, string, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?)

list or watch namespace scoped custom objects

Declaration
public static T ListNamespacedCustomObject<T>(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

PatchClusterCustomObject(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?)

patch the specified cluster scoped custom object

Declaration
public static object PatchClusterCustomObject(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to patch.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

Returns
Type Description
object
View Source

PatchClusterCustomObjectAsync(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?, CancellationToken)

patch the specified cluster scoped custom object

Declaration
public static Task<object> PatchClusterCustomObjectAsync(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to patch.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

PatchClusterCustomObjectAsync<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?, CancellationToken)

patch the specified cluster scoped custom object

Declaration
public static Task<T> PatchClusterCustomObjectAsync<T>(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to patch.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

PatchClusterCustomObjectScale(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?)

partially update scale of the specified cluster scoped custom object

Declaration
public static object PatchClusterCustomObjectScale(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

Returns
Type Description
object
View Source

PatchClusterCustomObjectScaleAsync(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?, CancellationToken)

partially update scale of the specified cluster scoped custom object

Declaration
public static Task<object> PatchClusterCustomObjectScaleAsync(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

PatchClusterCustomObjectScaleAsync<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?, CancellationToken)

partially update scale of the specified cluster scoped custom object

Declaration
public static Task<T> PatchClusterCustomObjectScaleAsync<T>(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

PatchClusterCustomObjectScale<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?)

partially update scale of the specified cluster scoped custom object

Declaration
public static T PatchClusterCustomObjectScale<T>(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

PatchClusterCustomObjectStatus(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?)

partially update status of the specified cluster scoped custom object

Declaration
public static object PatchClusterCustomObjectStatus(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

Returns
Type Description
object
View Source

PatchClusterCustomObjectStatusAsync(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?, CancellationToken)

partially update status of the specified cluster scoped custom object

Declaration
public static Task<object> PatchClusterCustomObjectStatusAsync(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

PatchClusterCustomObjectStatusAsync<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?, CancellationToken)

partially update status of the specified cluster scoped custom object

Declaration
public static Task<T> PatchClusterCustomObjectStatusAsync<T>(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

PatchClusterCustomObjectStatus<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?)

partially update status of the specified cluster scoped custom object

Declaration
public static T PatchClusterCustomObjectStatus<T>(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

PatchClusterCustomObject<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, bool?)

patch the specified cluster scoped custom object

Declaration
public static T PatchClusterCustomObject<T>(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to patch.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

PatchNamespacedCustomObject(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, bool?)

patch the specified namespace scoped custom object

Declaration
public static object PatchNamespacedCustomObject(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to patch.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

Returns
Type Description
object
View Source

PatchNamespacedCustomObjectAsync(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, bool?, CancellationToken)

patch the specified namespace scoped custom object

Declaration
public static Task<object> PatchNamespacedCustomObjectAsync(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to patch.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

PatchNamespacedCustomObjectAsync<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, bool?, CancellationToken)

patch the specified namespace scoped custom object

Declaration
public static Task<T> PatchNamespacedCustomObjectAsync<T>(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to patch.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

PatchNamespacedCustomObjectScale(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, bool?)

partially update scale of the specified namespace scoped custom object

Declaration
public static object PatchNamespacedCustomObjectScale(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

Returns
Type Description
object
View Source

PatchNamespacedCustomObjectScaleAsync(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, bool?, CancellationToken)

partially update scale of the specified namespace scoped custom object

Declaration
public static Task<object> PatchNamespacedCustomObjectScaleAsync(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

PatchNamespacedCustomObjectScaleAsync<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, bool?, CancellationToken)

partially update scale of the specified namespace scoped custom object

Declaration
public static Task<T> PatchNamespacedCustomObjectScaleAsync<T>(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

PatchNamespacedCustomObjectScale<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, bool?)

partially update scale of the specified namespace scoped custom object

Declaration
public static T PatchNamespacedCustomObjectScale<T>(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

PatchNamespacedCustomObjectStatus(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, bool?)

partially update status of the specified namespace scoped custom object

Declaration
public static object PatchNamespacedCustomObjectStatus(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

Returns
Type Description
object
View Source

PatchNamespacedCustomObjectStatusAsync(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, bool?, CancellationToken)

partially update status of the specified namespace scoped custom object

Declaration
public static Task<object> PatchNamespacedCustomObjectStatusAsync(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

PatchNamespacedCustomObjectStatusAsync<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, bool?, CancellationToken)

partially update status of the specified namespace scoped custom object

Declaration
public static Task<T> PatchNamespacedCustomObjectStatusAsync<T>(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

PatchNamespacedCustomObjectStatus<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, bool?)

partially update status of the specified namespace scoped custom object

Declaration
public static T PatchNamespacedCustomObjectStatus<T>(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

PatchNamespacedCustomObject<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, bool?)

patch the specified namespace scoped custom object

Declaration
public static T PatchNamespacedCustomObject<T>(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to patch.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. 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).

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

bool? force

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.

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

ReplaceClusterCustomObject(ICustomObjectsOperations, object, string, string, string, string, string, string, string)

replace the specified cluster scoped custom object

Declaration
public static object ReplaceClusterCustomObject(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to replace.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

Returns
Type Description
object
View Source

ReplaceClusterCustomObjectAsync(ICustomObjectsOperations, object, string, string, string, string, string, string, string, CancellationToken)

replace the specified cluster scoped custom object

Declaration
public static Task<object> ReplaceClusterCustomObjectAsync(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to replace.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

ReplaceClusterCustomObjectAsync<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, CancellationToken)

replace the specified cluster scoped custom object

Declaration
public static Task<T> ReplaceClusterCustomObjectAsync<T>(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to replace.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

ReplaceClusterCustomObjectScale(ICustomObjectsOperations, object, string, string, string, string, string, string, string)

replace scale of the specified cluster scoped custom object

Declaration
public static object ReplaceClusterCustomObjectScale(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

Returns
Type Description
object
View Source

ReplaceClusterCustomObjectScaleAsync(ICustomObjectsOperations, object, string, string, string, string, string, string, string, CancellationToken)

replace scale of the specified cluster scoped custom object

Declaration
public static Task<object> ReplaceClusterCustomObjectScaleAsync(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

ReplaceClusterCustomObjectScaleAsync<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, CancellationToken)

replace scale of the specified cluster scoped custom object

Declaration
public static Task<T> ReplaceClusterCustomObjectScaleAsync<T>(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

ReplaceClusterCustomObjectScale<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string)

replace scale of the specified cluster scoped custom object

Declaration
public static T ReplaceClusterCustomObjectScale<T>(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

ReplaceClusterCustomObjectStatus(ICustomObjectsOperations, object, string, string, string, string, string, string, string)

replace status of the cluster scoped specified custom object

Declaration
public static object ReplaceClusterCustomObjectStatus(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

Returns
Type Description
object
View Source

ReplaceClusterCustomObjectStatusAsync(ICustomObjectsOperations, object, string, string, string, string, string, string, string, CancellationToken)

replace status of the cluster scoped specified custom object

Declaration
public static Task<object> ReplaceClusterCustomObjectStatusAsync(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

ReplaceClusterCustomObjectStatusAsync<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, CancellationToken)

replace status of the cluster scoped specified custom object

Declaration
public static Task<T> ReplaceClusterCustomObjectStatusAsync<T>(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

ReplaceClusterCustomObjectStatus<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string)

replace status of the cluster scoped specified custom object

Declaration
public static T ReplaceClusterCustomObjectStatus<T>(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

ReplaceClusterCustomObject<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string)

replace the specified cluster scoped custom object

Declaration
public static T ReplaceClusterCustomObject<T>(this ICustomObjectsOperations operations, object body, string group, string version, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to replace.

string group

the custom resource's group

string version

the custom resource's version

string plural

the custom object's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

ReplaceNamespacedCustomObject(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string)

replace the specified namespace scoped custom object

Declaration
public static object ReplaceNamespacedCustomObject(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to replace.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

Returns
Type Description
object
View Source

ReplaceNamespacedCustomObjectAsync(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, CancellationToken)

replace the specified namespace scoped custom object

Declaration
public static Task<object> ReplaceNamespacedCustomObjectAsync(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to replace.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

ReplaceNamespacedCustomObjectAsync<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, CancellationToken)

replace the specified namespace scoped custom object

Declaration
public static Task<T> ReplaceNamespacedCustomObjectAsync<T>(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to replace.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

ReplaceNamespacedCustomObjectScale(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string)

replace scale of the specified namespace scoped custom object

Declaration
public static object ReplaceNamespacedCustomObjectScale(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

Returns
Type Description
object
View Source

ReplaceNamespacedCustomObjectScaleAsync(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, CancellationToken)

replace scale of the specified namespace scoped custom object

Declaration
public static Task<object> ReplaceNamespacedCustomObjectScaleAsync(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

ReplaceNamespacedCustomObjectScaleAsync<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, CancellationToken)

replace scale of the specified namespace scoped custom object

Declaration
public static Task<T> ReplaceNamespacedCustomObjectScaleAsync<T>(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

ReplaceNamespacedCustomObjectScale<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string)

replace scale of the specified namespace scoped custom object

Declaration
public static T ReplaceNamespacedCustomObjectScale<T>(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

ReplaceNamespacedCustomObjectStatus(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string)

replace status of the specified namespace scoped custom object

Declaration
public static object ReplaceNamespacedCustomObjectStatus(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

Returns
Type Description
object
View Source

ReplaceNamespacedCustomObjectStatusAsync(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, CancellationToken)

replace status of the specified namespace scoped custom object

Declaration
public static Task<object> ReplaceNamespacedCustomObjectStatusAsync(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<object>
View Source

ReplaceNamespacedCustomObjectStatusAsync<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string, CancellationToken)

replace status of the specified namespace scoped custom object

Declaration
public static Task<T> ReplaceNamespacedCustomObjectStatusAsync<T>(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

CancellationToken cancellationToken

A CancellationToken which can be used to cancel the asynchronous operation.

Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

ReplaceNamespacedCustomObjectStatus<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string)

replace status of the specified namespace scoped custom object

Declaration
public static T ReplaceNamespacedCustomObjectStatus<T>(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body
string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

ReplaceNamespacedCustomObject<T>(ICustomObjectsOperations, object, string, string, string, string, string, string, string, string)

replace the specified namespace scoped custom object

Declaration
public static T ReplaceNamespacedCustomObject<T>(this ICustomObjectsOperations operations, object body, string group, string version, string namespaceParameter, string plural, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

object body

The JSON schema of the Resource to replace.

string group

the custom resource's group

string version

the custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

the custom resource's plural name. For TPRs this would be lowercase plural kind.

string name

the custom object's name

string dryRun

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

string fieldManager

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

string fieldValidation

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped 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)

Returns
Type Description
T
Type Parameters
Name Description
T
View Source

WatchListClusterCustomObject(ICustomObjectsOperations, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?, Action<WatchEventType, object>, Action<Exception>, Action)

Watch list or watch cluster scoped custom objects

Declaration
public static Watcher<object> WatchListClusterCustomObject(this ICustomObjectsOperations operations, string group, string version, string plural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null, Action<WatchEventType, object> onEvent = null, Action<Exception> onError = null, Action onClosed = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

Action<WatchEventType, object> onEvent

Callback when any event raised from api server

Action<Exception> onError

Callback when any exception was caught during watching

Action onClosed

Callback when the server closes the connection

Returns
Type Description
Watcher<object>
View Source

WatchListClusterCustomObjectAsync(ICustomObjectsOperations, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?, Action<Exception>, CancellationToken)

Watch list or watch cluster scoped custom objects as async enumerable

Declaration
public static IAsyncEnumerable<(WatchEventType, object)> WatchListClusterCustomObjectAsync(this ICustomObjectsOperations operations, string group, string version, string plural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null, Action<Exception> onError = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

Action<Exception> onError

Callback when any exception was caught during watching

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
IAsyncEnumerable<(WatchEventType, object)>
View Source

WatchListCustomObjectForAllNamespaces(ICustomObjectsOperations, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?, Action<WatchEventType, object>, Action<Exception>, Action)

Watch list or watch namespace scoped custom objects

Declaration
public static Watcher<object> WatchListCustomObjectForAllNamespaces(this ICustomObjectsOperations operations, string group, string version, string resourcePlural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null, Action<WatchEventType, object> onEvent = null, Action<Exception> onError = null, Action onClosed = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string resourcePlural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

Action<WatchEventType, object> onEvent

Callback when any event raised from api server

Action<Exception> onError

Callback when any exception was caught during watching

Action onClosed

Callback when the server closes the connection

Returns
Type Description
Watcher<object>
View Source

WatchListCustomObjectForAllNamespacesAsync(ICustomObjectsOperations, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?, Action<Exception>, CancellationToken)

Watch list or watch namespace scoped custom objects as async enumerable

Declaration
public static IAsyncEnumerable<(WatchEventType, object)> WatchListCustomObjectForAllNamespacesAsync(this ICustomObjectsOperations operations, string group, string version, string resourcePlural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null, Action<Exception> onError = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string resourcePlural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

Action<Exception> onError

Callback when any exception was caught during watching

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
IAsyncEnumerable<(WatchEventType, object)>
View Source

WatchListNamespacedCustomObject(ICustomObjectsOperations, string, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?, Action<WatchEventType, object>, Action<Exception>, Action)

Watch list or watch namespace scoped custom objects

Declaration
public static Watcher<object> WatchListNamespacedCustomObject(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null, Action<WatchEventType, object> onEvent = null, Action<Exception> onError = null, Action onClosed = null)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

Action<WatchEventType, object> onEvent

Callback when any event raised from api server

Action<Exception> onError

Callback when any exception was caught during watching

Action onClosed

Callback when the server closes the connection

Returns
Type Description
Watcher<object>
View Source

WatchListNamespacedCustomObjectAsync(ICustomObjectsOperations, string, string, string, string, bool?, string, string, string, int?, string, string, int?, bool?, Action<Exception>, CancellationToken)

Watch list or watch namespace scoped custom objects as async enumerable

Declaration
public static IAsyncEnumerable<(WatchEventType, object)> WatchListNamespacedCustomObjectAsync(this ICustomObjectsOperations operations, string group, string version, string namespaceParameter, string plural, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, int? timeoutSeconds = null, bool? pretty = null, Action<Exception> onError = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ICustomObjectsOperations operations

The operations group for this extension method.

string group

The custom resource's group name

string version

The custom resource's version

string namespaceParameter

The custom resource's namespace

string plural

The custom resource's plural name. For TPRs this would be lowercase plural kind.

bool? allowWatchBookmarks

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.

string continueParameter

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.

string fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

string labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

int? limit

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.

string resourceVersion

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.

string resourceVersionMatch

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

int? timeoutSeconds

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

bool? pretty

If 'true', then the output is pretty printed.

Action<Exception> onError

Callback when any exception was caught during watching

CancellationToken cancellationToken

Cancellation token

Returns
Type Description
IAsyncEnumerable<(WatchEventType, object)>
  • View Source
In this article
Back to top Generated by DocFX