Class CustomObjectsApi

Hierarchy

CustomObjectsApi

Index

Constructors

constructor

new CustomObjectsApi(basePath?): CustomObjectsApi
Parameters
- Optional basePath: string
Returns CustomObjectsApi
- Defined in src/gen/api/customObjectsApi.ts:47

Properties

`Protected` _basePath

_basePath: string = defaultBasePath

`Protected` _defaultHeaders

_defaultHeaders: any = {}

`Protected` _useQuerystring

_useQuerystring: boolean = false

`Protected` authentications

authentications: {
BearerToken: ApiKeyAuth;
default: Authentication;
} = ...

Type declaration

BearerToken: ApiKeyAuth
default: Authentication

`Protected` interceptors

interceptors: Interceptor[] = []

Accessors

basePath

get basePath(): string
Returns string
- Defined in src/gen/api/customObjectsApi.ts:76
set basePath(basePath): void
Parameters
- basePath: string
Returns void
- Defined in src/gen/api/customObjectsApi.ts:64

defaultHeaders

get defaultHeaders(): any
Returns any
- Defined in src/gen/api/customObjectsApi.ts:72
set defaultHeaders(defaultHeaders): void
Parameters
- defaultHeaders: any
Returns void
- Defined in src/gen/api/customObjectsApi.ts:68

useQuerystring

set useQuerystring(value): void
Parameters
- value: boolean
Returns void
- Defined in src/gen/api/customObjectsApi.ts:60

Methods

addInterceptor

addInterceptor(interceptor): void
Parameters
- interceptor: Interceptor
Returns void
- Defined in src/gen/api/customObjectsApi.ts:88

createClusterCustomObject

createClusterCustomObject(group, version, plural, body, pretty?, dryRun?, fieldManager?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
Creates a cluster scoped Custom object
Parameters
- group: string
  The custom resource's group name
- version: string
  The custom resource's version
- plural: string
  The custom resource's plural name. For TPRs this would be lowercase plural kind.
- body: object
  The JSON schema of the Resource to create.
- Optional pretty: string
  If 'true', then the output is pretty printed.
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional fieldManager: string
  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).
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:102

createNamespacedCustomObject

