Class ComputedProperty

java.lang.Object
com.azure.resourcemanager.cosmos.models.ComputedProperty
All Implemented Interfaces:
com.azure.json.JsonSerializable<ComputedProperty>

public final class ComputedProperty extends Object implements com.azure.json.JsonSerializable<ComputedProperty>
The definition of a computed property.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an instance of ComputedProperty class.
  • Method Summary

    Modifier and Type
    Method
    Description
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ComputedProperty from the JsonReader.
    Get the name property: The name of a computed property, for example - "cp_lowerName".
    Get the query property: The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c".
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    Validates the instance.
    Set the name property: The name of a computed property, for example - "cp_lowerName".
    Set the query property: The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c".

    Methods inherited from class java.lang.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

    • ComputedProperty

      public ComputedProperty()
      Creates an instance of ComputedProperty class.
  • Method Details

    • name

      public String name()
      Get the name property: The name of a computed property, for example - "cp_lowerName".
      Returns:
      the name value.
    • withName

      public ComputedProperty withName(String name)
      Set the name property: The name of a computed property, for example - "cp_lowerName".
      Parameters:
      name - the name value to set.
      Returns:
      the ComputedProperty object itself.
    • query

      public String query()
      Get the query property: The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c".
      Returns:
      the query value.
    • withQuery

      public ComputedProperty withQuery(String query)
      Set the query property: The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c".
      Parameters:
      query - the query value to set.
      Returns:
      the ComputedProperty object itself.
    • 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<ComputedProperty>
      Throws:
      IOException
    • fromJson

      public static ComputedProperty fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ComputedProperty from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ComputedProperty 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 ComputedProperty.