Package org.elasticsearch.xpack.esql.datasource.gcs

Record Class GcsConfiguration

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.esql.datasource.gcs.GcsConfiguration
public record GcsConfiguration(String serviceAccountCredentials, String projectId, String endpoint, String tokenUri, String auth) extends Record
Configuration for Google Cloud Storage access including credentials and endpoint settings.

Supports authentication modes:

  • Service account JSON credentials (inline or from a file path)
  • auth=none for anonymous access to public buckets
  • Application Default Credentials (ADC) when no explicit credentials are provided

  • Constructor Details

    • GcsConfiguration

      public GcsConfiguration(String serviceAccountCredentials, String projectId, String endpoint, String tokenUri, String auth)
      Creates an instance of a GcsConfiguration record class.
      Parameters:
      serviceAccountCredentials - the value for the serviceAccountCredentials record component
      projectId - the value for the projectId record component
      endpoint - the value for the endpoint record component
      tokenUri - the value for the tokenUri record component
      auth - the value for the auth record component

  • Method Details

    • fromParams

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

    • fromFields

      public static GcsConfiguration fromFields(String serviceAccountCredentials, String projectId, String endpoint)

    • fromFields

      public static GcsConfiguration fromFields(String serviceAccountCredentials, String projectId, String endpoint, String tokenUri)

    • fromFields

      public static GcsConfiguration fromFields(String serviceAccountCredentials, String projectId, String endpoint, String tokenUri, 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.

    • serviceAccountCredentials

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

    • projectId

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

    • endpoint

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

    • tokenUri

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

    • auth

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