Class ConfigurationProperties

java.lang.Object
com.azure.resourcemanager.postgresqlflexibleserver.fluent.models.ConfigurationProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<ConfigurationProperties>
public final class ConfigurationProperties extends Object implements com.azure.json.JsonSerializable<ConfigurationProperties>
Properties of a configuration (also known as server parameter).

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigurationProperties()
    Creates an instance of ConfigurationProperties class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    allowedValues()
    Get the allowedValues property: Allowed values of the configuration (also known as server parameter).
    ConfigurationDataType
    dataType()
    Get the dataType property: Data type of the configuration (also known as server parameter).
    String
    defaultValue()
    Get the defaultValue property: Value assigned by default to the configuration (also known as server parameter).
    String
    description()
    Get the description property: Description of the configuration (also known as server parameter).
    String
    documentationLink()
    Get the documentationLink property: Link pointing to the documentation of the configuration (also known as server parameter).
    static ConfigurationProperties
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ConfigurationProperties from the JsonReader.
    Boolean
    isConfigPendingRestart()
    Get the isConfigPendingRestart property: Indicates if the value assigned to the configuration (also known as server parameter) is pending a server restart for it to take effect.
    Boolean
    isDynamicConfig()
    Get the isDynamicConfig property: Indicates if it's a dynamic (true) or static (false) configuration (also known as server parameter).
    Boolean
    isReadOnly()
    Get the isReadOnly property: Indicates if it's a read-only (true) or modifiable (false) configuration (also known as server parameter).
    String
    source()
    Get the source property: Source of the value assigned to the configuration (also known as server parameter).
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    String
    unit()
    Get the unit property: Units in which the configuration (also known as server parameter) value is expressed.
    void
    validate()
    Validates the instance.
    String
    value()
    Get the value property: Value of the configuration (also known as server parameter).
    ConfigurationProperties
    withSource(String source)
    Set the source property: Source of the value assigned to the configuration (also known as server parameter).
    ConfigurationProperties
    withValue(String value)
    Set the value property: Value of the configuration (also known as server parameter).

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • ConfigurationProperties

      public ConfigurationProperties()
      Creates an instance of ConfigurationProperties class.

  • Method Details

    • value

      public String value()
      Get the value property: Value of the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.
      Returns:
      the value value.

    • withValue

      public ConfigurationProperties withValue(String value)
      Set the value property: Value of the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.
      Parameters:
      value - the value value to set.
      Returns:
      the ConfigurationProperties object itself.

    • description

      public String description()
      Get the description property: Description of the configuration (also known as server parameter).
      Returns:
      the description value.

    • defaultValue

      public String defaultValue()
      Get the defaultValue property: Value assigned by default to the configuration (also known as server parameter).
      Returns:
      the defaultValue value.

    • dataType

      public ConfigurationDataType dataType()
      Get the dataType property: Data type of the configuration (also known as server parameter).
      Returns:
      the dataType value.

    • allowedValues

      public String allowedValues()
      Get the allowedValues property: Allowed values of the configuration (also known as server parameter).
      Returns:
      the allowedValues value.

    • source

      public String source()
      Get the source property: Source of the value assigned to the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.
      Returns:
      the source value.

    • withSource

      public ConfigurationProperties withSource(String source)
      Set the source property: Source of the value assigned to the configuration (also known as server parameter). Required to update the value assigned to a specific modifiable configuration.
      Parameters:
      source - the source value to set.
      Returns:
      the ConfigurationProperties object itself.

    • isDynamicConfig

      public Boolean isDynamicConfig()
      Get the isDynamicConfig property: Indicates if it's a dynamic (true) or static (false) configuration (also known as server parameter). Static server parameters require a server restart after changing the value assigned to them, for the change to take effect. Dynamic server parameters do not require a server restart after changing the value assigned to them, for the change to take effect.
      Returns:
      the isDynamicConfig value.

    • isReadOnly

      public Boolean isReadOnly()
      Get the isReadOnly property: Indicates if it's a read-only (true) or modifiable (false) configuration (also known as server parameter).
      Returns:
      the isReadOnly value.

    • isConfigPendingRestart

      public Boolean isConfigPendingRestart()
      Get the isConfigPendingRestart property: Indicates if the value assigned to the configuration (also known as server parameter) is pending a server restart for it to take effect.
      Returns:
      the isConfigPendingRestart value.

    • unit

      public String unit()
      Get the unit property: Units in which the configuration (also known as server parameter) value is expressed.
      Returns:
      the unit value.

    • documentationLink

      public String documentationLink()
      Get the documentationLink property: Link pointing to the documentation of the configuration (also known as server parameter).
      Returns:
      the documentationLink value.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ConfigurationProperties>
      Throws:
      IOException

    • fromJson

      public static ConfigurationProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ConfigurationProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ConfigurationProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the ConfigurationProperties.