Package org.apache.opendal

Class ServiceConfig.Github

java.lang.Object

org.apache.opendal.ServiceConfig.Github

All Implemented Interfaces:

ServiceConfig

Enclosing interface:

ServiceConfig

public static class ServiceConfig.Github
extends Object
implements ServiceConfig

Configuration for service github.

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 @NonNull String	owner	GitHub repo owner.
final @NonNull String	repo	GitHub repo name.
final String	root	root of this backend.
final String	token	GitHub access_token.

Constructor Summary

Constructors

Constructor	Description
Github()

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

owner

@NonNull
public final @NonNull String owner

GitHub repo owner.

required.

repo

@NonNull
public final @NonNull String repo

GitHub repo name.

required.

root

public final String root

root of this backend.

All operations will happen under this root.

token

public final String token

GitHub access_token.

optional. If not provided, the backend will only support read operations for public repositories. And rate limit will be limited to 60 requests per hour.

Constructor Details

Github

public Github()

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