Cisco Kubernetes Client

Global

Type Definitions

APISpecification

Specification of an API group

Type:
  • object
Properties:
Name Type Argument Description
name string

Name of the API group
prefix string <optional>

Custom URL prefix for endpoints
spec object.<EndpointSpecification>

Specification of all resource endpoints

EndpointSpecification

Specification of an API resource endpoint

Type:
  • object
Properties:
Name Type Argument Description
kind string

Kubernetes API resource name
nickname string <optional>

Shortened endpoint name
nested Array.<NestedResourceDefinition> <optional>

List of nested resources
options object <optional>

Request overrides for the endpoint

Properties
Name Type Argument Default Description
ns boolean <optional>
 true

Whether the endpoint uses namespaces
methods Array.<string> <optional>

List of valid base methods

KubernetesItem

Entry in a KubernetesList

Type:
  • object
Properties:
Name Type Description
metadata object

Object metadata
spec object

Desired object specification

KubernetesList

List of Kubernetes resource objects

Type:
  • object
Properties:
Name Type Description
items Array.<KubernetesItem>

KubernetesResource

Kubernetes resource object

Type:
  • object
Properties:
Name Type Description
kind string

Kubernetes API resource name
apiVersion string

Reference API version

NestedResourceDefinition

Specification of nested API resource endpoints

Type:
  • object
Properties:
Name Type Description
methods Array.<string>

List of valid methods
resource string

Nested resource name

RequestOptions

Options for an API request method

Additional properties not recognized by the underlying request module are documented below.

Type:
  • object
Properties:
Name Type Argument Description
endpoint string

Target API resource endpoint
method string

Request method verb
body object <optional>

Request body for PUT/POST/PATCH methods
json boolean <optional>

Request body is encoded in JSON format
namespace string <optional>

Namespace for the request
version string <optional>

API version
prefix string <optional>

API path prefix
labels object <optional>

Filter results by label
fields object <optional>

Filter results by field