Package io.fabric8.openshift.api.model

Class Template

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<TemplateBuilder>, io.fabric8.kubernetes.api.model.HasMetadata, io.fabric8.kubernetes.api.model.KubernetesResource, io.fabric8.kubernetes.api.model.Namespaced, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class Template
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<TemplateBuilder>, io.fabric8.kubernetes.api.model.HasMetadata, io.fabric8.kubernetes.api.model.Namespaced
    Template contains the inputs needed to produce a Config.


    Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from interface io.fabric8.kubernetes.api.model.HasMetadata

        DNS_LABEL_END, DNS_LABEL_REGEXP, DNS_LABEL_START, FINALIZER_NAME_MATCHER, REQUIRES_NON_NULL_METADATA, REQUIRES_NON_NULL_NAME, REQUIRES_NON_NULL_NAMESPACE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      TemplateBuilder edit()  
      Map<String,​Object> getAdditionalProperties()  
      String getApiVersion()
      APIVersion defines the versioned schema of this representation of an object.
      String getKind()
      Kind is a string value representing the REST resource this object represents.
      Map<String,​String> getLabels()
      labels is a optional set of labels that are applied to every object during the Template to Config transformation.
      String getMessage()
      message is an optional instructional message that will be displayed when this template is instantiated.
      io.fabric8.kubernetes.api.model.ObjectMeta getMetadata()
      Template contains the inputs needed to produce a Config.
      List<Object> getObjects()
      objects is an array of resources to include in this template.
      List<Parameter> getParameters()
      parameters is an optional array of Parameters used during the Template to Config transformation.
      void setAdditionalProperties​(Map<String,​Object> additionalProperties)  
      void setAdditionalProperty​(String name, Object value)  
      void setApiVersion​(String apiVersion)
      APIVersion defines the versioned schema of this representation of an object.
      void setKind​(String kind)
      Kind is a string value representing the REST resource this object represents.
      void setLabels​(Map<String,​String> labels)
      labels is a optional set of labels that are applied to every object during the Template to Config transformation.
      void setMessage​(String message)
      message is an optional instructional message that will be displayed when this template is instantiated.
      void setMetadata​(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
      Template contains the inputs needed to produce a Config.
      void setObjects​(List<Object> objects)
      objects is an array of resources to include in this template.
      void setParameters​(List<Parameter> parameters)
      parameters is an optional array of Parameters used during the Template to Config transformation.
      TemplateBuilder toBuilder()  

      • Methods inherited from interface io.fabric8.kubernetes.api.model.HasMetadata

        addFinalizer, addOwnerReference, addOwnerReference, getFinalizers, getFullResourceName, getOwnerReferenceFor, getOwnerReferenceFor, getPlural, getSingular, hasFinalizer, hasOwnerReferenceFor, hasOwnerReferenceFor, initNameAndNamespaceFrom, isFinalizerValid, isMarkedForDeletion, optionalMetadata, removeFinalizer, removeOwnerReference, removeOwnerReference

    • Constructor Detail

      • Template

        public Template()
        No args constructor for use in serialization

    • Method Detail

      • getApiVersion

        public String getApiVersion()
        APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
        Specified by:
        getApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setApiVersion

        public void setApiVersion​(String apiVersion)
        APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
        Specified by:
        setApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata

      • getKind

        public String getKind()
        Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
        Specified by:
        getKind in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setKind

        public void setKind​(String kind)
        Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

      • getLabels

        public Map<String,​String> getLabels()
        labels is a optional set of labels that are applied to every object during the Template to Config transformation.

      • setLabels

        public void setLabels​(Map<String,​String> labels)
        labels is a optional set of labels that are applied to every object during the Template to Config transformation.

      • getMessage

        public String getMessage()
        message is an optional instructional message that will be displayed when this template is instantiated. This field should inform the user how to utilize the newly created resources. Parameter substitution will be performed on the message before being displayed so that generated credentials and other parameters can be included in the output.

      • setMessage

        public void setMessage​(String message)
        message is an optional instructional message that will be displayed when this template is instantiated. This field should inform the user how to utilize the newly created resources. Parameter substitution will be performed on the message before being displayed so that generated credentials and other parameters can be included in the output.

      • getMetadata

        public io.fabric8.kubernetes.api.model.ObjectMeta getMetadata()
        Template contains the inputs needed to produce a Config.


        Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

        Specified by:
        getMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setMetadata

        public void setMetadata​(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
        Template contains the inputs needed to produce a Config.


        Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).

        Specified by:
        setMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

      • getObjects

        public List<Object> getObjects()
        objects is an array of resources to include in this template. If a namespace value is hardcoded in the object, it will be removed during template instantiation, however if the namespace value is, or contains, a ${PARAMETER_REFERENCE}, the resolved value after parameter substitution will be respected and the object will be created in that namespace.

      • setObjects

        public void setObjects​(List<Object> objects)
        objects is an array of resources to include in this template. If a namespace value is hardcoded in the object, it will be removed during template instantiation, however if the namespace value is, or contains, a ${PARAMETER_REFERENCE}, the resolved value after parameter substitution will be respected and the object will be created in that namespace.

      • getParameters

        public List<Parameter> getParameters()
        parameters is an optional array of Parameters used during the Template to Config transformation.

      • setParameters

        public void setParameters​(List<Parameter> parameters)
        parameters is an optional array of Parameters used during the Template to Config transformation.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)