Class Configuration

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel

    public class Configuration
    extends com.ibm.cloud.sdk.core.service.model.GenericModel
    Configuration description.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Configuration.Builder
      Builder.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object defaultValue()
      Gets the defaultValue.
      java.lang.String description()
      Gets the description.
      java.lang.Boolean hidden()
      Gets the hidden.
      java.lang.String key()
      Gets the key.
      Configuration.Builder newBuilder()
      New builder.
      java.util.List<java.lang.Object> options()
      Gets the options.
      java.lang.Boolean required()
      Gets the required.
      java.lang.String type()
      Gets the type.
      java.lang.String valueConstraint()
      Gets the valueConstraint.
      • Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

        equals, hashCode, toString
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • key

        public java.lang.String key()
        Gets the key. Configuration key.
        Returns:
        the key
      • type

        public java.lang.String type()
        Gets the type. Value type (string, boolean, int).
        Returns:
        the type
      • defaultValue

        public java.lang.Object defaultValue()
        Gets the defaultValue. The default value. To use a secret when the type is password, specify a JSON encoded value of $ref:#/components/schemas/SecretInstance, prefixed with `cmsm_v1:`.
        Returns:
        the defaultValue
      • valueConstraint

        public java.lang.String valueConstraint()
        Gets the valueConstraint. Constraint associated with value, e.g., for string type - regx:[a-z].
        Returns:
        the valueConstraint
      • description

        public java.lang.String description()
        Gets the description. Key description.
        Returns:
        the description
      • required

        public java.lang.Boolean required()
        Gets the required. Is key required to install.
        Returns:
        the required
      • options

        public java.util.List<java.lang.Object> options()
        Gets the options. List of options of type.
        Returns:
        the options
      • hidden

        public java.lang.Boolean hidden()
        Gets the hidden. Hide values.
        Returns:
        the hidden