Package org.elasticsearch.xpack.esql.datasource.azure

Record Class AzureConfiguration

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.esql.datasource.azure.AzureConfiguration
public record AzureConfiguration(String connectionString, String account, String key, String sasToken, String endpoint, String auth) extends Record
Configuration for Azure Blob Storage access including credentials and endpoint settings.

Supports multiple authentication modes:

  • Connection string (full connection string)
  • Account + key (SharedKey auth)
  • SAS token
  • auth=none for anonymous access to public containers
  • DefaultAzureCredential when no explicit credentials are provided

  • Constructor Details

    • AzureConfiguration

      public AzureConfiguration(String connectionString, String account, String key, String sasToken, String endpoint, String auth)
      Creates an instance of a AzureConfiguration record class.
      Parameters:
      connectionString - the value for the connectionString record component
      account - the value for the account record component
      key - the value for the key record component
      sasToken - the value for the sasToken record component
      endpoint - the value for the endpoint record component
      auth - the value for the auth record component

  • Method Details

    • fromParams

      public static AzureConfiguration fromParams(Map<String,Expression> params)

    • fromFields

      public static AzureConfiguration fromFields(String connectionString, String account, String key, String sasToken, String endpoint)

    • fromFields

      public static AzureConfiguration fromFields(String connectionString, String account, String key, String sasToken, String endpoint, String auth)

    • isAnonymous

      public boolean isAnonymous()

    • hasCredentials

      public boolean hasCredentials()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • connectionString

      public String connectionString()
      Returns the value of the connectionString record component.
      Returns:
      the value of the connectionString record component

    • account

      public String account()
      Returns the value of the account record component.
      Returns:
      the value of the account record component

    • key

      public String key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • sasToken

      public String sasToken()
      Returns the value of the sasToken record component.
      Returns:
      the value of the sasToken record component

    • endpoint

      public String endpoint()
      Returns the value of the endpoint record component.
      Returns:
      the value of the endpoint record component

    • auth

      public String auth()
      Returns the value of the auth record component.
      Returns:
      the value of the auth record component