Class PodName

Represents a Kubernetes pod name. A Kubernetes pod name must be a valid RFC-1123 DNS label. A valid RFC-1123 DNS label consists of the following:

The first character must be a-z or 0-9
The middle part can contain a-z, 0-9, or -
The last character must be a-z or 0-9
The total length must not exceed 63 characters

Hierarchy (View Summary)

ResourceName
- PodName

Index

Properties

Methods

[toPrimitive] equals toString valueOf of

Properties

`Readonly`name

name: string

Methods

[toPrimitive]

"[toPrimitive]"(hint: string): string
Allows PodName to be used as a primitive string in operations.
Parameters
- hint: string
Returns string
Inherited from ResourceName.[toPrimitive]
- Defined in src/core/kube/resources/resource_name.ts:51

equals

equals(other: ResourceName): boolean
Compares this instance with another PodName.
Parameters
- other: ResourceName
  The other PodName instance.
Returns boolean
true if both instances have the same name.
Inherited from ResourceName.equals
- Defined in src/core/kube/resources/resource_name.ts:35

toString

toString(): string
Allows implicit conversion to a string.

Returns string
The pod name as a string.
Inherited from ResourceName.toString
- Defined in src/core/kube/resources/resource_name.ts:43

valueOf

valueOf(): string
Returns the primitive value of the object.

Returns string
Inherited from ResourceName.valueOf
- Defined in src/core/kube/resources/resource_name.ts:58

`Static`of

of(name: string): PodName
Creates a pod. A Kubernetes pod name must be a valid RFC-1123 DNS label. A valid RFC-1123 DNS label consists of the following:
- The first character must be a-z or 0-9
- The middle part can contain a-z, 0-9, or -
- The last character must be a-z or 0-9
- The total length must not exceed 63 characters
Parameters
- name: string
  The name of the pod.
Returns PodName
An instance of PodName.

Throws
InvalidResourceNameError if the pod name is invalid.
- Defined in src/core/kube/resources/pod/pod_name.ts:26