Class: NgrokAPI::Services::KubernetesOperatorsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/ngrokapi/services/kubernetes_operators_client.rb

Overview

KubernetesOperators is used by the Kubernetes Operator to register and manage its own resource, as well as for users to see active kubernetes clusters.

ngrok.com/docs/api#api-kubernetes-operators

Constant Summary collapse

PATH =

The API path for the requests

'/kubernetes_operators'
LIST_PROPERTY =

The List Property from the resulting API for list calls

'operators'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ KubernetesOperatorsClient

Returns a new instance of KubernetesOperatorsClient.



21
22
23
 
# File 'lib/ngrokapi/services/kubernetes_operators_client.rb', line 21

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



19
20
21
 
# File 'lib/ngrokapi/services/kubernetes_operators_client.rb', line 19

def client
  @client
end

Instance Method Details

#create(description: "", metadata: "", enabled_features: [], region: "", deployment: nil, binding: nil) ⇒ NgrokAPI::Models::KubernetesOperator

Create a new Kubernetes Operator

ngrok.com/docs/api#api-kubernetes-operators-create

Parameters:

  • description (string) (defaults to: "") —

    human-readable description of this Kubernetes Operator. optional, max 255 bytes.

  • metadata (string) (defaults to: "") —

    arbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes.

  • enabled_features (List<string>) (defaults to: []) —

    features enabled for this Kubernetes Operator. a subset of “ingress”, and “gateway”

  • region (string) (defaults to: "") —

    the ngrok region in which the ingress for this operator is served. defaults to “global”

  • deployment (KubernetesOperatorDeployment) (defaults to: nil) —

    information about the deployment of this Kubernetes Operator

  • binding (KubernetesOperatorBindingCreate) (defaults to: nil) —

    configuration for the Bindings feature of this Kubernetes Operator. set only if enabling the “bindings” feature

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/ngrokapi/services/kubernetes_operators_client.rb', line 37

def create(description: "", metadata: "", enabled_features: [], region: "", deployment: nil, binding: nil)
  path = '/kubernetes_operators'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:enabled_features] = enabled_features if enabled_features
  data[:region] = region if region
  data[:deployment] = deployment if deployment
  data[:binding] = binding if binding
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::KubernetesOperator.new(client: self, attrs: result)
end

#create!(description: "", metadata: "", enabled_features: [], region: "", deployment: nil, binding: nil) ⇒ NgrokAPI::Models::KubernetesOperator

Create a new Kubernetes Operator Throws an exception if API error.

ngrok.com/docs/api#api-kubernetes-operators-create

Parameters:

  • description (string) (defaults to: "") —

    human-readable description of this Kubernetes Operator. optional, max 255 bytes.

  • metadata (string) (defaults to: "") —

    arbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes.

  • enabled_features (List<string>) (defaults to: []) —

    features enabled for this Kubernetes Operator. a subset of “ingress”, and “gateway”

  • region (string) (defaults to: "") —

    the ngrok region in which the ingress for this operator is served. defaults to “global”

  • deployment (KubernetesOperatorDeployment) (defaults to: nil) —

    information about the deployment of this Kubernetes Operator

  • binding (KubernetesOperatorBindingCreate) (defaults to: nil) —

    configuration for the Bindings feature of this Kubernetes Operator. set only if enabling the “bindings” feature

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/ngrokapi/services/kubernetes_operators_client.rb', line 65

def create!(description: "", metadata: "", enabled_features: [], region: "", deployment: nil, binding: nil)
  path = '/kubernetes_operators'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:enabled_features] = enabled_features if enabled_features
  data[:region] = region if region
  data[:deployment] = deployment if deployment
  data[:binding] = binding if binding
  result = @client.post(path % replacements, data: data, danger: true)
  NgrokAPI::Models::KubernetesOperator.new(client: self, attrs: result)
end

#delete(id: "") ⇒ NgrokAPI::Models::Empty

Delete a Kubernetes Operator

ngrok.com/docs/api#api-kubernetes-operators-delete

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



146
147
148
149
150
151
152
 
# File 'lib/ngrokapi/services/kubernetes_operators_client.rb', line 146

def delete(id: "")
  path = '/kubernetes_operators/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements)
end

#delete!(id: "") ⇒ NgrokAPI::Models::Empty

Delete a Kubernetes Operator Throws an exception if API error.

ngrok.com/docs/api#api-kubernetes-operators-delete

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



162
163
164
165
166
167
168
 
# File 'lib/ngrokapi/services/kubernetes_operators_client.rb', line 162

def delete!(id: "")
  path = '/kubernetes_operators/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements, danger: true)
end

#get(id: "") ⇒ NgrokAPI::Models::KubernetesOperator

Get of a Kubernetes Operator

ngrok.com/docs/api#api-kubernetes-operators-get

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



177
178
179
180
181
182
183
184
185
 
# File 'lib/ngrokapi/services/kubernetes_operators_client.rb', line 177

def get(id: "")
  path = '/kubernetes_operators/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data)
  NgrokAPI::Models::KubernetesOperator.new(client: self, attrs: result)
end

#get!(id: "") ⇒ NgrokAPI::Models::KubernetesOperator

Get of a Kubernetes Operator Throws an exception if API error.

ngrok.com/docs/api#api-kubernetes-operators-get

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



195
196
197
198
199
200
201
202
203
 
# File 'lib/ngrokapi/services/kubernetes_operators_client.rb', line 195

