struct Kubernetes::ObjectReference

Overview

ObjectReference contains enough information to let you inspect or modify the referred object.

Included Modules

Defined in:

generated/models/io_k8s_api_core_v1.cr

Constructors

Macro Summary

Instance Method Summary

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

def self.new(pull : ::JSON::PullParser) #

def self.new(*, __pull_for_json_serializable pull : ::JSON::PullParser) #

def self.new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node) #

Macro Detail

macro field(name, type = nil, **options, &block) #

Helper macro for defining fields with automatic camelCase conversion


Instance Method Detail

def api_version : String | Nil #

API version of the referent.


def api_version=(api_version : String | Nil) #

API version of the referent.


def field_path : String | Nil #

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.


def field_path=(field_path : String | Nil) #

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.


def kind : String | Nil #

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds


def kind=(kind : String | Nil) #

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds


def name : String | Nil #

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names


def name=(name : String | Nil) #

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names


def namespace : String | Nil #

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/


def namespace=(namespace : String | Nil) #

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/


def resource_version : String | Nil #

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency


def resource_version=(resource_version : String | Nil) #

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency


def uid : String | Nil #

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids


def uid=(uid : String | Nil) #

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids