REST Resource: projects.assets

Stay organized with collections Save and categorize content based on your preferences.

Resource: EarthEngineAsset

Information about an Earth Engine asset.

JSON representation
{
  "type": enum (Type),
  "name": string,
  "id": string,
  "updateTime": string,
  "title": string,
  "description": string,
  "properties": {
    object
  },
  "startTime": string,
  "endTime": string,
  "geometry": {
    object
  },
  "bands": [
    {
      object (ImageBand)
    }
  ],
  "sizeBytes": string,
  "featureCount": string,
  "quota": {
    object (FolderQuota)
  },

  // Union field location can be only one of the following:
  "cloudStorageLocation": {
    object (CloudStorageLocation)
  },
  "gcsLocation": {
    object (GcsLocation)
  },
  "featureViewAssetLocation": {
    object (FeatureViewLocation)
  }
  // End of list of possible types for union field location.
}
Fields
type

enum (Type)

The type of the asset.

name

string

The name of the asset. name is of the format "projects/*/assets/**" (e.g. "projects/earthengine-legacy/assets/users//").

id

string

The ID of the asset. Equivalent to name without the "projects/*/assets/" prefix (e.g. "users//"). Note that this is intended for display purposes only. It should not be used as an input to another operation. Use name instead.

updateTime

string (Timestamp format)

The last-modified time of the asset.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

title
(deprecated)

string

The title of the asset.

description
(deprecated)

string

The description of the asset.

properties

object (Struct format)

Key/value properties associated with the asset.

startTime

string (Timestamp format)

The timestamp associated with the asset, if any, e.g. the time at which a satellite image was taken. For assets that correspond to an interval of time, such as average values over a month or year, this timestamp corresponds to the start of that interval.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

For assets that correspond to an interval of time, such as average values over a month or year, this timestamp corresponds to the end of that interval (exclusive).

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

geometry

object (Struct format)

The spatial footprint associated with the asset, if any, as a GeoJSON geometry object (see RFC 7946).

bands[]

object (ImageBand)

Information about the data bands of the image asset. Omitted for non-image assets.

sizeBytes

string (int64 format)

The size of a leaf asset (e.g. an image) in bytes.

featureCount

string (int64 format)

The number of features in the asset, if applicable.

quota

object (FolderQuota)

The quota information associated with the folder asset, if any. Returned for top-level user-owned folder assets (e.g. "users/*" or "projects/*").

Union field location. Information about where and how the raster tiles are stored. location can be only one of the following:
cloudStorageLocation

object (CloudStorageLocation)

The location of this asset on Cloud Storage. For VCOGs (Virtual Cloud Optimized GeoTIFFs).

gcsLocation
(deprecated)

object (GcsLocation)

The location of this asset on Cloud Storage.

featureViewAssetLocation

object (FeatureViewLocation)

The location of this FeatureView in EE.

CloudStorageLocation

The location of an asset on Cloud Storage.

JSON representation
{
  "uris": [
    string
  ]
}
Fields
uris[]

string

The URIs of the data. Only Google Cloud Storage URIs are supported. Each URI must be specified in the following format: "gs://bucket-id/object-id". Only one URI is currently supported. If more than one URI is specified an INALID_ARGUMENT error is returned.

GcsLocation

The location of an asset on Cloud Storage.

JSON representation
{
  "uris": [
    string
  ]
}
Fields
uris[]

string

The URIs of the data. Only Google Cloud Storage URIs are supported. Each URI must be specified in the following format: "gs://bucket-id/object-id". Only one URI is currently supported. If more than one URI is specified an INALID_ARGUMENT error is returned.

FeatureViewLocation

A FeatureView EE asset.

JSON representation
{
  "assetOptions": {
    object (FeatureViewOptions)
  }
}
Fields
assetOptions

object (FeatureViewOptions)

Ingest-time options for FeatureView assets.

FeatureViewOptions

Ingest-time options for FeatureView assets.

JSON representation
{
  "featureViewAttributes": [
    {
      object (FeatureViewAttribute)
    }
  ],
  "ingestionTimeParameters": {
    object (FeatureViewIngestionTimeParameters)
  }
}
Fields
featureViewAttributes[]

object (FeatureViewAttribute)

Attributes in the FeatureView asset, comprising a schema for the asset. These are the attributes that features in this asset can have. Each attribute has a name and a type.

ingestionTimeParameters

object (FeatureViewIngestionTimeParameters)

FeatureView ingestion time parameters.

FeatureViewAttribute

A FeatureView attribute and its type.

