k8s v1.1.1

View Source K8s.Resource.FieldAccessors (k8s v1.1.1)

Helper functions for accessing common fields

Link to this section Summary

Functions

annotation(resource, name)

Returns the value of a k8s resource's annotation.

annotations(resource)

Returns the annotations of k8s resource.

api_version(resource)

Returns the apiVersion of k8s resource.

has_annotation?(resource, name)

Check if an annotation is present.

has_label?(resource, name)

Check if a label is present.

kind(resource)

Returns the kind of k8s resource.

label(resource, name)

Returns the value of a k8s resource's label.

labels(resource)

Returns the labels of k8s resource.

metadata(resource)

Returns the metadata of k8s resource.

name(resource)

Returns the name of k8s resource.

namespace(resource)

Returns the namespace of k8s resource.

Link to this section Functions

Link to this function

annotation(resource, name)

View Source

Specs

annotation(map(), binary()) :: binary() | nil

Returns the value of a k8s resource's annotation.

examples

 Examples 

iex> K8s.Resource.FieldAccessors.annotation(%{"metadata" => %{"annotations" => %{"env" => "test"}}}, "env")
"test"
Link to this function

annotations(resource)

View Source

Specs

annotations(map()) :: map()

Returns the annotations of k8s resource.

examples

 Examples 

iex> K8s.Resource.FieldAccessors.annotations(%{"metadata" => %{"annotations" => %{"env" => "test"}}})
%{"env" => "test"}
Link to this function

api_version(resource)

View Source

Specs

api_version(map()) :: binary() | nil

Returns the apiVersion of k8s resource.

examples

 Examples 

iex> K8s.Resource.FieldAccessors.api_version(%{"apiVersion" => "apps/v1"})
"apps/v1"
Link to this function

has_annotation?(resource, name)

View Source

Specs

has_annotation?(map(), binary()) :: boolean()

Check if an annotation is present.

examples

 Examples 

iex> K8s.Resource.FieldAccessors.has_annotation?(%{"metadata" => %{"annotations" => %{"env" => "test"}}}, "env")
true

iex> K8s.Resource.FieldAccessors.has_annotation?(%{"metadata" => %{"annotations" => %{"env" => "test"}}}, "foo")
false
Link to this function

has_label?(resource, name)

View Source

Specs

has_label?(map(), binary()) :: boolean()

Check if a label is present.

examples

 Examples 

iex> K8s.Resource.FieldAccessors.has_label?(%{"metadata" => %{"labels" => %{"env" => "test"}}}, "env")
true

iex> K8s.Resource.FieldAccessors.has_label?(%{"metadata" => %{"labels" => %{"env" => "test"}}}, "foo")
false
Link to this function

kind(resource)

View Source

Specs

kind(map()) :: binary() | nil

Returns the kind of k8s resource.

examples

 Examples 

iex> K8s.Resource.FieldAccessors.kind(%{"kind" => "Deployment"})
"Deployment"
Link to this function

label(resource, name)

View Source

Specs

label(map(), binary()) :: binary() | nil

Returns the value of a k8s resource's label.

examples

 Examples 

iex> K8s.Resource.FieldAccessors.label(%{"metadata" => %{"labels" => %{"env" => "test"}}}, "env")
"test"
Link to this function

labels(resource)

View Source

Specs

labels(map()) :: map()

Returns the labels of k8s resource.

examples

 Examples 

iex> K8s.Resource.FieldAccessors.labels(%{"metadata" => %{"labels" => %{"env" => "test"}}})
%{"env" => "test"}
Link to this function

metadata(resource)

View Source

Specs

metadata(map()) :: map() | nil

Returns the metadata of k8s resource.

examples

 Examples 

iex> K8s.Resource.FieldAccessors.metadata(%{"metadata" => %{"name" => "nginx", "namespace" => "foo"}})
%{"name" => "nginx", "namespace" => "foo"}
Link to this function

name(resource)

View Source

Specs

name(map()) :: binary() | nil

Returns the name of k8s resource.

examples

 Examples 

iex> K8s.Resource.FieldAccessors.name(%{"metadata" => %{"name" => "nginx", "namespace" => "foo"}})
"nginx"
Link to this function

namespace(resource)

View Source

Specs

namespace(map()) :: binary()

Returns the namespace of k8s resource.

examples

 Examples 

iex> K8s.Resource.FieldAccessors.namespace(%{"metadata" => %{"name" => "nginx", "namespace" => "foo"}})
"foo"