createNamespacedCustomObject(group, version, namespace, plural, body, pretty?, dryRun?, fieldManager?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
Creates a namespace scoped Custom object
Parameters
- group: string
  The custom resource's group name
- version: string
  The custom resource's version
- namespace: string
  The custom resource's namespace
- plural: string
  The custom resource's plural name. For TPRs this would be lowercase plural kind.
- body: object
  The JSON schema of the Resource to create.
- Optional pretty: string
  If 'true', then the output is pretty printed.
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional fieldManager: string
  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.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:210

deleteClusterCustomObject

deleteClusterCustomObject(group, version, plural, name, gracePeriodSeconds?, orphanDependents?, propagationPolicy?, dryRun?, body?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
Deletes the specified cluster scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- plural: string
  the custom object's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- Optional gracePeriodSeconds: number
  The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
- Optional orphanDependents: boolean
  Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
- Optional propagationPolicy: string
  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.
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional body: V1DeleteOptions
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:325

deleteCollectionClusterCustomObject

deleteCollectionClusterCustomObject(group, version, plural, pretty?, gracePeriodSeconds?, orphanDependents?, propagationPolicy?, dryRun?, body?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
Delete collection of cluster scoped custom objects
Parameters
- group: string
  The custom resource's group name
- version: string
  The custom resource's version
- plural: string
  The custom resource's plural name. For TPRs this would be lowercase plural kind.
- Optional pretty: string
  If 'true', then the output is pretty printed.
- Optional gracePeriodSeconds: number
  The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
- Optional orphanDependents: boolean
  Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
- Optional propagationPolicy: string
  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.
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional body: V1DeleteOptions
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:439

deleteCollectionNamespacedCustomObject

deleteCollectionNamespacedCustomObject(group, version, namespace, plural, pretty?, gracePeriodSeconds?, orphanDependents?, propagationPolicy?, dryRun?, body?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
Delete collection of namespace scoped custom objects
Parameters
- group: string
  The custom resource's group name
- version: string
  The custom resource's version
- namespace: string
  The custom resource's namespace
- plural: string
  The custom resource's plural name. For TPRs this would be lowercase plural kind.
- Optional pretty: string
  If 'true', then the output is pretty printed.
- Optional gracePeriodSeconds: number
  The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
- Optional orphanDependents: boolean
  Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
- Optional propagationPolicy: string
  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.
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional body: V1DeleteOptions
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:552

deleteNamespacedCustomObject

deleteNamespacedCustomObject(group, version, namespace, plural, name, gracePeriodSeconds?, orphanDependents?, propagationPolicy?, dryRun?, body?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
Deletes the specified namespace scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- namespace: string
  The custom resource's namespace
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- Optional gracePeriodSeconds: number
  The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
- Optional orphanDependents: boolean
  Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
- Optional propagationPolicy: string
  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.
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional body: V1DeleteOptions
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:671

getClusterCustomObject

getClusterCustomObject(group, version, plural, name, options?): Promise<{
body: object;
response: IncomingMessage;
}>
Returns a cluster scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- plural: string
  the custom object's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:786

getClusterCustomObjectScale

getClusterCustomObjectScale(group, version, plural, name, options?): Promise<{
body: object;
response: IncomingMessage;
}>
read scale of the specified custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:878

getClusterCustomObjectStatus

getClusterCustomObjectStatus(group, version, plural, name, options?): Promise<{
body: object;
response: IncomingMessage;
}>
read status of the specified cluster scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:970

getNamespacedCustomObject

getNamespacedCustomObject(group, version, namespace, plural, name, options?): Promise<{
body: object;
response: IncomingMessage;
}>
Returns a namespace scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- namespace: string
  The custom resource's namespace
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:1063

getNamespacedCustomObjectScale

getNamespacedCustomObjectScale(group, version, namespace, plural, name, options?): Promise<{
body: object;
response: IncomingMessage;
}>
read scale of the specified namespace scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- namespace: string
  The custom resource's namespace
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:1162

getNamespacedCustomObjectStatus

getNamespacedCustomObjectStatus(group, version, namespace, plural, name, options?): Promise<{
body: object;
response: IncomingMessage;
}>
read status of the specified namespace scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- namespace: string
  The custom resource's namespace
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:1261

listClusterCustomObject

listClusterCustomObject(group, version, plural, pretty?, allowWatchBookmarks?, _continue?, fieldSelector?, labelSelector?, limit?, resourceVersion?, resourceVersionMatch?, timeoutSeconds?, watch?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
list or watch cluster scoped custom objects
Parameters
- group: string
  The custom resource's group name
- version: string
  The custom resource's version
- plural: string
  The custom resource's plural name. For TPRs this would be lowercase plural kind.
- Optional pretty: string
  If 'true', then the output is pretty printed.
- Optional allowWatchBookmarks: boolean
  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.
- Optional _continue: string
  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.
- Optional fieldSelector: string
  A selector to restrict the list of returned objects by their fields. Defaults to everything.
- Optional labelSelector: string
  A selector to restrict the list of returned objects by their labels. Defaults to everything.
- Optional limit: number
  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.
- Optional resourceVersion: string
  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.
- Optional resourceVersionMatch: string
  resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
- Optional timeoutSeconds: number
  Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
- Optional watch: boolean
  Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:1368

listNamespacedCustomObject

listNamespacedCustomObject(group, version, namespace, plural, pretty?, allowWatchBookmarks?, _continue?, fieldSelector?, labelSelector?, limit?, resourceVersion?, resourceVersionMatch?, timeoutSeconds?, watch?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
list or watch namespace scoped custom objects
Parameters
- group: string
  The custom resource's group name
- version: string
  The custom resource's version
- namespace: string
  The custom resource's namespace
- plural: string
  The custom resource's plural name. For TPRs this would be lowercase plural kind.
- Optional pretty: string
  If 'true', then the output is pretty printed.
- Optional allowWatchBookmarks: boolean
  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.
- Optional _continue: string
  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.
- Optional fieldSelector: string
  A selector to restrict the list of returned objects by their fields. Defaults to everything.
- Optional labelSelector: string
  A selector to restrict the list of returned objects by their labels. Defaults to everything.
- Optional limit: number
  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.
- Optional resourceVersion: string
  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.
- Optional resourceVersionMatch: string
  resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
- Optional timeoutSeconds: number
  Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
- Optional watch: boolean
  Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:1504

patchClusterCustomObject

patchClusterCustomObject(group, version, plural, name, body, dryRun?, fieldManager?, force?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
patch the specified cluster scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- plural: string
  the custom object's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- body: object
  The JSON schema of the Resource to patch.
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional fieldManager: string
  fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
- Optional force: boolean
  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.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:1640

patchClusterCustomObjectScale

patchClusterCustomObjectScale(group, version, plural, name, body, dryRun?, fieldManager?, force?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
partially update scale of the specified cluster scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- body: object
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional fieldManager: string
  fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
- Optional force: boolean
  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.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:1754

patchClusterCustomObjectStatus

patchClusterCustomObjectStatus(group, version, plural, name, body, dryRun?, fieldManager?, force?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
partially update status of the specified cluster scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- body: object
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional fieldManager: string
  fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
- Optional force: boolean
  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.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:1868

patchNamespacedCustomObject

patchNamespacedCustomObject(group, version, namespace, plural, name, body, dryRun?, fieldManager?, force?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
patch the specified namespace scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- namespace: string
  The custom resource's namespace
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- body: object
  The JSON schema of the Resource to patch.
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional fieldManager: string
  fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
- Optional force: boolean
  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.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:1983

patchNamespacedCustomObjectScale

patchNamespacedCustomObjectScale(group, version, namespace, plural, name, body, dryRun?, fieldManager?, force?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
partially update scale of the specified namespace scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- namespace: string
  The custom resource's namespace
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- body: object
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional fieldManager: string
  fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
- Optional force: boolean
  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.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:2104

patchNamespacedCustomObjectStatus

patchNamespacedCustomObjectStatus(group, version, namespace, plural, name, body, dryRun?, fieldManager?, force?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
partially update status of the specified namespace scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- namespace: string
  The custom resource's namespace
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- body: object
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional fieldManager: string
  fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
- Optional force: boolean
  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.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:2225

replaceClusterCustomObject

replaceClusterCustomObject(group, version, plural, name, body, dryRun?, fieldManager?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
replace the specified cluster scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- plural: string
  the custom object's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- body: object
  The JSON schema of the Resource to replace.
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional fieldManager: string
  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.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:2344

replaceClusterCustomObjectScale

replaceClusterCustomObjectScale(group, version, plural, name, body, dryRun?, fieldManager?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
replace scale of the specified cluster scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- body: object
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional fieldManager: string
  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.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:2453

replaceClusterCustomObjectStatus

replaceClusterCustomObjectStatus(group, version, plural, name, body, dryRun?, fieldManager?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
replace status of the cluster scoped specified custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- body: object
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional fieldManager: string
  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.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:2562

replaceNamespacedCustomObject

replaceNamespacedCustomObject(group, version, namespace, plural, name, body, dryRun?, fieldManager?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
replace the specified namespace scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- namespace: string
  The custom resource's namespace
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- body: object
  The JSON schema of the Resource to replace.
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional fieldManager: string
  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.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:2672

replaceNamespacedCustomObjectScale

replaceNamespacedCustomObjectScale(group, version, namespace, plural, name, body, dryRun?, fieldManager?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
replace scale of the specified namespace scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- namespace: string
  The custom resource's namespace
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- body: object
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional fieldManager: string
  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.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:2788

replaceNamespacedCustomObjectStatus

replaceNamespacedCustomObjectStatus(group, version, namespace, plural, name, body, dryRun?, fieldManager?, options?): Promise<{
body: object;
response: IncomingMessage;
}>
replace status of the specified namespace scoped custom object
Parameters
- group: string
  the custom resource's group
- version: string
  the custom resource's version
- namespace: string
  The custom resource's namespace
- plural: string
  the custom resource's plural name. For TPRs this would be lowercase plural kind.
- name: string
  the custom object's name
- body: object
- Optional dryRun: string
  When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
- Optional fieldManager: string
  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.
- options: {
      headers: {
          [name: string]: string;
      };
  } = ...
  - headers: {
    [name: string]: string;
    }
    - [name: string]: string
Returns Promise<{
body: object;
response: IncomingMessage;
}>
- Defined in src/gen/api/customObjectsApi.ts:2904

setApiKey

setApiKey(key, value): void
Parameters
- key: BearerToken
- value: string
Returns void
- Defined in src/gen/api/customObjectsApi.ts:84

setDefaultAuthentication

setDefaultAuthentication(auth): void
Parameters
- auth: Authentication
Returns void
- Defined in src/gen/api/customObjectsApi.ts:80

Class CustomObjectsApi

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional basePath: string

Returns CustomObjectsApi

Properties

Protected _basePath

Protected _defaultHeaders

Protected _useQuerystring

Protected authentications

Type declaration

BearerToken: ApiKeyAuth

default: Authentication

Protected interceptors

Accessors

basePath

Returns string

Parameters

basePath: string

Returns void

defaultHeaders

Returns any

Parameters

defaultHeaders: any

Returns void

useQuerystring

Parameters

value: boolean

Returns void

Methods

addInterceptor

Parameters

interceptor: Interceptor

Returns void

createClusterCustomObject

Parameters

group: string

version: string

plural: string

body: object

Optional pretty: string

Optional dryRun: string

Optional fieldManager: string

options: { headers: { [name: string]: string; }; } = ...

headers: { [name: string]: string; }

[name: string]: string

Returns Promise<{ body: object; response: IncomingMessage; }>

createNamespacedCustomObject

Parameters

group: string

version: string

namespace: string

plural: string

body: object

Optional pretty: string

Optional dryRun: string

Optional fieldManager: string

options: { headers: { [name: string]: string; }; } = ...

headers: { [name: string]: string; }

[name: string]: string

Returns Promise<{ body: object; response: IncomingMessage; }>

deleteClusterCustomObject

Parameters

group: string

version: string

plural: string

name: string

Optional gracePeriodSeconds: number

Optional orphanDependents: boolean

Optional propagationPolicy: string

Optional dryRun: string

Optional body: V1DeleteOptions

options: { headers: { [name: string]: string; }; } = ...

`Optional` basePath: string

`Protected` _basePath

`Protected` _defaultHeaders

`Protected` _useQuerystring

`Protected` authentications

`Protected` interceptors

`Optional` pretty: string

`Optional` dryRun: string

`Optional` fieldManager: string

options: {
headers: {
[name: string]: string;
};
} = ...

headers: {
[name: string]: string;
}

Returns Promise<{
body: object;
response: IncomingMessage;
}>

`Optional` pretty: string

`Optional` dryRun: string

`Optional` fieldManager: string

options: {
headers: {
[name: string]: string;
};
} = ...

headers: {
[name: string]: string;
}

Returns Promise<{
body: object;
response: IncomingMessage;
}>

`Optional` gracePeriodSeconds: number

`Optional` orphanDependents: boolean

`Optional` propagationPolicy: string

`Optional` dryRun: string

`Optional` body: V1DeleteOptions

options: {
headers: {
[name: string]: string;
};
} = ...

headers: {
[name: string]: string;
}

Returns Promise<{
body: object;
response: IncomingMessage;
}>

`Optional` pretty: string

`Optional` gracePeriodSeconds: number

`Optional` orphanDependents: boolean

`Optional` propagationPolicy: string

`Optional` dryRun: string

`Optional` body: V1DeleteOptions

options: {
headers: {
[name: string]: string;
};
} = ...

headers: {
[name: string]: string;
}

Returns Promise<{
body: object;
response: IncomingMessage;
}>

`Optional` pretty: string

`Optional` gracePeriodSeconds: number

`Optional` orphanDependents: boolean

`Optional` propagationPolicy: string

`Optional` dryRun: string

`Optional` body: V1DeleteOptions

options: {
headers: {
[name: string]: string;
};
} = ...

headers: {
[name: string]: string;
}

Returns Promise<{
body: object;
response: IncomingMessage;
}>

`Optional` gracePeriodSeconds: number

`Optional` orphanDependents: boolean

`Optional` propagationPolicy: string

`Optional` dryRun: string

`Optional` body: V1DeleteOptions

options: {
headers: {
[name: string]: string;
};
} = ...

headers: {
[name: string]: string;
}

Returns Promise<{
body: object;
response: IncomingMessage;
}>

options: {
headers: {
[name: string]: string;
};
} = ...

headers: {
[name: string]: string;
}

Returns Promise<{
body: object;
response: IncomingMessage;
}>

options: {
headers: {
[name: string]: string;
};
} = ...

headers: {
[name: string]: string;
}

Returns Promise<{
body: object;
response: IncomingMessage;
}>