Package com.azure.resourcemanager.search.fluent.models

Class QueryKeyInner

java.lang.Object
com.azure.resourcemanager.search.fluent.models.QueryKeyInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<QueryKeyInner>
public final class QueryKeyInner extends Object implements com.azure.json.JsonSerializable<QueryKeyInner>
Describes an API key for a given Azure AI Search service that conveys read-only permissions on the docs collection of an index.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static QueryKeyInner
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of QueryKeyInner from the JsonReader.
    String
    key()
    Get the key property: The value of the query API key.
    String
    name()
    Get the name property: The name of the query API key.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    validate()
    Validates the instance.

    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

    • QueryKeyInner

      public QueryKeyInner()
      Creates an instance of QueryKeyInner class.

  • Method Details

    • name

      public String name()
      Get the name property: The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used.
      Returns:
      the name value.

    • key

      public String key()
      Get the key property: The value of the query API key.
      Returns:
      the key 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<QueryKeyInner>
      Throws:
      IOException

    • fromJson

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