def get!(id: "")
  path = '/kubernetes_operators/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data, danger: true)
  NgrokAPI::Models::KubernetesOperator.new(client: self, attrs: result)
end

#get_bound_endpoints(id: "", before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List Endpoints bound to a Kubernetes Operator

ngrok.com/docs/api#api-kubernetes-operators-get-bound-endpoints

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/ngrokapi/services/kubernetes_operators_client.rb', line 268

def get_bound_endpoints(id: "", before_id: nil, limit: nil, url: nil)
  path = '/kubernetes_operators/%{id}/bound_endpoints'
  replacements = {
    id: id,
  }
  result = @client.list(
    id: id,
    before_id: before_id,
    limit: limit,
    url: url,
    path: path % replacements
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    attrs: result,
    list_property: 'endpoints',
    klass: NgrokAPI::Models::Endpoint
  )
end

#get_bound_endpoints!(id: "", before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List Endpoints bound to a Kubernetes Operator Throws an exception if API error.

ngrok.com/docs/api#api-kubernetes-operators-get-bound-endpoints

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/ngrokapi/services/kubernetes_operators_client.rb', line 300

def get_bound_endpoints!(id: "", before_id: nil, limit: nil, url: nil)
  path = '/kubernetes_operators/%{id}/bound_endpoints'
  replacements = {
    id: id,
  }
  result = @client.list(
    id: id,
    before_id: before_id,
    limit: limit,
    danger: true,
    url: url,
    path: path % replacements
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    attrs: result,
    list_property: 'endpoints',
    klass: NgrokAPI::Models::Endpoint,
    danger: true
  )
end

#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List all Kubernetes Operators owned by this account

ngrok.com/docs/api#api-kubernetes-operators-list

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/ngrokapi/services/kubernetes_operators_client.rb', line 214

def list(before_id: nil, limit: nil, url: nil)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    attrs: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::KubernetesOperator
  )
end

#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List all Kubernetes Operators owned by this account Throws an exception if API error.

ngrok.com/docs/api#api-kubernetes-operators-list

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/ngrokapi/services/kubernetes_operators_client.rb', line 240

def list!(before_id: nil, limit: nil, url: nil)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    danger: true,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    attrs: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::KubernetesOperator,
    danger: true
  )
end

#update(id: "", description: nil, metadata: nil, enabled_features: nil, region: nil, binding: nil, deployment: nil) ⇒ NgrokAPI::Models::KubernetesOperator

Update an existing Kubernetes operator by ID.

ngrok.com/docs/api#api-kubernetes-operators-update

Parameters:

  • id (string) (defaults to: "") —

    unique identifier for this Kubernetes Operator

  • description (string) (defaults to: nil) —

    human-readable description of this Kubernetes Operator. optional, max 255 bytes.

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes.

  • enabled_features (List<string>) (defaults to: nil) —

    features enabled for this Kubernetes Operator. a subset of “ingress”, and “gateway”

  • region (string) (defaults to: nil) —

    the ngrok region in which the ingress for this operator is served. defaults to “global”

  • binding (KubernetesOperatorBindingUpdate) (defaults to: nil) —

    configuration for the Bindings feature of this Kubernetes Operator. set only if enabling the “bindings” feature

  • deployment (KubernetesOperatorDeploymentUpdate) (defaults to: nil) —

    configuration for the Deployment info

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/ngrokapi/services/kubernetes_operators_client.rb', line 93

def update(id: "", description: nil, metadata: nil, enabled_features: nil, region: nil, binding: nil, deployment: nil)
  path = '/kubernetes_operators/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:enabled_features] = enabled_features if enabled_features
  data[:region] = region if region
  data[:binding] = binding if binding
  data[:deployment] = deployment if deployment
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::KubernetesOperator.new(client: self, attrs: result)
end

#update!(id: "", description: nil, metadata: nil, enabled_features: nil, region: nil, binding: nil, deployment: nil) ⇒ NgrokAPI::Models::KubernetesOperator

Update an existing Kubernetes operator by ID. Throws an exception if API error.

ngrok.com/docs/api#api-kubernetes-operators-update

Parameters:

  • id (string) (defaults to: "") —

    unique identifier for this Kubernetes Operator

  • description (string) (defaults to: nil) —

    human-readable description of this Kubernetes Operator. optional, max 255 bytes.

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes.

  • enabled_features (List<string>) (defaults to: nil) —

    features enabled for this Kubernetes Operator. a subset of “ingress”, and “gateway”

  • region (string) (defaults to: nil) —

    the ngrok region in which the ingress for this operator is served. defaults to “global”

  • binding (KubernetesOperatorBindingUpdate) (defaults to: nil) —

    configuration for the Bindings feature of this Kubernetes Operator. set only if enabling the “bindings” feature

  • deployment (KubernetesOperatorDeploymentUpdate) (defaults to: nil) —

    configuration for the Deployment info

Returns:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/ngrokapi/services/kubernetes_operators_client.rb', line 123

def update!(id: "", description: nil, metadata: nil, enabled_features: nil, region: nil, binding: nil, deployment: nil)
  path = '/kubernetes_operators/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:enabled_features] = enabled_features if enabled_features
  data[:region] = region if region
  data[:binding] = binding if binding
  data[:deployment] = deployment if deployment
  result = @client.patch(path % replacements, data: data, danger: true)
  NgrokAPI::Models::KubernetesOperator.new(client: self, attrs: result)
end