Package com.azure.resourcemanager.search.models

Class IpRule

java.lang.Object
com.azure.resourcemanager.search.models.IpRule
All Implemented Interfaces:
com.azure.json.JsonSerializable<IpRule>
public final class IpRule extends Object implements com.azure.json.JsonSerializable<IpRule>
The IP restriction rule of the Azure AI Search service.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static IpRule
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of IpRule from the JsonReader.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    validate()
    Validates the instance.
    String
    value()
    Get the value property: Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed.
    IpRule
    withValue(String value)
    Set the value property: Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed.

    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

    • IpRule

      public IpRule()
      Creates an instance of IpRule class.

  • Method Details

    • value

      public String value()
      Get the value property: Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed.
      Returns:
      the value value.

    • withValue

      public IpRule withValue(String value)
      Set the value property: Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed.
      Parameters:
      value - the value value to set.
      Returns:
      the IpRule 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<IpRule>
      Throws:
      IOException

    • fromJson

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