geodesic.boson.dataset.Dataset.from_google_earth_engine#

static Dataset.from_google_earth_engine(name, asset, credential, folder='projects/earthengine-public/assets', url='https://earthengine-highvolume.googleapis.com', feature_limit=500, middleware={}, cache={}, tile_options={}, domain='*', category='*', type='*', **kwargs)[source]#

Creates a new Dataset from a Google Earth Engine Asset.

Parameters:

  • name (str) – name of the Dataset to create

  • asset (str) – the asset in GEE to use (ex. ‘LANDSAT/LC09/C02/T1_L2’)

  • credential (str) – the credential to access this, a Google Earth Engine GCP Service Account. Future will allow the use of a oauth2 refresh token or other.

  • folder (str) – by default this is the earth engine public, but you can specify another folder if needed to point to legacy data or personal projects.

  • url (str) – the GEE url to use, defaults to the recommended high volume endpoint.

  • feature_limit (int) – the max number of features to return in a single page from a search. Defaults to 500

  • kwargs – other metadata that will be set on the Dataset, such as description, alias, etc

  • middleware (MiddlewareConfig | list) – configure any boson middleware to be applied to the new dataset.

  • cache (CacheConfig) – configure caching for this dataset

  • tile_options (TileOptions) – configure tile options for this dataset

  • domain (str) – domain of the resulting Object

  • category (str) – category of the resulting Object

  • type (str) – the type of the resulting Object

  • **kwargs – additional properties to set on the new Dataset

Returns:

a new Dataset.

Return type:

Dataset

Examples

>>> ds = Dataset.from_google_earth_engine(
...          name="landsat-9-c2-gee",
...          asset="s3://my-bucket/myprefixLANDSAT/LC09/C02/T1_L2",
...          credential="google-earth-engine-svc-account",
...          description="my dataset is the bomb"
...)
>>> ds.stage()
>>> # Staging is optional, but is a useful tool for validating configuration
>>> ds.save()