JSON representation
{
  "name": string,
  "type": enum (Type)
}
Fields
name

string

Name of the attribute.

type

enum (Type)

Type of the attribute.

Type

These types are a mirror of those found in geo/enterprise/layers/public/data_source_schema.proto.

Enums
TYPE_UNSPECIFIED Type unspecified.
INTEGER A 64 bit integer value.
BOOLEAN True/False Boolean value.
DOUBLE A double precision floating point number.
STRING A string of unbounded length.
DATE_TIME A date/time, represented as a signed 64-bit integer in microseconds since the epoch, and therefore supporting the time period from 290,308 BCE through 294,247 CE.

FeatureViewIngestionTimeParameters

FeatureView ingestion time parameters. These parameters must be specified at ingestion time and cannot be updated on the fly for a FeatureView.

JSON representation
{
  "thinningOptions": {
    object (ThinningOptions)
  },
  "rankingOptions": {
    object (RankingOptions)
  }
}
Fields
thinningOptions

object (ThinningOptions)

The maximum number of feature bounding boxes that are allowed to intersect a tile. This number must be nonnegative.

rankingOptions

object (RankingOptions)

Options for assigning z-order ranks and thinning ranks to features.

ThinningOptions

Thinning options that control the density at which features are displayed per tile.

JSON representation
{
  "maxFeaturesPerTile": integer,
  "thinningStrategy": enum (ThinningStrategy)
}
Fields
maxFeaturesPerTile

integer

The maximum number of feature bounding boxes that are allowed to intersect a tile. This number must be nonnegative.

thinningStrategy

enum (ThinningStrategy)

The feature thinning strategy that should be used.

ThinningStrategy

Thinning strategy for features.

Enums
UNKNOWN_THINNING_STRATEGY Unknown thinning strategy.
GLOBALLY_CONSISTENT When thinning at a particular LOD, globally-consistent thinning means that if a feature is removed by thinning, then all other features with equal or worse thinning rank will also be removed.
HIGHER_DENSITY

When thinning, try to come as close as possible to the maxFeaturesPerTile limit for each tile. We will prefer better-ranked features over worse-ranked features, but will sometimes discard better- ranked features if that helps us achieve higher feature density.

We guarantee that the strategy is deterministic, and that the set of post-thinned features will be a superset of those generated by globally- consisent thinning.

RankingOptions

Ranking options for z-order and thinning.

JSON representation
{
  "zOrderRankingRule": {
    object (RankingRule)
  },
  "thinningRankingRule": {
    object (RankingRule)
  }
}
Fields
zOrderRankingRule

object (RankingRule)

Ranking rule for assigning z-order ranks to features.

thinningRankingRule

object (RankingRule)

Ranking rule for assigning thinning ranks to features.

RankingRule

Ranking rules that control how features are ranked for thinning and z-order.

JSON representation
{
  "rankByOneThingRule": [
    {
      object (RankByOneThingRule)
    }
  ]
}
Fields
rankByOneThingRule[]

object (RankByOneThingRule)

An ordered list of zero or more rank-by-one-thing (such as an attr) rules, which are used as primary, secondary, ... ranking keys for setting thinning_rank in each RankedFeature.

RankByOneThingRule

An individual ranking rule to control rank for thinning and z-order.

JSON representation
{

  // Union field rule can be only one of the following:
  "rankByAttributeRule": {
    object (RankByAttributeRule)
  },
  "rankByMinVisibleLodRule": {
    object (RankByMinVisibleLodRule)
  },
  "rankByGeometryTypeRule": {
    object (RankByGeometryTypeRule)
  },
  "rankByMinZoomLevelRule": {
    object (RankByMinZoomLevelRule)
  }
  // End of list of possible types for union field rule.
  "direction": enum (Direction)
}
Fields
Union field rule. The type of ranking rule to use. rule can be only one of the following:
rankByAttributeRule

object (RankByAttributeRule)

Rank by feature attribute value.

rankByMinVisibleLodRule
(deprecated)

object (RankByMinVisibleLodRule)

Rank by the min lod at which the feature geometry is first visible. A feature with any points is always visible at all LODs. Deprecated: please use rankByMinZoomLevelRule instead.

rankByGeometryTypeRule

object (RankByGeometryTypeRule)

Rank by geometry type. Precedence of types, high to low: polygon, polyline, point, none. In features with multiple types, the highest takes priority.

rankByMinZoomLevelRule

object (RankByMinZoomLevelRule)

Rank by the min zoom level at which the feature geometry is first visible. A feature with any points is always visible at all LODs.

