com.pulumi.kubernetes.meta.v1.outputs.ObjectMeta Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kubernetes Show documentation
Show all versions of kubernetes Show documentation
A Pulumi package for creating and managing Kubernetes resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.kubernetes.meta.v1.outputs;
import com.pulumi.core.annotations.CustomType;
import com.pulumi.kubernetes.meta.v1.outputs.ManagedFieldsEntry;
import com.pulumi.kubernetes.meta.v1.outputs.OwnerReference;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
@CustomType
public final class ObjectMeta {
/**
* @return 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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
*
*/
private @Nullable Map annotations;
/**
* @return The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
*
*/
private @Nullable String clusterName;
/**
* @return CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
*
* Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*
*/
private @Nullable String creationTimestamp;
/**
* @return Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
*
*/
private @Nullable Integer deletionGracePeriodSeconds;
/**
* @return DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
*
* Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*
*/
private @Nullable String deletionTimestamp;
/**
* @return Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
*
*/
private @Nullable List finalizers;
/**
* @return GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
*
* If this field is specified and the generated name exists, the server will return a 409.
*
* Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
*
*/
private @Nullable String generateName;
/**
* @return A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
*
*/
private @Nullable Integer generation;
/**
* @return 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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
*
*/
private @Nullable Map labels;
/**
* @return ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
*
*/
private @Nullable List managedFields;
/**
* @return Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
*
*/
private @Nullable String name;
/**
* @return Namespace defines the space within which 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
*
*/
private @Nullable String namespace;
/**
* @return List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
*
*/
private @Nullable List ownerReferences;
/**
* @return An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
*
* Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
*
*/
private @Nullable String resourceVersion;
/**
* @return Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
*
*/
private @Nullable String selfLink;
/**
* @return UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
*
* Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
*
*/
private @Nullable String uid;
private ObjectMeta() {}
/**
* @return 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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
*
*/
public Map annotations() {
return this.annotations == null ? Map.of() : this.annotations;
}
/**
* @return The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
*
*/
public Optional clusterName() {
return Optional.ofNullable(this.clusterName);
}
/**
* @return CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
*
* Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*
*/
public Optional creationTimestamp() {
return Optional.ofNullable(this.creationTimestamp);
}
/**
* @return Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
*
*/
public Optional deletionGracePeriodSeconds() {
return Optional.ofNullable(this.deletionGracePeriodSeconds);
}
/**
* @return DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
*
* Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*
*/
public Optional deletionTimestamp() {
return Optional.ofNullable(this.deletionTimestamp);
}
/**
* @return Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
*
*/
public List finalizers() {
return this.finalizers == null ? List.of() : this.finalizers;
}
/**
* @return GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
*
* If this field is specified and the generated name exists, the server will return a 409.
*
* Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
*
*/
public Optional generateName() {
return Optional.ofNullable(this.generateName);
}
/**
* @return A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
*
*/
public Optional generation() {
return Optional.ofNullable(this.generation);
}
/**
* @return 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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
*
*/
public Map labels() {
return this.labels == null ? Map.of() : this.labels;
}
/**
* @return ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
*
*/
public List managedFields() {
return this.managedFields == null ? List.of() : this.managedFields;
}
/**
* @return Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
*
*/
public Optional name() {
return Optional.ofNullable(this.name);
}
/**
* @return Namespace defines the space within which 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: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
*
*/
public Optional namespace() {
return Optional.ofNullable(this.namespace);
}
/**
* @return List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
*
*/
public List ownerReferences() {
return this.ownerReferences == null ? List.of() : this.ownerReferences;
}
/**
* @return An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
*
* Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
*
*/
public Optional resourceVersion() {
return Optional.ofNullable(this.resourceVersion);
}
/**
* @return Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
*
*/
public Optional selfLink() {
return Optional.ofNullable(this.selfLink);
}
/**
* @return UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
*
* Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
*
*/
public Optional uid() {
return Optional.ofNullable(this.uid);
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ObjectMeta defaults) {
return new Builder(defaults);
}
@CustomType.Builder
public static final class Builder {
private @Nullable Map annotations;
private @Nullable String clusterName;
private @Nullable String creationTimestamp;
private @Nullable Integer deletionGracePeriodSeconds;
private @Nullable String deletionTimestamp;
private @Nullable List finalizers;
private @Nullable String generateName;
private @Nullable Integer generation;
private @Nullable Map labels;
private @Nullable List managedFields;
private @Nullable String name;
private @Nullable String namespace;
private @Nullable List ownerReferences;
private @Nullable String resourceVersion;
private @Nullable String selfLink;
private @Nullable String uid;
public Builder() {}
public Builder(ObjectMeta defaults) {
Objects.requireNonNull(defaults);
this.annotations = defaults.annotations;
this.clusterName = defaults.clusterName;
this.creationTimestamp = defaults.creationTimestamp;
this.deletionGracePeriodSeconds = defaults.deletionGracePeriodSeconds;
this.deletionTimestamp = defaults.deletionTimestamp;
this.finalizers = defaults.finalizers;
this.generateName = defaults.generateName;
this.generation = defaults.generation;
this.labels = defaults.labels;
this.managedFields = defaults.managedFields;
this.name = defaults.name;
this.namespace = defaults.namespace;
this.ownerReferences = defaults.ownerReferences;
this.resourceVersion = defaults.resourceVersion;
this.selfLink = defaults.selfLink;
this.uid = defaults.uid;
}
@CustomType.Setter
public Builder annotations(@Nullable Map annotations) {
this.annotations = annotations;
return this;
}
@CustomType.Setter
public Builder clusterName(@Nullable String clusterName) {
this.clusterName = clusterName;
return this;
}
@CustomType.Setter
public Builder creationTimestamp(@Nullable String creationTimestamp) {
this.creationTimestamp = creationTimestamp;
return this;
}
@CustomType.Setter
public Builder deletionGracePeriodSeconds(@Nullable Integer deletionGracePeriodSeconds) {
this.deletionGracePeriodSeconds = deletionGracePeriodSeconds;
return this;
}
@CustomType.Setter
public Builder deletionTimestamp(@Nullable String deletionTimestamp) {
this.deletionTimestamp = deletionTimestamp;
return this;
}
@CustomType.Setter
public Builder finalizers(@Nullable List finalizers) {
this.finalizers = finalizers;
return this;
}
public Builder finalizers(String... finalizers) {
return finalizers(List.of(finalizers));
}
@CustomType.Setter
public Builder generateName(@Nullable String generateName) {
this.generateName = generateName;
return this;
}
@CustomType.Setter
public Builder generation(@Nullable Integer generation) {
this.generation = generation;
return this;
}
@CustomType.Setter
public Builder labels(@Nullable Map labels) {
this.labels = labels;
return this;
}
@CustomType.Setter
public Builder managedFields(@Nullable List managedFields) {
this.managedFields = managedFields;
return this;
}
public Builder managedFields(ManagedFieldsEntry... managedFields) {
return managedFields(List.of(managedFields));
}
@CustomType.Setter
public Builder name(@Nullable String name) {
this.name = name;
return this;
}
@CustomType.Setter
public Builder namespace(@Nullable String namespace) {
this.namespace = namespace;
return this;
}
@CustomType.Setter
public Builder ownerReferences(@Nullable List ownerReferences) {
this.ownerReferences = ownerReferences;
return this;
}
public Builder ownerReferences(OwnerReference... ownerReferences) {
return ownerReferences(List.of(ownerReferences));
}
@CustomType.Setter
public Builder resourceVersion(@Nullable String resourceVersion) {
this.resourceVersion = resourceVersion;
return this;
}
@CustomType.Setter
public Builder selfLink(@Nullable String selfLink) {
this.selfLink = selfLink;
return this;
}
@CustomType.Setter
public Builder uid(@Nullable String uid) {
this.uid = uid;
return this;
}
public ObjectMeta build() {
final var _resultValue = new ObjectMeta();
_resultValue.annotations = annotations;
_resultValue.clusterName = clusterName;
_resultValue.creationTimestamp = creationTimestamp;
_resultValue.deletionGracePeriodSeconds = deletionGracePeriodSeconds;
_resultValue.deletionTimestamp = deletionTimestamp;
_resultValue.finalizers = finalizers;
_resultValue.generateName = generateName;
_resultValue.generation = generation;
_resultValue.labels = labels;
_resultValue.managedFields = managedFields;
_resultValue.name = name;
_resultValue.namespace = namespace;
_resultValue.ownerReferences = ownerReferences;
_resultValue.resourceVersion = resourceVersion;
_resultValue.selfLink = selfLink;
_resultValue.uid = uid;
return _resultValue;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy