Module: endpoints

endpoints

API Resource Endpoints Module

Classes

Endpoint
Kubernetes API Endpoint
NodesEndpoint
Kubernetes API Endpoint for Nodes
ReplicationControllersEndpoint
Kubernetes API Endpoint for ReplicationControllers
WatchEmitter
Event Emitter for Watch Events

Methods

<static> call(client, resource, nested, options) → {module:endpoints~Endpoint}

Initialize a new Endpoint object with the given configuration

Parameters:
Name Type Description
client module:client.KubernetesClient

Reference to the parent KubernetesClient object

resource string

Resource endpoint name

nested Array.<NestedResourceDefinition>

List of nested endpoints

options object

Endpoint-wide request options

Returns:
Type
module:endpoints~Endpoint

Events

create

Resource has been created

Type:

delete

Resource has been deleted

Type:

error

Error with the watch socket

Type:
  • Error

response

Response from the API server for the established watch socket

Type:
  • object

update

Resource has been modified

Type: