Class UpdateConfigurationTemplateRequest

    • Method Detail

      • applicationName

        public final String applicationName()

        The name of the application associated with the configuration template to update.

        If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

        Returns:
        The name of the application associated with the configuration template to update.

        If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

      • templateName

        public final String templateName()

        The name of the configuration template to update.

        If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

        Returns:
        The name of the configuration template to update.

        If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

      • description

        public final String description()

        A new description for the configuration.

        Returns:
        A new description for the configuration.
      • hasOptionSettings

        public final boolean hasOptionSettings()
        For responses, this returns true if the service returned a value for the OptionSettings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • optionSettings

        public final List<ConfigurationOptionSetting> optionSettings()

        A list of configuration option settings to update with the new specified option value.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOptionSettings() method.

        Returns:
        A list of configuration option settings to update with the new specified option value.
      • hasOptionsToRemove

        public final boolean hasOptionsToRemove()
        For responses, this returns true if the service returned a value for the OptionsToRemove property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • optionsToRemove

        public final List<OptionSpecification> optionsToRemove()

        A list of configuration options to remove from the configuration set.

        Constraint: You can remove only UserDefined configuration options.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOptionsToRemove() method.

        Returns:
        A list of configuration options to remove from the configuration set.

        Constraint: You can remove only UserDefined configuration options.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object