com.pulumi.kubernetes.apiextensions.v1.outputs.CustomResourceDefinitionNames Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kubernetes Show documentation
A Pulumi package for creating and managing Kubernetes resources.
There is a newer version: 4.19.0-alpha.1730750641
// *** 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.apiextensions.v1.outputs;

import com.pulumi.core.annotations.CustomType;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;

@CustomType
public final class CustomResourceDefinitionNames {
    /**
     * @return categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`.
     * 
     */
    private @Nullable List categories;
    /**
     * @return kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls.
     * 
     */
    private String kind;
    /**
     * @return listKind is the serialized kind of the list for this resource. Defaults to "`kind`List".
     * 
     */
    private @Nullable String listKind;
    /**
     * @return plural is the plural name of the resource to serve. The custom resources are served under `/apis/<group>/<version>/.../<plural>`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`). Must be all lowercase.
     * 
     */
    private String plural;
    /**
     * @return shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get <shortname>`. It must be all lowercase.
     * 
     */
    private @Nullable List shortNames;
    /**
     * @return singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`.
     * 
     */
    private @Nullable String singular;

    private CustomResourceDefinitionNames() {}
    /**
     * @return categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`.
     * 
     */
    public List categories() {
        return this.categories == null ? List.of() : this.categories;
    }
    /**
     * @return kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls.
     * 
     */
    public String kind() {
        return this.kind;
    }
    /**
     * @return listKind is the serialized kind of the list for this resource. Defaults to "`kind`List".
     * 
     */
    public Optional listKind() {
        return Optional.ofNullable(this.listKind);
    }
    /**
     * @return plural is the plural name of the resource to serve. The custom resources are served under `/apis/<group>/<version>/.../<plural>`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`). Must be all lowercase.
     * 
     */
    public String plural() {
        return this.plural;
    }
    /**
     * @return shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get <shortname>`. It must be all lowercase.
     * 
     */
    public List shortNames() {
        return this.shortNames == null ? List.of() : this.shortNames;
    }
    /**
     * @return singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`.
     * 
     */
    public Optional singular() {
        return Optional.ofNullable(this.singular);
    }

    public static Builder builder() {
        return new Builder();
    }

    public static Builder builder(CustomResourceDefinitionNames defaults) {
        return new Builder(defaults);
    }
    @CustomType.Builder
    public static final class Builder {
        private @Nullable List categories;
        private String kind;
        private @Nullable String listKind;
        private String plural;
        private @Nullable List shortNames;
        private @Nullable String singular;
        public Builder() {}
        public Builder(CustomResourceDefinitionNames defaults) {
    	      Objects.requireNonNull(defaults);
    	      this.categories = defaults.categories;
    	      this.kind = defaults.kind;
    	      this.listKind = defaults.listKind;
    	      this.plural = defaults.plural;
    	      this.shortNames = defaults.shortNames;
    	      this.singular = defaults.singular;
        }

        @CustomType.Setter
        public Builder categories(@Nullable List categories) {

            this.categories = categories;
            return this;
        }
        public Builder categories(String... categories) {
            return categories(List.of(categories));
        }
        @CustomType.Setter
        public Builder kind(String kind) {
            if (kind == null) {
              throw new MissingRequiredPropertyException("CustomResourceDefinitionNames", "kind");
            }
            this.kind = kind;
            return this;
        }
        @CustomType.Setter
        public Builder listKind(@Nullable String listKind) {

            this.listKind = listKind;
            return this;
        }
        @CustomType.Setter
        public Builder plural(String plural) {
            if (plural == null) {
              throw new MissingRequiredPropertyException("CustomResourceDefinitionNames", "plural");
            }
            this.plural = plural;
            return this;
        }
        @CustomType.Setter
        public Builder shortNames(@Nullable List shortNames) {

            this.shortNames = shortNames;
            return this;
        }
        public Builder shortNames(String... shortNames) {
            return shortNames(List.of(shortNames));
        }
        @CustomType.Setter
        public Builder singular(@Nullable String singular) {

            this.singular = singular;
            return this;
        }
        public CustomResourceDefinitionNames build() {
            final var _resultValue = new CustomResourceDefinitionNames();
            _resultValue.categories = categories;
            _resultValue.kind = kind;
            _resultValue.listKind = listKind;
            _resultValue.plural = plural;
            _resultValue.shortNames = shortNames;
            _resultValue.singular = singular;
            return _resultValue;
        }
    }
}