Class ServiceConfig.GcsGrpc

java.lang.Object

org.apache.opendal.ServiceConfig.GcsGrpc

All Implemented Interfaces:

ServiceConfig

Enclosing interface:

ServiceConfig

public static class ServiceConfig.GcsGrpc
extends Object
implements ServiceConfig

Configuration for service gcs-grpc.

Nested Class Summary

Nested classes/interfaces inherited from interface ServiceConfig

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

Field Summary

Fields

Modifier and Type	Field	Description
final @NonNull String	bucket	Bucket name.
final String	credential	Base64-encoded service account credential.
final String	credentialPath	Path to a service account credential file.
final Boolean	disableConfigLoad	Disable environment and well-known credential loading.
final Boolean	disableVmMetadata	Disable the GCE metadata credential provider.
final String	endpoint	gRPC endpoint.
final String	root	Root path for all operations.
final String	scope	OAuth 2.0 scope.
final String	serviceAccount	Service account used by the GCE metadata server.
final Boolean	skipSignature	Send requests without authentication.
final String	token	OAuth 2.0 access token.

Constructor Summary

Constructors

Constructor	Description
GcsGrpc()

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 Object

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

Field Details

bucket

@NonNull
public final @NonNull String bucket

Bucket name.

credential

public final String credential

Base64-encoded service account credential.

credentialPath

public final String credentialPath

Path to a service account credential file.

disableConfigLoad

public final Boolean disableConfigLoad

Disable environment and well-known credential loading.

disableVmMetadata

public final Boolean disableVmMetadata

Disable the GCE metadata credential provider.

endpoint

public final String endpoint

gRPC endpoint.

root

public final String root

Root path for all operations.

scope

public final String scope

OAuth 2.0 scope.

serviceAccount

public final String serviceAccount

Service account used by the GCE metadata server.

skipSignature

public final Boolean skipSignature

Send requests without authentication.

token

public final String token

OAuth 2.0 access token.

Constructor Details

GcsGrpc

public GcsGrpc()

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