Skip to main content
Package com.gpudb.protocol

​
Class CreateCatalogRequest

java.lang.Object
com.gpudb.protocol.CreateCatalogRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
public class CreateCatalogRequest extends Object implements org.apache.avro.generic.IndexedRecord
A set of parameters for GPUdb.createCatalog.

Creates a catalog, which contains the location and connection information for a deltalake catalog that is external to the database.

  • ​
    Constructor Details

    • ​
      CreateCatalogRequest

      public CreateCatalogRequest()
      Constructs a CreateCatalogRequest object with default parameters.

    • ​
      CreateCatalogRequest

      public CreateCatalogRequest(String name, String tableFormat, String location, String type, String credential, String datasource, Map<String,String> options)
      Constructs a CreateCatalogRequest object with the specified parameters.
      Parameters:
      name - Name of the catalog to be created.
      tableFormat - Table format (iceberg, hudi, deltalake).
      location - Location of the catalog in ‘http[s]://[server[:port]]]’ format.
      type - Type of the catalog (REST (unity, polaris, tabular), nessie, hive, glue).
      credential - Name of the credential object to be used in catalog.
      datasource - Password for the remote system user; may be an empty string.
      options - Optional parameters.The default value is an empty Map.

  • ​
    Method Details

    • ​
      getClassSchema

      public static org.apache.avro.Schema getClassSchema()
      This method supports the Avro framework and is not intended to be called directly by the user.
      Returns:
      The schema for the class.

    • ​
      getName

      public String getName()
      Name of the catalog to be created.
      Returns:
      The current value of name.

    • ​
      setName

      public CreateCatalogRequest setName(String name)
      Name of the catalog to be created.
      Parameters:
      name - The new value for name.
      Returns:
      this to mimic the builder pattern.

    • ​
      getTableFormat

      public String getTableFormat()
      Table format (iceberg, hudi, deltalake).
      Returns:
      The current value of tableFormat.

    • ​
      setTableFormat

      public CreateCatalogRequest setTableFormat(String tableFormat)
      Table format (iceberg, hudi, deltalake).
      Parameters:
      tableFormat - The new value for tableFormat.
      Returns:
      this to mimic the builder pattern.

    • ​
      getLocation

      public String getLocation()
      Location of the catalog in ‘http[s]://[server[:port]]]’ format.
      Returns:
      The current value of location.

    • ​
      setLocation

      public CreateCatalogRequest setLocation(String location)
      Location of the catalog in ‘http[s]://[server[:port]]]’ format.
      Parameters:
      location - The new value for location.
      Returns:
      this to mimic the builder pattern.

    • ​
      getType

      public String getType()
      Type of the catalog (REST (unity, polaris, tabular), nessie, hive, glue).
      Returns:
      The current value of type.

    • ​
      setType

      public CreateCatalogRequest setType(String type)
      Type of the catalog (REST (unity, polaris, tabular), nessie, hive, glue).
      Parameters:
      type - The new value for type.
      Returns:
      this to mimic the builder pattern.

    • ​
      getCredential

      public String getCredential()
      Name of the credential object to be used in catalog.
      Returns:
      The current value of credential.

    • ​
      setCredential

      public CreateCatalogRequest setCredential(String credential)
      Name of the credential object to be used in catalog.
      Parameters:
      credential - The new value for credential.
      Returns:
      this to mimic the builder pattern.

    • ​
      getDatasource

      public String getDatasource()
      Password for the remote system user; may be an empty string.
      Returns:
      The current value of datasource.

    • ​
      setDatasource

      public CreateCatalogRequest setDatasource(String datasource)
      Password for the remote system user; may be an empty string.
      Parameters:
      datasource - The new value for datasource.
      Returns:
      this to mimic the builder pattern.

    • ​
      getOptions

      public Map<String,String> getOptions()
      Optional parameters.The default value is an empty Map.
      Returns:
      The current value of options.

    • ​
      setOptions

      public CreateCatalogRequest setOptions(Map<String,String> options)
      Optional parameters.The default value is an empty Map.
      Parameters:
      options - The new value for options.
      Returns:
      this to mimic the builder pattern.

    • ​
      getSchema

      public org.apache.avro.Schema getSchema()
      This method supports the Avro framework and is not intended to be called directly by the user.
      Specified by:
      getSchema in interface org.apache.avro.generic.GenericContainer
      Returns:
      The schema object describing this class.

    • ​
      get

      public Object get(int index)
      This method supports the Avro framework and is not intended to be called directly by the user.
      Specified by:
      get in interface org.apache.avro.generic.IndexedRecord
      Parameters:
      index - the position of the field to get
      Returns:
      value of the field with the given index.
      Throws:
      IndexOutOfBoundsException

    • ​
      put

      public void put(int index, Object value)
      This method supports the Avro framework and is not intended to be called directly by the user.
      Specified by:
      put in interface org.apache.avro.generic.IndexedRecord
      Parameters:
      index - the position of the field to set
      value - the value to set
      Throws:
      IndexOutOfBoundsException

    • ​
      equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • ​
      toString

      public String toString()
      Overrides:
      toString in class Object

    • ​
      hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object