Package org.apache.opendal

Class ServiceConfig.Gcs

java.lang.Object

org.apache.opendal.ServiceConfig.Gcs

All Implemented Interfaces:

ServiceConfig

Enclosing interface:

ServiceConfig

public static class ServiceConfig.Gcs
extends Object
implements ServiceConfig

Configuration for service gcs.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.opendal.ServiceConfig

ServiceConfig.AliyunDrive, ServiceConfig.Alluxio, ServiceConfig.Atomicserver, ServiceConfig.Azblob, ServiceConfig.Azdls, ServiceConfig.Azfile, ServiceConfig.B2, ServiceConfig.Cacache, ServiceConfig.Chainsafe, ServiceConfig.CloudflareKv, ServiceConfig.Compfs, ServiceConfig.Cos, ServiceConfig.D1, ServiceConfig.Dashmap, ServiceConfig.Dbfs, ServiceConfig.Dropbox, ServiceConfig.Etcd, ServiceConfig.Fs, ServiceConfig.Gcs, ServiceConfig.Gdrive, ServiceConfig.Ghac, ServiceConfig.Github, ServiceConfig.Gridfs, ServiceConfig.HdfsNative, ServiceConfig.Http, ServiceConfig.Huggingface, ServiceConfig.Icloud, ServiceConfig.Ipfs, ServiceConfig.Ipmfs, ServiceConfig.Koofr, ServiceConfig.Lakefs, ServiceConfig.Libsql, ServiceConfig.Memcached, ServiceConfig.Memory, ServiceConfig.MiniMoka, ServiceConfig.Moka, ServiceConfig.Mongodb, ServiceConfig.Monoiofs, ServiceConfig.Mysql, ServiceConfig.NebulaGraph, ServiceConfig.Obs, ServiceConfig.Onedrive, ServiceConfig.Oss, ServiceConfig.Pcloud, ServiceConfig.Persy, ServiceConfig.Postgresql, ServiceConfig.Redb, ServiceConfig.Redis, ServiceConfig.S3, ServiceConfig.Seafile, ServiceConfig.Sftp, ServiceConfig.Sled, ServiceConfig.Sqlite, ServiceConfig.Supabase, ServiceConfig.Surrealdb, ServiceConfig.Swift, ServiceConfig.Upyun, ServiceConfig.VercelArtifacts, ServiceConfig.VercelBlob, ServiceConfig.Webdav, ServiceConfig.Webhdfs, ServiceConfig.YandexDisk

Field Summary

Fields

Modifier and Type	Field	Description
final Boolean	allowAnonymous	Allow opendal to send requests without signing when credentials are not loaded.
final @NonNull String	bucket	bucket name
final String	credential	Credentials string for GCS service OAuth2 authentication.
final String	credentialPath	Local path to credentials file for GCS service OAuth2 authentication.
final String	defaultStorageClass	The default storage class used by gcs.
final Boolean	disableConfigLoad	Disable loading configuration from the environment.
final Boolean	disableVmMetadata	Disable attempting to load credentials from the GCE metadata server when running within Google Cloud.
final String	endpoint	endpoint URI of GCS service, default is https://storage.googleapis.com
final String	predefinedAcl	The predefined acl for GCS.
final String	root	root URI, all operations happens under root
final String	scope	Scope for gcs.
final String	serviceAccount	Service Account for gcs.
final String	token	A Google Cloud OAuth2 token.

Constructor Summary

Constructors

Constructor	Description
Gcs()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	configMap()	Convert the structured config to a type erased config map.
String	scheme()	The scheme of the service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

bucket

@NonNull
public final @NonNull String bucket

bucket name

root

public final String root

root URI, all operations happens under root

endpoint

public final String endpoint

endpoint URI of GCS service, default is https://storage.googleapis.com

scope

public final String scope

Scope for gcs.

serviceAccount

public final String serviceAccount

Service Account for gcs.

credential

public final String credential

Credentials string for GCS service OAuth2 authentication.

credentialPath

public final String credentialPath

Local path to credentials file for GCS service OAuth2 authentication.

predefinedAcl

public final String predefinedAcl

The predefined acl for GCS.

defaultStorageClass

public final String defaultStorageClass

The default storage class used by gcs.

allowAnonymous

public final Boolean allowAnonymous

Allow opendal to send requests without signing when credentials are not loaded.

disableVmMetadata

public final Boolean disableVmMetadata

Disable attempting to load credentials from the GCE metadata server when running within Google Cloud.

disableConfigLoad

public final Boolean disableConfigLoad

Disable loading configuration from the environment.

token

public final String token

A Google Cloud OAuth2 token.

Takes precedence over credential and credential_path.

Constructor Details

Gcs

public Gcs()

Method Details

scheme

public String scheme()

Description copied from interface: ServiceConfig

The scheme of the service.

Specified by:

scheme in interface ServiceConfig

Returns:

the scheme

configMap

public Map<String,String> configMap()

Description copied from interface: ServiceConfig

Convert the structured config to a type erased config map.

Specified by:

configMap in interface ServiceConfig

Returns:

the config map