From 66b92ffddd888e1f1c1fc25fa2ab7a00b45a3ff6 Mon Sep 17 00:00:00 2001 From: Fokko Driesprong Date: Wed, 10 Jul 2024 10:09:20 +0200 Subject: [PATCH] GCS: Fix incorrect token description (#909) --- mkdocs/docs/configuration.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/mkdocs/docs/configuration.md b/mkdocs/docs/configuration.md index 9ca177f427..77bad59835 100644 --- a/mkdocs/docs/configuration.md +++ b/mkdocs/docs/configuration.md @@ -129,19 +129,19 @@ For the FileIO there are several configuration options available: -| Key | Example | Description | -| --------------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| gcs.project-id | my-gcp-project | Configure Google Cloud Project for GCS FileIO. | -| gcs.oauth2.token | ya29.dr.AfM... | Configure method authentication to GCS for FileIO. Can be the following, 'google_default', 'cache', 'anon', 'browser', 'cloud'. If not specified your credentials will be resolved in the following order: gcloud CLI default, gcsfs cached token, google compute metadata service, anonymous. | -| gcs.oauth2.token-expires-at | 1690971805918 | Configure expiration for credential generated with an access token. Milliseconds since epoch | -| gcs.access | read_only | Configure client to have specific access. Must be one of 'read_only', 'read_write', or 'full_control' | -| gcs.consistency | md5 | Configure the check method when writing files. Must be one of 'none', 'size', or 'md5' | -| gcs.cache-timeout | 60 | Configure the cache expiration time in seconds for object metadata cache | -| gcs.requester-pays | False | Configure whether to use requester-pays requests | -| gcs.session-kwargs | {} | Configure a dict of parameters to pass on to aiohttp.ClientSession; can contain, for example, proxy settings. | -| gcs.endpoint | http://0.0.0.0:4443 | Configure an alternative endpoint for the GCS FileIO to access (format protocol://host:port) If not given, defaults to the value of environment variable "STORAGE_EMULATOR_HOST"; if that is not set either, will use the standard Google endpoint. | -| gcs.default-location | US | Configure the default location where buckets are created, like 'US' or 'EUROPE-WEST3'. | -| gcs.version-aware | False | Configure whether to support object versioning on the GCS bucket. | +| Key | Example | Description | +| --------------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| gcs.project-id | my-gcp-project | Configure Google Cloud Project for GCS FileIO. | +| gcs.oauth2.token | ya29.dr.AfM... | String representation of the access token used for temporary access. | +| gcs.oauth2.token-expires-at | 1690971805918 | Configure expiration for credential generated with an access token. Milliseconds since epoch | +| gcs.access | read_only | Configure client to have specific access. Must be one of 'read_only', 'read_write', or 'full_control' | +| gcs.consistency | md5 | Configure the check method when writing files. Must be one of 'none', 'size', or 'md5' | +| gcs.cache-timeout | 60 | Configure the cache expiration time in seconds for object metadata cache | +| gcs.requester-pays | False | Configure whether to use requester-pays requests | +| gcs.session-kwargs | {} | Configure a dict of parameters to pass on to aiohttp.ClientSession; can contain, for example, proxy settings. | +| gcs.endpoint | http://0.0.0.0:4443 | Configure an alternative endpoint for the GCS FileIO to access (format protocol://host:port) If not given, defaults to the value of environment variable "STORAGE_EMULATOR_HOST"; if that is not set either, will use the standard Google endpoint. | +| gcs.default-location | US | Configure the default location where buckets are created, like 'US' or 'EUROPE-WEST3'. | +| gcs.version-aware | False | Configure whether to support object versioning on the GCS bucket. |