Class InternalApiserverV1alpha1OperationsExtensions
Extension methods for Kubernetes.
Inherited Members
Namespace: k8s
Assembly: KubernetesClient.dll
Syntax
public static class InternalApiserverV1alpha1OperationsExtensions
Methods
View SourceCreateStorageVersion(IInternalApiserverV1alpha1Operations, V1alpha1StorageVersion, string, string, string, bool?)
create a StorageVersion
Declaration
public static V1alpha1StorageVersion CreateStorageVersion(this IInternalApiserverV1alpha1Operations operations, V1alpha1StorageVersion body, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? pretty = null)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| V1alpha1StorageVersion | body | |
| 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. |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
Returns
| Type | Description |
|---|---|
| V1alpha1StorageVersion |
CreateStorageVersionAsync(IInternalApiserverV1alpha1Operations, V1alpha1StorageVersion, string, string, string, bool?, CancellationToken)
create a StorageVersion
Declaration
public static Task<V1alpha1StorageVersion> CreateStorageVersionAsync(this IInternalApiserverV1alpha1Operations operations, V1alpha1StorageVersion body, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| V1alpha1StorageVersion | body | |
| 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. |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
| CancellationToken | cancellationToken | A CancellationToken which can be used to cancel the asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<V1alpha1StorageVersion> |
DeleteCollectionStorageVersion(IInternalApiserverV1alpha1Operations, V1DeleteOptions, string, string, string, int?, bool?, string, int?, bool?, string, string, string, bool?, int?, bool?)
delete collection of StorageVersion
Declaration
public static V1Status DeleteCollectionStorageVersion(this IInternalApiserverV1alpha1Operations operations, V1DeleteOptions body = null, string continueParameter = null, string dryRun = null, string fieldSelector = null, int? gracePeriodSeconds = null, bool? ignoreStoreReadErrorWithClusterBreakingPotential = null, string labelSelector = null, int? limit = null, bool? orphanDependents = null, string propagationPolicy = null, string resourceVersion = null, string resourceVersionMatch = null, bool? sendInitialEvents = null, int? timeoutSeconds = null, bool? pretty = null)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| V1DeleteOptions | body | |
| 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 | 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. |
| 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? | ignoreStoreReadErrorWithClusterBreakingPotential | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it |
| 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 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. |
| 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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| string | resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
| 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 |
| bool? | sendInitialEvents |
When
Defaults to true if |
| 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. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
Returns
| Type | Description |
|---|---|
| V1Status |
DeleteCollectionStorageVersionAsync(IInternalApiserverV1alpha1Operations, V1DeleteOptions, string, string, string, int?, bool?, string, int?, bool?, string, string, string, bool?, int?, bool?, CancellationToken)
delete collection of StorageVersion
Declaration
public static Task<V1Status> DeleteCollectionStorageVersionAsync(this IInternalApiserverV1alpha1Operations operations, V1DeleteOptions body = null, string continueParameter = null, string dryRun = null, string fieldSelector = null, int? gracePeriodSeconds = null, bool? ignoreStoreReadErrorWithClusterBreakingPotential = null, string labelSelector = null, int? limit = null, bool? orphanDependents = null, string propagationPolicy = null, string resourceVersion = null, string resourceVersionMatch = null, bool? sendInitialEvents = null, int? timeoutSeconds = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| V1DeleteOptions | body | |
| 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 | 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. |
| 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? | ignoreStoreReadErrorWithClusterBreakingPotential | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it |
| 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 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. |
| 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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| string | resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
| 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 |
| bool? | sendInitialEvents |
When
Defaults to true if |
| 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. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
| CancellationToken | cancellationToken | A CancellationToken which can be used to cancel the asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<V1Status> |
DeleteStorageVersion(IInternalApiserverV1alpha1Operations, string, V1DeleteOptions, string, int?, bool?, bool?, string, bool?)
delete a StorageVersion
Declaration
public static V1Status DeleteStorageVersion(this IInternalApiserverV1alpha1Operations operations, string name, V1DeleteOptions body = null, string dryRun = null, int? gracePeriodSeconds = null, bool? ignoreStoreReadErrorWithClusterBreakingPotential = null, bool? orphanDependents = null, string propagationPolicy = null, bool? pretty = null)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| string | name | name of the StorageVersion |
| V1DeleteOptions | body | |
| 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 |
| 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? | ignoreStoreReadErrorWithClusterBreakingPotential | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it |
| 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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
Returns
| Type | Description |
|---|---|
| V1Status |
DeleteStorageVersionAsync(IInternalApiserverV1alpha1Operations, string, V1DeleteOptions, string, int?, bool?, bool?, string, bool?, CancellationToken)
delete a StorageVersion
Declaration
public static Task<V1Status> DeleteStorageVersionAsync(this IInternalApiserverV1alpha1Operations operations, string name, V1DeleteOptions body = null, string dryRun = null, int? gracePeriodSeconds = null, bool? ignoreStoreReadErrorWithClusterBreakingPotential = null, bool? orphanDependents = null, string propagationPolicy = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| string | name | name of the StorageVersion |
| V1DeleteOptions | body | |
| 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 |
| 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? | ignoreStoreReadErrorWithClusterBreakingPotential | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it |
| 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. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
| CancellationToken | cancellationToken | A CancellationToken which can be used to cancel the asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<V1Status> |
GetAPIResources(IInternalApiserverV1alpha1Operations)
get available resources
Declaration
public static V1APIResourceList GetAPIResources(this IInternalApiserverV1alpha1Operations operations)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
Returns
| Type | Description |
|---|---|
| V1APIResourceList |
GetAPIResourcesAsync(IInternalApiserverV1alpha1Operations, CancellationToken)
get available resources
Declaration
public static Task<V1APIResourceList> GetAPIResourcesAsync(this IInternalApiserverV1alpha1Operations operations, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| CancellationToken | cancellationToken | A CancellationToken which can be used to cancel the asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<V1APIResourceList> |
ListStorageVersion(IInternalApiserverV1alpha1Operations, bool?, string, string, string, int?, string, string, bool?, int?, bool?)
list or watch objects of kind StorageVersion
Declaration
public static V1alpha1StorageVersionList ListStorageVersion(this IInternalApiserverV1alpha1Operations operations, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, bool? sendInitialEvents = null, int? timeoutSeconds = null, bool? pretty = null)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| 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. |
| 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 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 | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
| 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 |
| bool? | sendInitialEvents |
When
Defaults to true if |
| 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. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
Returns
| Type | Description |
|---|---|
| V1alpha1StorageVersionList |
ListStorageVersionAsync(IInternalApiserverV1alpha1Operations, bool?, string, string, string, int?, string, string, bool?, int?, bool?, CancellationToken)
list or watch objects of kind StorageVersion
Declaration
public static Task<V1alpha1StorageVersionList> ListStorageVersionAsync(this IInternalApiserverV1alpha1Operations operations, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, bool? sendInitialEvents = null, int? timeoutSeconds = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| 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. |
| 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 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 | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
| 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 |
| bool? | sendInitialEvents |
When
Defaults to true if |
| 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. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
| CancellationToken | cancellationToken | A CancellationToken which can be used to cancel the asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<V1alpha1StorageVersionList> |
PatchStorageVersion(IInternalApiserverV1alpha1Operations, V1Patch, string, string, string, string, bool?, bool?)
partially update the specified StorageVersion
Declaration
public static V1alpha1StorageVersion PatchStorageVersion(this IInternalApiserverV1alpha1Operations operations, V1Patch body, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, bool? pretty = null)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| V1Patch | body | |
| string | name | name of the StorageVersion |
| 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. |
| 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. |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
Returns
| Type | Description |
|---|---|
| V1alpha1StorageVersion |
PatchStorageVersionAsync(IInternalApiserverV1alpha1Operations, V1Patch, string, string, string, string, bool?, bool?, CancellationToken)
partially update the specified StorageVersion
Declaration
public static Task<V1alpha1StorageVersion> PatchStorageVersionAsync(this IInternalApiserverV1alpha1Operations operations, V1Patch body, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| V1Patch | body | |
| string | name | name of the StorageVersion |
| 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. |
| 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. |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
| CancellationToken | cancellationToken | A CancellationToken which can be used to cancel the asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<V1alpha1StorageVersion> |
PatchStorageVersionStatus(IInternalApiserverV1alpha1Operations, V1Patch, string, string, string, string, bool?, bool?)
partially update status of the specified StorageVersion
Declaration
public static V1alpha1StorageVersion PatchStorageVersionStatus(this IInternalApiserverV1alpha1Operations operations, V1Patch body, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, bool? pretty = null)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| V1Patch | body | |
| string | name | name of the StorageVersion |
| 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. |
| 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. |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
Returns
| Type | Description |
|---|---|
| V1alpha1StorageVersion |
PatchStorageVersionStatusAsync(IInternalApiserverV1alpha1Operations, V1Patch, string, string, string, string, bool?, bool?, CancellationToken)
partially update status of the specified StorageVersion
Declaration
public static Task<V1alpha1StorageVersion> PatchStorageVersionStatusAsync(this IInternalApiserverV1alpha1Operations operations, V1Patch body, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? force = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| V1Patch | body | |
| string | name | name of the StorageVersion |
| 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. |
| 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. |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
| CancellationToken | cancellationToken | A CancellationToken which can be used to cancel the asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<V1alpha1StorageVersion> |
ReadStorageVersion(IInternalApiserverV1alpha1Operations, string, bool?)
read the specified StorageVersion
Declaration
public static V1alpha1StorageVersion ReadStorageVersion(this IInternalApiserverV1alpha1Operations operations, string name, bool? pretty = null)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| string | name | name of the StorageVersion |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
Returns
| Type | Description |
|---|---|
| V1alpha1StorageVersion |
ReadStorageVersionAsync(IInternalApiserverV1alpha1Operations, string, bool?, CancellationToken)
read the specified StorageVersion
Declaration
public static Task<V1alpha1StorageVersion> ReadStorageVersionAsync(this IInternalApiserverV1alpha1Operations operations, string name, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| string | name | name of the StorageVersion |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
| CancellationToken | cancellationToken | A CancellationToken which can be used to cancel the asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<V1alpha1StorageVersion> |
ReadStorageVersionStatus(IInternalApiserverV1alpha1Operations, string, bool?)
read status of the specified StorageVersion
Declaration
public static V1alpha1StorageVersion ReadStorageVersionStatus(this IInternalApiserverV1alpha1Operations operations, string name, bool? pretty = null)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| string | name | name of the StorageVersion |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
Returns
| Type | Description |
|---|---|
| V1alpha1StorageVersion |
ReadStorageVersionStatusAsync(IInternalApiserverV1alpha1Operations, string, bool?, CancellationToken)
read status of the specified StorageVersion
Declaration
public static Task<V1alpha1StorageVersion> ReadStorageVersionStatusAsync(this IInternalApiserverV1alpha1Operations operations, string name, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| string | name | name of the StorageVersion |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
| CancellationToken | cancellationToken | A CancellationToken which can be used to cancel the asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<V1alpha1StorageVersion> |
ReplaceStorageVersion(IInternalApiserverV1alpha1Operations, V1alpha1StorageVersion, string, string, string, string, bool?)
replace the specified StorageVersion
Declaration
public static V1alpha1StorageVersion ReplaceStorageVersion(this IInternalApiserverV1alpha1Operations operations, V1alpha1StorageVersion body, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? pretty = null)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| V1alpha1StorageVersion | body | |
| string | name | name of the StorageVersion |
| 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. |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
Returns
| Type | Description |
|---|---|
| V1alpha1StorageVersion |
ReplaceStorageVersionAsync(IInternalApiserverV1alpha1Operations, V1alpha1StorageVersion, string, string, string, string, bool?, CancellationToken)
replace the specified StorageVersion
Declaration
public static Task<V1alpha1StorageVersion> ReplaceStorageVersionAsync(this IInternalApiserverV1alpha1Operations operations, V1alpha1StorageVersion body, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| V1alpha1StorageVersion | body | |
| string | name | name of the StorageVersion |
| 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. |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
| CancellationToken | cancellationToken | A CancellationToken which can be used to cancel the asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<V1alpha1StorageVersion> |
ReplaceStorageVersionStatus(IInternalApiserverV1alpha1Operations, V1alpha1StorageVersion, string, string, string, string, bool?)
replace status of the specified StorageVersion
Declaration
public static V1alpha1StorageVersion ReplaceStorageVersionStatus(this IInternalApiserverV1alpha1Operations operations, V1alpha1StorageVersion body, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? pretty = null)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| V1alpha1StorageVersion | body | |
| string | name | name of the StorageVersion |
| 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. |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
Returns
| Type | Description |
|---|---|
| V1alpha1StorageVersion |
ReplaceStorageVersionStatusAsync(IInternalApiserverV1alpha1Operations, V1alpha1StorageVersion, string, string, string, string, bool?, CancellationToken)
replace status of the specified StorageVersion
Declaration
public static Task<V1alpha1StorageVersion> ReplaceStorageVersionStatusAsync(this IInternalApiserverV1alpha1Operations operations, V1alpha1StorageVersion body, string name, string dryRun = null, string fieldManager = null, string fieldValidation = null, bool? pretty = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| V1alpha1StorageVersion | body | |
| string | name | name of the StorageVersion |
| 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. |
| bool? | pretty | If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
| CancellationToken | cancellationToken | A CancellationToken which can be used to cancel the asynchronous operation. |
Returns
| Type | Description |
|---|---|
| Task<V1alpha1StorageVersion> |
WatchListStorageVersion(IInternalApiserverV1alpha1Operations, bool?, string, string, string, int?, string, string, bool?, int?, bool?, Action<WatchEventType, V1alpha1StorageVersion>, Action<Exception>, Action)
Watch list or watch objects of kind StorageVersion
Declaration
public static Watcher<V1alpha1StorageVersion> WatchListStorageVersion(this IInternalApiserverV1alpha1Operations operations, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, bool? sendInitialEvents = null, int? timeoutSeconds = null, bool? pretty = null, Action<WatchEventType, V1alpha1StorageVersion> onEvent = null, Action<Exception> onError = null, Action onClosed = null)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| 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. |
| 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 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 | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
| 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 |
| bool? | sendInitialEvents |
When
Defaults to true if |
| 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. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
| Action<WatchEventType, V1alpha1StorageVersion> | 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<V1alpha1StorageVersion> |
WatchListStorageVersionAsync(IInternalApiserverV1alpha1Operations, bool?, string, string, string, int?, string, string, bool?, int?, bool?, Action<Exception>, CancellationToken)
Watch list or watch objects of kind StorageVersion as async enumerable
Declaration
public static IAsyncEnumerable<(WatchEventType, V1alpha1StorageVersion)> WatchListStorageVersionAsync(this IInternalApiserverV1alpha1Operations operations, bool? allowWatchBookmarks = null, string continueParameter = null, string fieldSelector = null, string labelSelector = null, int? limit = null, string resourceVersion = null, string resourceVersionMatch = null, bool? sendInitialEvents = null, int? timeoutSeconds = null, bool? pretty = null, Action<Exception> onError = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IInternalApiserverV1alpha1Operations | operations | The operations group for this extension method. |
| 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. |
| 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 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 | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
| 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 |
| bool? | sendInitialEvents |
When
Defaults to true if |
| 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. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). |
| Action<Exception> | onError | Callback when any exception was caught during watching |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| IAsyncEnumerable<(WatchEventType, V1alpha1StorageVersion)> |