Class OperatorVersionSpecParameters

  • All Implemented Interfaces:
    com.marcnuri.yakc.model.Model

    public class OperatorVersionSpecParameters
    extends java.lang.Object
    implements com.marcnuri.yakc.model.Model
    Parameter captures the variability of an OperatorVersion being instantiated in an instance.
    • Constructor Summary

      Constructors 
      Constructor Description
      OperatorVersionSpecParameters()  
      OperatorVersionSpecParameters​(java.lang.String defaults, java.lang.String description, java.lang.String displayName, java.util.List<java.lang.String> enumeration, java.lang.Boolean immutable, java.lang.String name, java.lang.Boolean required, java.lang.String trigger, java.lang.String valueType)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static OperatorVersionSpecParameters.Builder builder()  
      protected boolean canEqual​(java.lang.Object other)  
      boolean equals​(java.lang.Object o)  
      java.lang.String getDefaults()
      Default is a default value if no parameter is provided by the instance.
      java.lang.String getDescription()
      Description captures a longer description of how the parameter will be used.
      java.lang.String getDisplayName()
      DisplayName can be used by UIs.
      java.util.List<java.lang.String> getEnumeration()
      Defines a list of allowed values.
      java.lang.Boolean getImmutable()
      Specifies if the parameter can be changed after the initial installation of the operator
      java.lang.String getName()
      Name is the string that should be used in the template file for example, if `name: COUNT` then using the variable in a spec like:
      java.lang.Boolean getRequired()
      Required specifies if the parameter is required to be provided by all instances, or whether a default can suffice.
      java.lang.String getTrigger()
      Trigger identifies the plan that gets executed when this parameter changes in the Instance object.
      java.lang.String getValueType()
      Type specifies the value type.
      int hashCode()  
      void setDefaults​(java.lang.String defaults)
      Default is a default value if no parameter is provided by the instance.
      void setDescription​(java.lang.String description)
      Description captures a longer description of how the parameter will be used.
      void setDisplayName​(java.lang.String displayName)
      DisplayName can be used by UIs.
      void setEnumeration​(java.util.List<java.lang.String> enumeration)
      Defines a list of allowed values.
      void setImmutable​(java.lang.Boolean immutable)
      Specifies if the parameter can be changed after the initial installation of the operator
      void setName​(java.lang.String name)
      Name is the string that should be used in the template file for example, if `name: COUNT` then using the variable in a spec like:
      void setRequired​(java.lang.Boolean required)
      Required specifies if the parameter is required to be provided by all instances, or whether a default can suffice.
      void setTrigger​(java.lang.String trigger)
      Trigger identifies the plan that gets executed when this parameter changes in the Instance object.
      void setValueType​(java.lang.String valueType)
      Type specifies the value type.
      OperatorVersionSpecParameters.Builder toBuilder()  
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • OperatorVersionSpecParameters

        public OperatorVersionSpecParameters​(java.lang.String defaults,
                                             java.lang.String description,
                                             java.lang.String displayName,
                                             java.util.List<java.lang.String> enumeration,
                                             java.lang.Boolean immutable,
                                             java.lang.String name,
                                             java.lang.Boolean required,
                                             java.lang.String trigger,
                                             java.lang.String valueType)
      • OperatorVersionSpecParameters

        public OperatorVersionSpecParameters()
    • Method Detail

      • getDefaults

        public java.lang.String getDefaults()
        Default is a default value if no parameter is provided by the instance.
      • getDescription

        public java.lang.String getDescription()
        Description captures a longer description of how the parameter will be used.
      • getDisplayName

        public java.lang.String getDisplayName()
        DisplayName can be used by UIs.
      • getEnumeration

        public java.util.List<java.lang.String> getEnumeration()
        Defines a list of allowed values. If Default is set and Enum is not nil, the value must be in this list as well
      • getImmutable

        public java.lang.Boolean getImmutable()
        Specifies if the parameter can be changed after the initial installation of the operator
      • getName

        public java.lang.String getName()
        Name is the string that should be used in the template file for example, if `name: COUNT` then using the variable in a spec like:

        spec: replicas: {{ .Params.COUNT }}

      • getRequired

        public java.lang.Boolean getRequired()
        Required specifies if the parameter is required to be provided by all instances, or whether a default can suffice.
      • getTrigger

        public java.lang.String getTrigger()
        Trigger identifies the plan that gets executed when this parameter changes in the Instance object. Default is `update` if a plan with that name exists, otherwise it's `deploy`.
      • getValueType

        public java.lang.String getValueType()
        Type specifies the value type. Defaults to `string`.
      • setDefaults

        public void setDefaults​(java.lang.String defaults)
        Default is a default value if no parameter is provided by the instance.
      • setDescription

        public void setDescription​(java.lang.String description)
        Description captures a longer description of how the parameter will be used.
      • setDisplayName

        public void setDisplayName​(java.lang.String displayName)
        DisplayName can be used by UIs.
      • setEnumeration

        public void setEnumeration​(java.util.List<java.lang.String> enumeration)
        Defines a list of allowed values. If Default is set and Enum is not nil, the value must be in this list as well
      • setImmutable

        public void setImmutable​(java.lang.Boolean immutable)
        Specifies if the parameter can be changed after the initial installation of the operator
      • setName

        public void setName​(java.lang.String name)
        Name is the string that should be used in the template file for example, if `name: COUNT` then using the variable in a spec like:

        spec: replicas: {{ .Params.COUNT }}

      • setRequired

        public void setRequired​(java.lang.Boolean required)
        Required specifies if the parameter is required to be provided by all instances, or whether a default can suffice.
      • setTrigger

        public void setTrigger​(java.lang.String trigger)
        Trigger identifies the plan that gets executed when this parameter changes in the Instance object. Default is `update` if a plan with that name exists, otherwise it's `deploy`.
      • setValueType

        public void setValueType​(java.lang.String valueType)
        Type specifies the value type. Defaults to `string`.
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • canEqual

        protected boolean canEqual​(java.lang.Object other)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object