direction

enum (Direction)

Whether the rank by this one thing should be ASCENDING (lower values first, i.e. more important) or DESCENDING (high values first, i.e. more important). In other words, ASCENDING means use directly the ordering described in the RankByAttributeRule (or other) submessage documentation below, and DESCENDING means reverse that ordering.

RankByAttributeRule

Rank by feature attribute value.

JSON representation
{
  "attributeName": string
}
Fields
attributeName

string

Rank by the value of the attribute with the given name. This is mostly the natural ordering of the values of the given type, with some subtleties and clarifications: - for integer attrs, lower values come before higher values - for double attrs, lower values come before higher values with NaN considered to be lower than all other values including minus infinity - for boolean attrs, false is considered to come before true - for date_time attrs, earlier values come before later ones - string attrs are ranked lexicographically - an attr whose value has not been set is considered to have the default value of the given type (0 for integer, false for boolean, etc.).

RankByMinVisibleLodRule

Rank by the min lod at which the feature geometry is first visible. A feature with any points is always visible at all LODs.

RankByGeometryTypeRule

Rank by geometry type. Precedence of types, high to low: polygon, polyline, point, none. In features with multiple types, the highest takes priority.

RankByMinZoomLevelRule

Rank by the min zoom level at which the feature geometry is first visible. A feature with any points is always visible at all LODs.

Direction

Whether to order a list from low to high (ASCENDING) or from high to low (DESCENDING).

Enums
DIRECTION_UNSPECIFIED No ranking direction specified.
ASCENDING Ascending order.
DESCENDING Descending order.

Type

Types of asset.

Enums
TYPE_UNSPECIFIED Unspecified.
IMAGE Image.
IMAGE_COLLECTION Image collection.
TABLE Table.
FOLDER Folder.
CLASSIFIER Classifier.
FEATURE_VIEW FeatureView asset.

ImageBand

Information about a single data band of an image asset.

JSON representation
{
  "id": string,
  "dataType": {
    object (PixelDataType)
  },
  "grid": {
    object (PixelGrid)
  },
  "pyramidingPolicy": enum (PyramidingPolicy),
  "missingData": {
    object (MissingData)
  }
}
Fields
id

string

The ID of the band.

dataType

object (PixelDataType)

The numeric type of the band.

grid

object (PixelGrid)

The pixel grid of the band.

pyramidingPolicy

enum (PyramidingPolicy)

The pyramiding policy of the band.

missingData

object (MissingData)

The value(s) denoting missing data.

PixelDataType

Specifies the numeric type of the pixels in an image band.

JSON representation
{
  "precision": enum (Precision),
  "range": {
    object (DoubleRange)
  },
  "dimensionsCount": integer
}
Fields
precision

enum (Precision)

The numeric precision of the type.

range

object (DoubleRange)

The range of the numeric type, if any. Typically absent for floating-point types.

dimensionsCount

integer

The number of dimensions in an array-valued data type, or zero to indicate an ordinary scalar type.

Precision

Specifies the precision of a numeric data type.

Enums
PRECISION_UNSPECIFIED Unspecified.
INT The data type has integer precision. Note that this could represent differently sized integers.
FLOAT The data type has 32-bit floating point precision.
DOUBLE The data type has 64-bit floating point (double) precision.

MissingData

A list of values which represent no data.

JSON representation
{
  "values": [
    number
  ]
}
Fields
values[]

number

Values which represent no data.

FolderQuota

Describes the current usage and limits of a top-level folder.

JSON representation
{
  "sizeBytes": string,
  "maxSizeBytes": string,
  "assetCount": string,
  "maxAssets": string,
  "maxAssetCount": string
}
Fields
sizeBytes

string (int64 format)

The size of the folder in bytes.

maxSizeBytes

string (int64 format)

The maximum size of the folder in bytes.

assetCount

string (int64 format)

The number of assets stored in the folder.

maxAssets

string (int64 format)

The maximum number of assets that can be stored in the folder.

maxAssetCount
(deprecated)

string (int64 format)

The maximum number of assets that can be stored in the folder.

Methods

copy

Copies an asset.

create

Creates an asset.

delete

Deletes an asset.

get

Gets detailed information about an asset.

getIamPolicy

Gets the access control policy for a resource.

getPixels

Fetches pixels from an image asset.

listAssets

Lists any container asset, such as a folder or collection.

listFeatures

Lists the features in a table asset.

listImages

Lists the images in an image collection asset.

move

Moves an asset.

patch

Updates an asset.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.