org.cdk8s

Interface ApiObjectMetadata

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiObjectMetadata.Jsii$Proxy

@Generated(value="jsii-pacmak/1.16.0 (build 99a3413)",
           date="2021-01-24T13:38:47.948Z")
 @Stability(value=Experimental)
public interface ApiObjectMetadata
extends software.amazon.jsii.JsiiSerializable

(experimental) Metadata associated with this object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ApiObjectMetadata.Builder A builder for ApiObjectMetadata
static class	ApiObjectMetadata.Jsii$Proxy An implementation for ApiObjectMetadata

Method Summary

Modifier and Type	Method and Description
static ApiObjectMetadata.Builder	builder()
default Map<String,String>	getAnnotations() (experimental) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
default Map<String,String>	getLabels() (experimental) Map of string keys and values that can be used to organize and categorize (scope and select) objects.
default String	getName() (experimental) The unique, namespace-global, name of this object inside the Kubernetes cluster.
default String	getNamespace() (experimental) Namespace defines the space within each name must be unique.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAnnotations

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getAnnotations()

(experimental) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.

They are not queryable and should be preserved when modifying objects.

Default: - No annotations.

See Also:

http://kubernetes.io/docs/user-guide/annotations

getLabels

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getLabels()

(experimental) Map of string keys and values that can be used to organize and categorize (scope and select) objects.

May match selectors of replication controllers and services.

Default: - No labels.

See Also:

http://kubernetes.io/docs/user-guide/labels

getName

@Stability(value=Experimental)
 @Nullable
default String getName()

(experimental) The unique, namespace-global, name of this object inside the Kubernetes cluster.

Normally, you shouldn't specify names for objects and let the CDK generate a name for you that is application-unique. The names CDK generates are composed from the construct path components, separated by dots and a suffix that is based on a hash of the entire path, to ensure uniqueness.

You can supply custom name allocation logic by overriding the chart.generateObjectName method.

If you use an explicit name here, bear in mind that this reduces the composability of your construct because it won't be possible to include more than one instance in any app. Therefore it is highly recommended to leave this unspecified.

Default: - an app-unique name generated by the chart

getNamespace

@Stability(value=Experimental)
 @Nullable
default String getNamespace()

(experimental) Namespace defines the space within each name must be unique.

An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

Default: undefined (will be assigned to the 'default' namespace)

builder

@Stability(value=Experimental)
static ApiObjectMetadata.Builder builder()

Returns:

a ApiObjectMetadata.Builder of ApiObjectMetadata