Skip to main content

gcs-grpc

11 configuration options · available in Rust, Python, Go

Quick start
use opendal::Operator;

let operator = Operator::via_iter("gcs-grpc", [
("bucket".to_string(), "...".to_string()),
])?;
All configuration options (copy & trim)
Full reference
use opendal::Operator;

let operator = Operator::via_iter("gcs-grpc", [
// Root path for all operations.
// ("root".to_string(), "...".to_string()),

// Bucket name.
("bucket".to_string(), "...".to_string()),

// gRPC endpoint.
// ("endpoint".to_string(), "...".to_string()),

// OAuth 2.0 scope.
// ("scope".to_string(), "...".to_string()),

// Service account used by the GCE metadata server.
// ("service_account".to_string(), "...".to_string()),

// Base64-encoded service account credential.
// ("credential".to_string(), "...".to_string()),

// Path to a service account credential file.
// ("credential_path".to_string(), "...".to_string()),

// Send requests without authentication.
// ("skip_signature".to_string(), "true".to_string()),

// Disable the GCE metadata credential provider.
// ("disable_vm_metadata".to_string(), "true".to_string()),

// Disable environment and well-known credential loading.
// ("disable_config_load".to_string(), "true".to_string()),

// OAuth 2.0 access token.
// ("token".to_string(), "...".to_string()),
])?;

Every option is passed as a string key; OpenDAL parses it into the right type. Some services may require building the binding with the matching services-* feature enabled.

Configuration reference

General11
KeyTypeRequiredDescription
rootstringnoRoot path for all operations.
bucketstringyesBucket name.
endpointstringnogRPC endpoint.
scopestringnoOAuth 2.0 scope.
service_accountstringnoService account used by the GCE metadata server.
credentialstringnoBase64-encoded service account credential.
credential_pathstringnoPath to a service account credential file.
skip_signatureboolnoSend requests without authentication.
disable_vm_metadataboolnoDisable the GCE metadata credential provider.
disable_config_loadboolnoDisable environment and well-known credential loading.
tokenstringnoOAuth 2.0 access token.