Package org.apache.polaris.service.types

Class StorageAccessConfig

java.lang.Object

org.apache.polaris.service.types.StorageAccessConfig

@Generated(value="org.openapitools.codegen.languages.JavaResteasyServerCodegen",
           comments="Generator version: 7.12.0")
public class StorageAccessConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StorageAccessConfig.Builder

Constructor Summary

Constructors

Constructor	Description
StorageAccessConfig(String prefix, Map<String,String> config)

Method Summary

Modifier and Type	Method	Description
static StorageAccessConfig.Builder	builder()
static StorageAccessConfig.Builder	builder(String prefix, Map<String,String> config)
boolean	equals(Object o)
Map<String,String>	getConfig()	Storage access configurations for S3, GCP GCS, and Azure ADLS are supported.
String	getPrefix()	Indicates a storage location prefix where the configuration is relevant.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StorageAccessConfig

public StorageAccessConfig(String prefix,
 Map<String,String> config)

Method Details

getPrefix

public String getPrefix()

Indicates a storage location prefix where the configuration is relevant. Clients should choose the most specific prefix (by selecting the longest common prefix) if several configurations of the same type are available. If multiple configurations share the same longest matching prefix, the client may select any of them. However, a server should avoid generating multiple configurations for the same prefix.

getConfig

public Map<String,String> getConfig()

Storage access configurations for S3, GCP GCS, and Azure ADLS are supported. The following outlines the currently supported configuration options: ## S3 Configurations The following configurations should be respected when working with tables stored on S3, including AWS S3, S3-Compatible systems: - `s3.access-key-id`: id for credentials that provide access to the data in S3 - `s3.secret-access-key`: secret for credentials that provide access to data in S3 - `s3.session-token`: if present, this value should be used for as the session token - `s3.session-token-expires-at-ms`: the time the aws session token expires, in milliseconds - `s3.client.region`: region to configure client for making requests to S3 - `s3.client.refresh-credentials-endpoint`: the endpoint to load vended credentials for a table from the catalog ## GCP GCS Configurations The following configurations should be respected when working with tables stored in GCP GCS: - `gcs.oauth2.token`: the gcs scoped access token - `gcs.oauth2.token-expires-at`: the time the gcs access token expires, in milliseconds - `gcs.oauth2.refresh-credentials-endpoint`: the endpoint to load vended credentials for a table from the catalog ## AZURE ADLS Configuration The following configurations should be respected when working with tables stored in AZURE ADLS: - `adls.sas-token.<hostname>`: an azure shared access signature token - `adls.sas-token-expires-at-ms.<hostname>`: the expiration time for the access token, in milliseconds - `adls.refresh-credentials-endpoint`: the endpoint to load vended credentials for a table from the catalog

builder

public static StorageAccessConfig.Builder builder()

builder

public static StorageAccessConfig.Builder builder(String prefix,
 Map<String,String> config)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object