Query Parameters
*| Name | Type | Required | Description |
|---|---|---|---|
| assets | List<String> | No | Asset's names. Call - * {@link RequestOptions#addQueryParam} to add string to array. |
| expression | String | No | Band math expression between assets |
| asset_bidx | String | No | Per asset band indexes (coma separated indexes, e.g. - * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") |
| asset_as_band | Boolean | No | Asset as Band |
| nodata | Double | No | Overwrite internal Nodata value |
| unscale | Boolean | No | Apply internal Scale or Offset |
| resampling | String | No | Resampling method. Allowed values: "nearest", "bilinear", - * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". |
| max_size | Integer | No | Maximum dimension in pixels for the source data used to - * calculate statistics |
| categorical | Boolean | No | Return statistics for categorical dataset. |
| c | List<String> | No | List of pixel categorical values for which to report - * counts. In the form of "," separated string. |
| p | List<Integer> | No | List of percentile values (default to [2, 98]). In the - * form of "," separated string. |
| histogram_bins | String | No | Defines the number of equal-width bins in the given - * range (10, by default). - * - * If bins is a sequence (comma `,` delimited values), it defines a monotonically - * increasing array of bin edges, including the rightmost edge, allowing for - * non-uniform bin widths. - * - * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html |
| histogram_range | String | No | Comma `,` delimited range of the bins. - * - * The lower and upper range of the bins. If not provided, range is simply - * (a.min(), a.max()). - * - * Values outside the range are ignored. The first element of the range must be - * less than or equal to the second. - * range affects the automatic bin computation as well. - * - * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html |
| trim_start | Integer | No | Number of items to trim from the start of the + * cmap |
| trim_end | Integer | No | Number of items to trim from the end of the cmap |
Response Body Schema
@@ -243,191 +202,194 @@ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| trim_start | Integer | No | Number of items to trim from the start of the + * cmap |
| trim_end | Integer | No | Number of items to trim from the end of the cmap |
Response Body Schema
* *
* {@code
* [
- * String (Required)
+ * (Required)[
+ * (Required)[
+ * long (Required)
+ * ]
+ * ]
* ]
* }
*
*
- * @param collectionId STAC Collection Identifier.
- * @param itemId STAC Item Identifier.
+ * @param classmapName classmap name.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ * @return interval Legend
+ *
+ * Generate values and color swatches mapping for a given interval classmap.
+ *
+ * Returns a color map for intervals, where each interval is defined by
+ * a numeric range [min, max] representing the interval boundaries and
+ * an RGBA color [red, green, blue, alpha] associated with the interval.
+ *
+ * The response is a 2D array of interval definitions, where each element is a pair:
+ * the first element is an array of two numbers [min, max] defining the interval,
+ * and the second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color.
+ *
+ * Example: [[ [-2, 0], [0, 0, 0, 0] ], [ [1, 32], [255, 255, 178, 255] ]].
+ * This defines two intervals: [-2, 0] mapped to transparent black and [1, 32] mapped to opaque yellow along with
+ * {@link Response} on successful completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| height | Double | No | The output height of the legend image |
| width | Double | No | The output width of the legend image |
| trim_start | Integer | No | Number of items to trim from the start of the + * cmap |
| trim_end | Integer | No | Number of items to trim from the end of the cmap |
Response Body Schema
* *
* {@code
- * {
- * bounds (Required): [
- * double (Required)
- * ]
- * }
+ * BinaryData
* }
*
*
- * @param collectionId STAC Collection Identifier.
- * @param itemId STAC Item Identifier.
+ * @param colorMapName The name of the registered colormap to generate a legend for.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return geographic extent of a dataset expressed as a bounding box along with {@link Response} on successful
- * completion of {@link Mono}.
+ * @return legend
+ *
+ * Generate a legend image for a given colormap.
+ *
+ * If the colormap has non-contiguous values at the beginning or end,
+ * which aren't desired in the output image, they can be trimmed by specifying
+ * the number of values to trim along with {@link Response} on successful completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public MonoQuery Parameters
- *| Name | Type | Required | Description |
|---|---|---|---|
| assets | List<String> | No | Asset's names. Call - * {@link RequestOptions#addQueryParam} to add string to array. |
| expression | String | No | Band math expression between assets |
| asset_bidx | String | No | Per asset band indexes (coma separated indexes, e.g. - * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") |
| asset_as_band | Boolean | No | Asset as Band |
| nodata | Double | No | Overwrite internal Nodata value |
| unscale | Boolean | No | Apply internal Scale or Offset |
| algorithm | String | No | Terrain algorithm name. Allowed values: "hillshade", - * "contours", "normalizedIndex", "terrarium", "terrainrgb". |
| algorithm_params | String | No | Terrain algorithm parameters |
| color_formula | String | No | rio-color formula (info: - * https://github.com/mapbox/rio-color) |
| coord-crs | String | No | Coordinate Reference System of the input coords. Default to - * `epsg:4326`. |
| resampling | String | No | Resampling method. Allowed values: "nearest", "bilinear", - * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". |
| max_size | Integer | No | Image output size limit if width and height limits are not - * set. |
| height | Integer | No | Height in pixels for the output image |
| width | Integer | No | Width in pixels for the output image |
| rescale | List<String> | No | comma (',') delimited Min,Max range. Can set - * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. |
| colormap_name | String | No | Colormap name. Allowed values: "accent", "accent_r", - * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r", - * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r", - * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass", - * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r", - * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r", - * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar", - * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r", - * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r", - * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc", - * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence", - * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative", - * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1", - * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF", - * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges", - * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink", - * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r", - * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r", - * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds", - * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r", - * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r", - * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted", - * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat", - * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter", - * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd", - * "ylorrd_r". |
| colormap | String | No | JSON encoded custom Colormap |
| return_mask | Boolean | No | Add mask to the output data. |
Request Body Schema
* *
* {@code
* {
- * geometry (Required): {
+ * collections (Optional): [
+ * String (Optional)
+ * ]
+ * ids (Optional): [
+ * String (Optional)
+ * ]
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * intersects (Optional): {
* type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
* bbox (Optional): [
* double (Optional)
* ]
* }
- * type: String(Feature) (Required)
- * properties (Optional): {
- * String: Object (Required)
+ * query (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * filter (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * datetime: String (Optional)
+ * sortby (Optional): [
+ * (Optional){
+ * field: String (Required)
+ * direction: String(asc/desc) (Required)
+ * }
+ * ]
+ * filter-lang: String(cql-json/cql2-json/cql2-text) (Optional)
+ * metadata (Optional): {
+ * type: String(mosaic/search) (Optional)
+ * bounds: String (Optional)
+ * minzoom: Integer (Optional)
+ * maxzoom: Integer (Optional)
+ * name: String (Optional)
+ * assets (Optional): [
+ * String (Optional)
+ * ]
+ * defaults (Optional): {
+ * String: String (Required)
+ * }
* }
* }
* }
@@ -437,55 +399,261 @@ public Mono> getBoundsWithResponse(String collectionId, Str
*
*
* {@code
- * BinaryData
+ * {
+ * searchid: String (Required)
+ * links (Optional): [
+ * (Optional){
+ * rel: String (Optional)
+ * title: String (Optional)
+ * type: String(image/tiff; application=geotiff/image/jp2/image/png/image/jpeg/image/jpg/image/webp/application/x-binary/application/xml/application/json/application/geo+json/text/html/text/plain/application/x-protobuf) (Optional)
+ * href: String (Optional, Required on create)
+ * hreflang: String (Optional)
+ * length: Integer (Optional)
+ * method: String(GET/POST) (Optional)
+ * headers (Optional): {
+ * String: String (Required)
+ * }
+ * body (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * merge: Boolean (Optional)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param registerMosaicsSearchRequest The registerMosaicsSearchRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response from a successful mosaic registration with search ID and related links along with
+ * {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> registerMosaicsSearchWithResponse(BinaryData registerMosaicsSearchRequest,
+ RequestOptions requestOptions) {
+ return this.serviceClient.registerMosaicsSearchWithResponseAsync(registerMosaicsSearchRequest, requestOptions);
+ }
+
+ /**
+ * Tileset List
+ *
+ * Return a list of available tilesets for a STAC item.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * tilesets (Required): [
+ * (Required){
+ * title: String (Optional)
+ * dataType: String (Optional)
+ * crs: String (Optional)
+ * links (Optional): [
+ * (Optional){
+ * href: String (Required)
+ * rel: String (Required)
+ * type: String (Optional)
+ * title: String (Optional)
+ * }
+ * ]
+ * boundingBox (Optional): {
+ * lowerLeft (Required): [
+ * double (Required)
+ * ]
+ * upperRight (Required): [
+ * double (Required)
+ * ]
+ * crs: String (Optional)
+ * }
+ * accessConstraints: String (Optional)
+ * }
+ * ]
+ * }
* }
*
*
* @param collectionId STAC Collection Identifier.
* @param itemId STAC Item Identifier.
- * @param format Output format for the tile or image (e.g., png, jpeg, webp).
- * @param body Request GeoJson body.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ * @return response containing a list of available tilesets along with {@link Response} on successful completion of
+ * {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> cropGeoJsonWithResponse(String collectionId, String itemId, String format,
- BinaryData body, RequestOptions requestOptions) {
- return this.serviceClient.cropGeoJsonWithResponseAsync(collectionId, itemId, format, body, requestOptions);
+ public Mono> getTilesetsWithResponse(String collectionId, String itemId,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getTilesetsWithResponseAsync(collectionId, itemId, requestOptions);
+ }
+
+ /**
+ * Tileset Metadata
+ *
+ * Return metadata for a specific tileset of a STAC item.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * title: String (Optional)
+ * dataType: String (Optional)
+ * crs: String (Optional)
+ * links (Optional): [
+ * (Optional){
+ * href: String (Required)
+ * rel: String (Required)
+ * type: String (Optional)
+ * title: String (Optional)
+ * }
+ * ]
+ * boundingBox (Optional): {
+ * lowerLeft (Required): [
+ * double (Required)
+ * ]
+ * upperRight (Required): [
+ * double (Required)
+ * ]
+ * crs: String (Optional)
+ * }
+ * accessConstraints: String (Optional)
+ * tileMatrixSetLimits (Optional): [
+ * (Optional){
+ * tileMatrix: String (Required)
+ * minTileRow: int (Required)
+ * maxTileRow: int (Required)
+ * minTileCol: int (Required)
+ * maxTileCol: int (Required)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return detailed metadata about a specific tileset, including tile matrix set limits along with {@link Response}
+ * on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getTilesetMetadataWithResponse(String collectionId, String itemId,
+ String tileMatrixSetId, RequestOptions requestOptions) {
+ return this.serviceClient.getTilesetMetadataWithResponseAsync(collectionId, itemId, tileMatrixSetId,
+ requestOptions);
}
/**
- * Geojson Crop
+ * Tile Tilematrixsetid Plain
*
- * Create image from a geojson feature.
+ * Create map tile from a dataset (without scale or format in path).
* Query Parameters
*
* Query Parameters
* Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
* {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx String No Per asset band indexes (coma separated indexes, e.g.
- * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata Double No Overwrite internal Nodata value nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
- * "contours", "normalizedIndex", "terrarium", "terrainrgb". algorithm_params String No Terrain algorithm parameters format String No Output format for the tile or image (e.g., png, jpeg, webp).
+ * Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". scale Integer No Numeric scale factor for the tile. Higher values produce larger
+ * tiles buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
* https://github.com/mapbox/rio-color) coord-crs String No Coordinate Reference System of the input coords. Default to
- * `epsg:4326`. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
* "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Image output size limit if width and height limits are not
- * set. rescale List<String> No comma (',') delimited Min,Max range. Can set
* multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
@@ -513,30 +681,41 @@ public Mono> cropGeoJsonWithResponse(String collectionId, S
* "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
* "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
* "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
- * "ylorrd_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data.
- * You can add these to a request with {@link RequestOptions#addQueryParam}
- * Request Body Schema
+ * padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
*
- *
- * {@code
- * {
- * geometry (Required): {
- * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
- * bbox (Optional): [
- * double (Optional)
- * ]
- * }
- * type: String(Feature) (Required)
- * properties (Optional): {
- * String: Object (Required)
- * }
- * }
- * }
- *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
*
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". Response Body Schema
*
*
@@ -547,10 +726,13 @@ public Mono> cropGeoJsonWithResponse(String collectionId, S
*
* @param collectionId STAC Collection Identifier.
* @param itemId STAC Item Identifier.
- * @param width Width in pixels for the output image.
- * @param height Height in pixels for the output image.
- * @param format Output format for the tile or image (e.g., png, jpeg, webp).
- * @param body Request GeoJson body.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
@@ -560,343 +742,179 @@ public Mono> cropGeoJsonWithResponse(String collectionId, S
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> cropGeoJsonWithDimensionsWithResponse(String collectionId, String itemId,
- int width, int height, String format, BinaryData body, RequestOptions requestOptions) {
- return this.serviceClient.cropGeoJsonWithDimensionsWithResponseAsync(collectionId, itemId, width, height,
- format, body, requestOptions);
+ public Mono> getTileWithResponse(String collectionId, String itemId, String tileMatrixSetId,
+ double z, double x, double y, RequestOptions requestOptions) {
+ return this.serviceClient.getTileWithResponseAsync(collectionId, itemId, tileMatrixSetId, z, x, y,
+ requestOptions);
}
/**
- * Geojson Statistics
+ * Tile Tilematrixsetid Format
*
- * Get Statistics from a geojson feature.
+ * Create map tile from a dataset (with format in path, without scale).
* Query Parameters
*
* Query Parameters
* Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
* {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx String No Per asset band indexes (coma separated indexes, e.g.
- * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata Double No Overwrite internal Nodata value nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset coord-crs String No Coordinate Reference System of the input coords. Default to
- * `epsg:4326`. reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters scale Integer No Numeric scale factor for the tile. Higher values produce larger
+ * tiles buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) resampling String No Resampling method. Allowed values: "nearest", "bilinear",
* "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Maximum dimension in pixels for the source data used to
- * calculate statistics categorical Boolean No Return statistics for categorical dataset. c List<String> No List of pixel categorical values for which to report
- * counts. In the form of "," separated string. p List<Integer> No List of percentile values (default to [2, 98]). In the
- * form of "," separated string. histogram_bins String No Defines the number of equal-width bins in the given
- * range (10, by default).
- *
- * If bins is a sequence (comma `,` delimited values), it defines a monotonically
- * increasing array of bin edges, including the rightmost edge, allowing for
- * non-uniform bin widths.
+ * rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
*
- * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html histogram_range String No Comma `,` delimited range of the bins.
+ * Examples:
*
- * The lower and upper range of the bins. If not provided, range is simply
- * (a.min(), a.max()).
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
*
- * Values outside the range are ignored. The first element of the range must be
- * less than or equal to the second.
- * range affects the automatic bin computation as well.
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
*
- * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
* You can add these to a request with {@link RequestOptions#addQueryParam}
- * Request Body Schema
+ * Response Body Schema
*
*
* {@code
- * {
- * geometry (Required): {
- * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
- * bbox (Optional): [
- * double (Optional)
- * ]
- * }
- * type: String(Feature) (Required)
- * properties (Optional): {
- * String: Object (Required)
- * }
- * }
- * }
- *
- *
- * Response Body Schema
- *
- *
- * {@code
- * {
- * geometry (Required): {
- * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
- * bbox (Optional): [
- * double (Optional)
- * ]
- * }
- * type: String(Feature) (Required)
- * properties (Optional): {
- * statistics (Required): {
- * String (Required): {
- * min: double (Required)
- * max: double (Required)
- * mean: double (Required)
- * count: double (Required)
- * sum: double (Required)
- * std: double (Required)
- * median: double (Required)
- * majority: double (Required)
- * minority: double (Required)
- * unique: double (Required)
- * histogram (Required): [
- * (Required)[
- * double (Required)
- * ]
- * ]
- * valid_percent: double (Required)
- * masked_pixels: double (Required)
- * valid_pixels: double (Required)
- * percentile_2: double (Required)
- * percentile_98: double (Required)
- * }
- * }
- * (Optional): {
- * String: Object (Required)
- * }
- * }
- * }
- * }
- *
- *
- * @param collectionId STAC Collection Identifier.
- * @param itemId STAC Item Identifier.
- * @param body Request GeoJson body.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return sTAC Item representing a spatiotemporal asset with statistical information along with {@link Response} on
- * successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getGeoJsonStatisticsWithResponse(String collectionId, String itemId,
- BinaryData body, RequestOptions requestOptions) {
- return this.serviceClient.getGeoJsonStatisticsWithResponseAsync(collectionId, itemId, body, requestOptions);
- }
-
- /**
- * Info Geojson
- *
- * Return Info Geojson.
- * Query Parameters
- *
- * Query Parameters
- * Name Type Required Description assets List<String> No Asset's names. Call
- * {@link RequestOptions#addQueryParam} to add string to array.
- * You can add these to a request with {@link RequestOptions#addQueryParam}
- * Response Body Schema
- *
- *
- * {@code
- * {
- * type: String(Feature) (Required)
- * geometry (Required): {
- * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
- * bbox (Optional): [
- * double (Optional)
- * ]
- * }
- * properties (Required): {
- * String (Required): {
- * bounds (Required): [
- * double (Required)
- * ]
- * band_metadata (Optional): [
- * (Optional)[
- * BinaryData (Optional)
- * ]
- * ]
- * band_descriptions (Optional): [
- * (Optional)[
- * String (Optional)
- * ]
- * ]
- * dtype: String (Required)
- * nodata_type: String(Alpha/Mask/Internal/Nodata/None) (Optional)
- * colorinterp (Optional): [
- * String (Optional)
- * ]
- * driver: String (Optional)
- * count: Integer (Optional)
- * width: Integer (Optional)
- * height: Integer (Optional)
- * overviews (Optional): [
- * int (Optional)
- * ]
- * scales (Optional): [
- * int (Optional)
- * ]
- * offsets (Optional): [
- * int (Optional)
- * ]
- * colormap (Optional): {
- * String (Required): [
- * String (Required)
- * ]
- * }
- * minzoom: Integer (Optional)
- * maxzoom: Integer (Optional)
- * crs: String (Optional)
- * }
- * }
- * id: String (Optional)
- * bbox (Optional): [
- * double (Optional)
- * ]
- * }
+ * BinaryData
* }
*
*
* @param collectionId STAC Collection Identifier.
* @param itemId STAC Item Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return geoJSON Feature object containing rio-tiler model information along with {@link Response} on successful
- * completion of {@link Mono}.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getInfoGeoJsonWithResponse(String collectionId, String itemId,
- RequestOptions requestOptions) {
- return this.serviceClient.getInfoGeoJsonWithResponseAsync(collectionId, itemId, requestOptions);
+ public Mono> getTileByFormatWithResponse(String collectionId, String itemId,
+ String tileMatrixSetId, double z, double x, double y, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getTileByFormatWithResponseAsync(collectionId, itemId, tileMatrixSetId, z, x, y,
+ format, requestOptions);
}
/**
- * Info
+ * Tile Tilematrixsetid Scale
*
- * Return dataset's basic info.
+ * Create map tile from a dataset (with scale in path, without format).
* Query Parameters
*
* Query Parameters
* Name Type Required Description assets List<String> No Asset's names. Call
+ * bidx List<Integer> No Dataset band indexes. Call
* {@link RequestOptions#addQueryParam} to add string to array.
- * You can add these to a request with {@link RequestOptions#addQueryParam}
- * Response Body Schema
- *
- *
- * {@code
- * {
- * (Optional): {
- * String (Required): {
- * bounds (Required): [
- * double (Required)
- * ]
- * band_metadata (Optional): [
- * (Optional)[
- * BinaryData (Optional)
- * ]
- * ]
- * band_descriptions (Optional): [
- * (Optional)[
- * String (Optional)
- * ]
- * ]
- * dtype: String (Required)
- * nodata_type: String(Alpha/Mask/Internal/Nodata/None) (Optional)
- * colorinterp (Optional): [
- * String (Optional)
- * ]
- * driver: String (Optional)
- * count: Integer (Optional)
- * width: Integer (Optional)
- * height: Integer (Optional)
- * overviews (Optional): [
- * int (Optional)
- * ]
- * scales (Optional): [
- * int (Optional)
- * ]
- * offsets (Optional): [
- * int (Optional)
- * ]
- * colormap (Optional): {
- * String (Required): [
- * String (Required)
- * ]
- * }
- * minzoom: Integer (Optional)
- * maxzoom: Integer (Optional)
- * crs: String (Optional)
- * }
- * }
- * }
- * }
- *
- *
- * @param collectionId STAC Collection Identifier.
- * @param itemId STAC Item Identifier.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return return dataset's basic info along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getItemAssetDetailsWithResponse(String collectionId, String itemId,
- RequestOptions requestOptions) {
- return this.serviceClient.getItemAssetDetailsWithResponseAsync(collectionId, itemId, requestOptions);
- }
-
- /**
- * Part
- *
- * Create image from part of a dataset.
- * Query Parameters
- *
- * Query Parameters
- * Name Type Required Description assets List<String> No Asset's names. Call
* {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx String No Per asset band indexes (coma separated indexes, e.g.
- * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata Double No Overwrite internal Nodata value nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
- * "contours", "normalizedIndex", "terrarium", "terrainrgb". algorithm_params String No Terrain algorithm parameters format String No Output format for the tile or image (e.g., png, jpeg, webp).
+ * Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
* https://github.com/mapbox/rio-color) dst-crs String No Output Coordinate Reference System. coord-crs String No Coordinate Reference System of the input coords. Default to
- * `epsg:4326`. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
* "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Image output size limit if width and height limits are not
- * set. height Integer No Height in pixels for the output image width Integer No Width in pixels for the output image rescale List<String> No comma (',') delimited Min,Max range. Can set
* multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
@@ -924,9 +942,39 @@ public Mono> getItemAssetDetailsWithResponse(String collect
* "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
* "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
* "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
- * "ylorrd_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
* You can add these to a request with {@link RequestOptions#addQueryParam}
* Response Body Schema
@@ -939,11 +987,14 @@ public Mono> getItemAssetDetailsWithResponse(String collect
*
* @param collectionId STAC Collection Identifier.
* @param itemId STAC Item Identifier.
- * @param minx Bounding box min X.
- * @param miny Bounding box min Y.
- * @param maxx Bounding box max X.
- * @param maxy Bounding box max Y.
- * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
@@ -953,40 +1004,46 @@ public Mono> getItemAssetDetailsWithResponse(String collect
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getPartWithResponse(String collectionId, String itemId, double minx, double miny,
- double maxx, double maxy, String format, RequestOptions requestOptions) {
- return this.serviceClient.getPartWithResponseAsync(collectionId, itemId, minx, miny, maxx, maxy, format,
+ public Mono> getTileByScaleWithResponse(String collectionId, String itemId,
+ String tileMatrixSetId, double z, double x, double y, double scale, RequestOptions requestOptions) {
+ return this.serviceClient.getTileByScaleWithResponseAsync(collectionId, itemId, tileMatrixSetId, z, x, y, scale,
requestOptions);
}
/**
- * Part
+ * Tile Tilematrixsetid
*
- * Create image from part of a dataset.
+ * Create map tile from a dataset (with TileMatrixSetId, scale, and format in path).
* Query Parameters
*
* Query Parameters
* Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
* {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx String No Per asset band indexes (coma separated indexes, e.g.
- * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata Double No Overwrite internal Nodata value nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
- * "contours", "normalizedIndex", "terrarium", "terrainrgb". algorithm_params String No Terrain algorithm parameters buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
* https://github.com/mapbox/rio-color) dst-crs String No Output Coordinate Reference System. coord-crs String No Coordinate Reference System of the input coords. Default to
- * `epsg:4326`. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
* "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Image output size limit if width and height limits are not
- * set. rescale List<String> No comma (',') delimited Min,Max range. Can set
* multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
@@ -1014,9 +1071,39 @@ public Mono> getPartWithResponse(String collectionId, Strin
* "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
* "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
* "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
- * "ylorrd_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
* You can add these to a request with {@link RequestOptions#addQueryParam}
* Response Body Schema
@@ -1029,117 +1116,207 @@ public Mono> getPartWithResponse(String collectionId, Strin
*
* @param collectionId STAC Collection Identifier.
* @param itemId STAC Item Identifier.
- * @param minx Bounding box min X.
- * @param miny Bounding box min Y.
- * @param maxx Bounding box max X.
- * @param maxy Bounding box max Y.
- * @param width Width in pixels for the output image.
- * @param height Height in pixels for the output image.
- * @param format Output format for the tile or image (e.g., png, jpeg, webp).
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
* @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getPartWithDimensionsWithResponse(String collectionId, String itemId, double minx,
- double miny, double maxx, double maxy, int width, int height, String format, RequestOptions requestOptions) {
- return this.serviceClient.getPartWithDimensionsWithResponseAsync(collectionId, itemId, minx, miny, maxx, maxy,
- width, height, format, requestOptions);
+ public Mono> getTileByScaleAndFormatWithResponse(String collectionId, String itemId,
+ String tileMatrixSetId, double z, double x, double y, double scale, String format,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getTileByScaleAndFormatWithResponseAsync(collectionId, itemId, tileMatrixSetId, z, x,
+ y, scale, format, requestOptions);
}
/**
- * Point
+ * Tile Plain
*
- * Get Point value for a dataset.
+ * Create map tile from a dataset (without TileMatrixSetId, scale or format in path).
* Query Parameters
*
* Query Parameters
* Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
* {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx String No Per asset band indexes (coma separated indexes, e.g.
- * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata Double No Overwrite internal Nodata value nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset coord-crs String No Coordinate Reference System of the input coords. Default to
- * `epsg:4326`. reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default:
+ * 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid",
+ * "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad",
+ * "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". format String No Output format for the tile or image (e.g., png, jpeg, webp).
+ * Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". scale Integer No Numeric scale factor for the tile. Higher values produce larger
+ * tiles buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) resampling String No Resampling method. Allowed values: "nearest", "bilinear",
* "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
* You can add these to a request with {@link RequestOptions#addQueryParam}
* Response Body Schema
*
*
* {@code
- * {
- * coordinates (Required): [
- * double (Required)
- * ]
- * values (Required): [
- * double (Required)
- * ]
- * band_names (Required): [
- * String (Required)
- * ]
- * }
+ * BinaryData
* }
*
*
* @param collectionId STAC Collection Identifier.
* @param itemId STAC Item Identifier.
- * @param longitude Longitude.
- * @param latitude Latitude.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return response model for point query operations providing values at a specific location along with
- * {@link Response} on successful completion of {@link Mono}.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getPointWithResponse(String collectionId, String itemId, double longitude,
- double latitude, RequestOptions requestOptions) {
- return this.serviceClient.getPointWithResponseAsync(collectionId, itemId, longitude, latitude, requestOptions);
+ public Mono> getTileNoTmsWithResponse(String collectionId, String itemId, double z, double x,
+ double y, RequestOptions requestOptions) {
+ return this.serviceClient.getTileNoTmsWithResponseAsync(collectionId, itemId, z, x, y, requestOptions);
}
/**
- * Preview
+ * Tile Format
*
- * Create preview of a dataset.
+ * Create map tile from a dataset (with format in path, without TileMatrixSetId or scale).
* Query Parameters
*
* Query Parameters
* Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
* {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx String No Per asset band indexes (coma separated indexes, e.g.
- * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata Double No Overwrite internal Nodata value nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
- * "contours", "normalizedIndex", "terrarium", "terrainrgb". algorithm_params String No Terrain algorithm parameters format String No Output format for the tile or image (e.g., png, jpeg, webp).
- * Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default:
+ * 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid",
+ * "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad",
+ * "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". scale Integer No Numeric scale factor for the tile. Higher values produce larger
+ * tiles buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
* https://github.com/mapbox/rio-color) dst-crs String No Output Coordinate Reference System. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
* "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Image output size limit if width and height limits are not
- * set. height Integer No Height in pixels for the output image width Integer No Width in pixels for the output image rescale List<String> No comma (',') delimited Min,Max range. Can set
* multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
@@ -1167,9 +1344,39 @@ public Mono> getPointWithResponse(String collectionId, Stri
* "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
* "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
* "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
- * "ylorrd_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
* You can add these to a request with {@link RequestOptions#addQueryParam}
* Response Body Schema
@@ -1182,6 +1389,13 @@ public Mono> getPointWithResponse(String collectionId, Stri
*
* @param collectionId STAC Collection Identifier.
* @param itemId STAC Item Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
@@ -1191,39 +1405,53 @@ public Mono> getPointWithResponse(String collectionId, Stri
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getPreviewWithResponse(String collectionId, String itemId,
- RequestOptions requestOptions) {
- return this.serviceClient.getPreviewWithResponseAsync(collectionId, itemId, requestOptions);
+ public Mono> getTileNoTmsByFormatWithResponse(String collectionId, String itemId, double z,
+ double x, double y, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getTileNoTmsByFormatWithResponseAsync(collectionId, itemId, z, x, y, format,
+ requestOptions);
}
/**
- * Preview
+ * Tile Scale
*
- * Create preview of a dataset.
+ * Create map tile from a dataset (with scale in path, without TileMatrixSetId or format).
* Query Parameters
*
* Query Parameters
* Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
* {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx String No Per asset band indexes (coma separated indexes, e.g.
- * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata Double No Overwrite internal Nodata value nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
- * "contours", "normalizedIndex", "terrarium", "terrainrgb". algorithm_params String No Terrain algorithm parameters TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default:
+ * 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid",
+ * "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad",
+ * "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". format String No Output format for the tile or image (e.g., png, jpeg, webp).
+ * Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
* https://github.com/mapbox/rio-color) dst-crs String No Output Coordinate Reference System. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
* "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Image output size limit if width and height limits are not
- * set. height Integer No Height in pixels for the output image width Integer No Width in pixels for the output image rescale List<String> No comma (',') delimited Min,Max range. Can set
* multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
@@ -1251,9 +1479,39 @@ public Mono> getPreviewWithResponse(String collectionId, St
* "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
* "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
* "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
- * "ylorrd_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
* You can add these to a request with {@link RequestOptions#addQueryParam}
* Response Body Schema
@@ -1266,7 +1524,13 @@ public Mono> getPreviewWithResponse(String collectionId, St
*
* @param collectionId STAC Collection Identifier.
* @param itemId STAC Item Identifier.
- * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
@@ -1276,69 +1540,113 @@ public Mono> getPreviewWithResponse(String collectionId, St
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getPreviewWithFormatWithResponse(String collectionId, String itemId,
- String format, RequestOptions requestOptions) {
- return this.serviceClient.getPreviewWithFormatWithResponseAsync(collectionId, itemId, format, requestOptions);
+ public Mono> getTileNoTmsByScaleWithResponse(String collectionId, String itemId, double z,
+ double x, double y, double scale, RequestOptions requestOptions) {
+ return this.serviceClient.getTileNoTmsByScaleWithResponseAsync(collectionId, itemId, z, x, y, scale,
+ requestOptions);
}
/**
- * Create Static Image
- *
- * Create a new image export.
- * Request Body Schema
+ * Tile
*
- *
- * {@code
- * {
- * cql (Required): {
- * String: Object (Required)
- * }
- * zoom: Double (Optional)
- * geometry (Optional): {
- * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
- * bbox (Optional): [
- * double (Optional)
- * ]
- * }
- * render_params: String (Required)
- * cols: int (Required)
- * rows: int (Required)
- * showBranding: Boolean (Optional)
- * imageSize: String (Optional)
- * }
- * }
- *
+ * Create map tile from a dataset (with scale and format in path, without TileMatrixSetId).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default:
+ * 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid",
+ * "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad",
+ * "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
*
- * Response Body Schema
+ * Examples:
*
- *
- * {@code
- * {
- * url: String (Required)
- * }
- * }
- *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
*
- * @param collectionId STAC Collection ID.
- * @param body Image request body.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return response model for image exports along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> createStaticImageWithResponse(String collectionId, BinaryData body,
- RequestOptions requestOptions) {
- return this.serviceClient.createStaticImageWithResponseAsync(collectionId, body, requestOptions);
- }
-
- /**
- * Get Static Image
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
*
- * Fetch an existing image export by ID.
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
* Response Body Schema
*
*
@@ -1347,152 +1655,67 @@ public Mono> createStaticImageWithResponse(String collectio
* }
*
*
- * @param collectionId STAC Collection ID.
- * @param id Image export ID.
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return static Image
- *
- * Fetch an existing image export by ID along with {@link Response} on successful completion of {@link Mono}.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getStaticImageWithResponse(String collectionId, String id,
- RequestOptions requestOptions) {
- return this.serviceClient.getStaticImageWithResponseAsync(collectionId, id, requestOptions);
+ public Mono> getTileNoTmsByScaleAndFormatWithResponse(String collectionId, String itemId,
+ double z, double x, double y, double scale, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getTileNoTmsByScaleAndFormatWithResponseAsync(collectionId, itemId, z, x, y, scale,
+ format, requestOptions);
}
/**
- * Statistics
+ * Geojson Feature
*
- * Merged assets statistics.
+ * Create image from a geojson feature (without format in path).
* Query Parameters
*
* Query Parameters
* Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
* {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx String No Per asset band indexes (coma separated indexes, e.g.
- * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata Double No Overwrite internal Nodata value nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
* "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Maximum dimension in pixels for the source data used to
- * calculate statistics categorical Boolean No Return statistics for categorical dataset. c List<String> No List of pixel categorical values for which to report
- * counts. In the form of "," separated string. p List<Integer> No List of percentile values (default to [2, 98]). In the
- * form of "," separated string. histogram_bins String No Defines the number of equal-width bins in the given
- * range (10, by default).
- *
- * If bins is a sequence (comma `,` delimited values), it defines a monotonically
- * increasing array of bin edges, including the rightmost edge, allowing for
- * non-uniform bin widths.
- *
- * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html histogram_range String No Comma `,` delimited range of the bins.
- *
- * The lower and upper range of the bins. If not provided, range is simply
- * (a.min(), a.max()).
- *
- * Values outside the range are ignored. The first element of the range must be
- * less than or equal to the second.
- * range affects the automatic bin computation as well.
- *
- * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html
- * You can add these to a request with {@link RequestOptions#addQueryParam}
- * Response Body Schema
- *
- *
- * {@code
- * {
- * (Optional): {
- * String (Required): {
- * min: double (Required)
- * max: double (Required)
- * mean: double (Required)
- * count: double (Required)
- * sum: double (Required)
- * std: double (Required)
- * median: double (Required)
- * majority: double (Required)
- * minority: double (Required)
- * unique: double (Required)
- * histogram (Required): [
- * (Required)[
- * double (Required)
- * ]
- * ]
- * valid_percent: double (Required)
- * masked_pixels: double (Required)
- * valid_pixels: double (Required)
- * percentile_2: double (Required)
- * percentile_98: double (Required)
- * }
- * }
- * }
- * }
- *
- *
- * @param collectionId STAC Collection Identifier.
- * @param itemId STAC Item Identifier.
- * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return return dataset's statistics along with {@link Response} on successful completion of {@link Mono}.
- */
- @Generated
- @ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> listStatisticsWithResponse(String collectionId, String itemId,
- RequestOptions requestOptions) {
- return this.serviceClient.listStatisticsWithResponseAsync(collectionId, itemId, requestOptions);
- }
-
- /**
- * TileJson Tilematrixsetid As Path
- *
- * Return the TileJson Tilematrixsetid As a path.
- * Query Parameters
- *
- * Query Parameters
- * Name Type Required Description assets List<String> No Asset's names. Call
- * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx String No Per asset band indexes (coma separated indexes, e.g.
- * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") asset_as_band Boolean No Asset as Band nodata Double No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset algorithm String No Terrain algorithm name. Allowed values: "hillshade",
- * "contours", "normalizedIndex", "terrarium", "terrainrgb". algorithm_params String No Terrain algorithm parameters tile_format String No Default will be automatically defined if the output image
- * needs a mask (png) or
- * not (jpeg). Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". tile_scale Integer No Tile scale factor affecting output size. Values > 1
- * produce larger tiles (e.g., 1=256x256, 2=512x512). minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. buffer String No Buffer on each side of the given tile. It must be a multiple of
- * `0.5`. Output
- * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
- * 1.0 = 258x258). color_formula String No rio-color formula (info:
- * https://github.com/mapbox/rio-color) resampling String No Resampling method. Allowed values: "nearest", "bilinear",
- * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Image output size limit if width and height limits are not
+ * set. height Integer No Height in pixels for the output image width Integer No Width in pixels for the output image rescale List<String> No comma (',') delimited Min,Max range. Can set
* multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
@@ -1520,92 +1743,122 @@ public Mono> listStatisticsWithResponse(String collectionId
* "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
* "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
* "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
- * "ylorrd_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. dst_crs String No Output Coordinate Reference System. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". format String No Output image format. Allowed values: "png", "npy", "tif",
+ * "jpeg", "jpg", "jp2", "webp", "pngraw".
* You can add these to a request with {@link RequestOptions#addQueryParam}
- * Response Body Schema
+ * Request Body Schema
*
*
* {@code
* {
- * tilejson: String (Optional)
- * name: String (Optional)
- * description: String (Optional)
- * version: String (Optional)
- * attribution: String (Optional)
- * template: String (Optional)
- * legend: String (Optional)
- * scheme: String(xyz/tms) (Optional)
- * tiles (Required): [
- * String (Required)
- * ]
- * grids (Optional): [
- * String (Optional)
- * ]
- * data (Optional): [
- * String (Optional)
- * ]
- * minzoom: Integer (Optional)
- * maxzoom: Integer (Optional)
- * bounds (Optional): [
- * double (Optional)
- * ]
- * center (Optional): [
- * double (Optional)
- * ]
+ * geometry (Required): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * type: String(Feature) (Required)
+ * properties (Optional): {
+ * String: BinaryData (Required)
+ * }
* }
* }
*
*
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
* @param collectionId STAC Collection Identifier.
* @param itemId STAC Item Identifier.
- * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param body Request GeoJson body.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return tileJSON metadata describing a tile set according to the TileJSON specification
- *
- * Based on https://github.com/mapbox/tilejson-spec/tree/master/2.2.0 along with {@link Response} on successful
- * completion of {@link Mono}.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getTileJsonWithResponse(String collectionId, String itemId,
- String tileMatrixSetId, RequestOptions requestOptions) {
- return this.serviceClient.getTileJsonWithResponseAsync(collectionId, itemId, tileMatrixSetId, requestOptions);
+ public Mono> cropFeatureWithResponse(String collectionId, String itemId, BinaryData body,
+ RequestOptions requestOptions) {
+ return this.serviceClient.cropFeatureWithResponseAsync(collectionId, itemId, body, requestOptions);
}
/**
- * Tile Tilematrixsetid As Path
+ * Geojson Feature Crop With Format
*
- * Create map tile from a dataset.
+ * Create image from a geojson feature with format.
* Query Parameters
*
* Query Parameters
* Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
* {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx String No Per asset band indexes (coma separated indexes, e.g.
- * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata Double No Overwrite internal Nodata value nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
- * "contours", "normalizedIndex", "terrarium", "terrainrgb". algorithm_params String No Terrain algorithm parameters buffer String No Buffer on each side of the given tile. It must be a multiple of
- * `0.5`. Output
- * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
- * 1.0 = 258x258). color_formula String No rio-color formula (info:
* https://github.com/mapbox/rio-color) coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
* "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Image output size limit if width and height limits are not
+ * set. height Integer No Height in pixels for the output image width Integer No Width in pixels for the output image rescale List<String> No comma (',') delimited Min,Max range. Can set
* multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
@@ -1633,14 +1886,59 @@ public Mono> getTileJsonWithResponse(String collectionId, S
* "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
* "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
* "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
- * "ylorrd_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. dst_crs String No Output Coordinate Reference System. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<String> No The index of a subdataset band within the
+ * subdataset_bands List<Integer> No The index of a subdataset band within the
* asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
* You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Request Body Schema
+ *
+ *
+ * {@code
+ * {
+ * geometry (Required): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * type: String(Feature) (Required)
+ * properties (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
* Response Body Schema
*
*
@@ -1651,15 +1949,8 @@ public Mono> getTileJsonWithResponse(String collectionId, S
*
* @param collectionId STAC Collection Identifier.
* @param itemId STAC Item Identifier.
- * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
- * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
- * representing the scaleDenominator the tile.
- * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
- * MatrixHeight-1 for the selected TileMatrix.
- * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
- * MatrixWidth-1 for the selected TileMatrix.
- * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
* @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param body Request GeoJson body.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
@@ -1669,45 +1960,46 @@ public Mono> getTileJsonWithResponse(String collectionId, S
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getTileWithResponse(String collectionId, String itemId, String tileMatrixSetId,
- double z, double x, double y, double scale, String format, RequestOptions requestOptions) {
- return this.serviceClient.getTileWithResponseAsync(collectionId, itemId, tileMatrixSetId, z, x, y, scale,
- format, requestOptions);
+ public Mono> cropFeatureByFormatWithResponse(String collectionId, String itemId, String format,
+ BinaryData body, RequestOptions requestOptions) {
+ return this.serviceClient.cropFeatureByFormatWithResponseAsync(collectionId, itemId, format, body,
+ requestOptions);
}
/**
- * Wmts Tilematrixsetid As Path
+ * Geojson Feature Crop With Dimensions
*
- * OGC WMTS endpoint.
+ * Create image from a geojson feature with dimensions.
* Query Parameters
*
* Query Parameters
* Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
* {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx String No Per asset band indexes (coma separated indexes, e.g.
- * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata Double No Overwrite internal Nodata value nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
- * "contours", "normalizedIndex", "terrarium", "terrainrgb". algorithm_params String No Terrain algorithm parameters tile_format String No Output image type. Default is png. Allowed values: "png",
- * "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". tile_scale Integer No Tile scale factor affecting output size. Values > 1
- * produce larger tiles (e.g., 1=256x256, 2=512x512). minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. buffer String No Buffer on each side of the given tile. It must be a multiple of
- * `0.5`. Output
- * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
- * 1.0 = 258x258). color_formula String No rio-color formula (info:
* https://github.com/mapbox/rio-color) coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
* "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Image output size limit if width and height limits are not
+ * set. rescale List<String> No comma (',') delimited Min,Max range. Can set
* multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
@@ -1735,239 +2027,403 @@ public Mono> getTileWithResponse(String collectionId, Strin
* "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
* "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
* "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
- * "ylorrd_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. dst_crs String No Output Coordinate Reference System. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
* You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Request Body Schema
+ *
+ *
+ * {@code
+ * {
+ * geometry (Required): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * type: String(Feature) (Required)
+ * properties (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
* Response Body Schema
*
*
* {@code
- * byte[]
+ * BinaryData
* }
*
*
* @param collectionId STAC Collection Identifier.
* @param itemId STAC Item Identifier.
- * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param width Width in pixels for the output image.
+ * @param height Height in pixels for the output image.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param body Request GeoJson body.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return represent a byte array along with {@link Response} on successful completion of {@link Mono}.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getWmtsCapabilitiesWithResponse(String collectionId, String itemId,
- String tileMatrixSetId, RequestOptions requestOptions) {
- return this.serviceClient.getWmtsCapabilitiesWithResponseAsync(collectionId, itemId, tileMatrixSetId,
- requestOptions);
+ public Mono> cropFeatureWidthByHeightWithResponse(String collectionId, String itemId,
+ int width, int height, String format, BinaryData body, RequestOptions requestOptions) {
+ return this.serviceClient.cropFeatureWidthByHeightWithResponseAsync(collectionId, itemId, width, height, format,
+ body, requestOptions);
}
/**
- * Get ClassMap Legend
+ * Item Bounds
*
- * Generate values and color swatches mapping for a given classmap.
+ * Return the bounds for a STAC item.
* Query Parameters
*
* Query Parameters
* Name Type Required Description trim_start Integer No Number of items to trim from the start of the
- * cmap trim_end Integer No Number of items to trim from the end of the cmap
- * You can add these to a request with {@link RequestOptions#addQueryParam}
- * Response Body Schema
+ * subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". Response Body Schema
*
*
* {@code
* {
- * (Optional): {
- * String: Object (Required)
- * }
+ * bounds (Required): [
+ * double (Required)
+ * ]
* }
* }
*
*
- * @param classmapName classmap name.
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return classMap Legend
- *
- * Generate values and color swatches mapping for a given classmap along with {@link Response} on successful
+ * @return geographic extent of a dataset expressed as a bounding box along with {@link Response} on successful
* completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getClassMapLegendWithResponse(String classmapName,
+ public Mono> getItemBoundsWithResponse(String collectionId, String itemId,
RequestOptions requestOptions) {
- return this.serviceClient.getClassMapLegendWithResponseAsync(classmapName, requestOptions);
+ return this.serviceClient.getItemBoundsWithResponseAsync(collectionId, itemId, requestOptions);
}
/**
- * Get Interval Legend
+ * Item Info
*
- * Generate values and color swatches mapping for a given interval classmap.
- *
- * Returns a color map for intervals, where each interval is defined by:
- * - A numeric range `[min, max]` representing the interval boundaries.
- * - An RGBA color `[red, green, blue, alpha]` associated with the interval.
- *
- * The response is a 2D array of interval definitions, where each element is a pair:
- * - The first element is an array of two numbers `[min, max]` defining the interval.
- * - The second element is an array of four numbers `[red, green, blue, alpha]` defining the RGBA color.
- *
- * Example:
- * ```json
- * [
- * [
- * [-2, 0], [0, 0, 0, 0]
- * ],
- * [
- * [1, 32], [255, 255, 178, 255]
- * ]
- * ]
- * ```
- * This example defines two intervals:
- * - The interval `[-2, 0]` is mapped to the color `[0, 0, 0, 0]` (transparent black).
- * - The interval `[1, 32]` is mapped to the color `[255, 255, 178, 255]` (opaque yellow).
+ * Return dataset's basic info for a STAC item.
* Query Parameters
*
* Query Parameters
* Name Type Required Description trim_start Integer No Number of items to trim from the start of the
- * cmap trim_end Integer No Number of items to trim from the end of the cmap subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array.
* You can add these to a request with {@link RequestOptions#addQueryParam}
* Response Body Schema
*
*
* {@code
- * [
- * (Required)[
- * (Required)[
- * long (Required)
- * ]
- * ]
- * ]
+ * {
+ * (Optional): {
+ * String (Required): {
+ * bounds (Required): [
+ * double (Required)
+ * ]
+ * band_metadata (Optional): [
+ * (Optional)[
+ * BinaryData (Optional)
+ * ]
+ * ]
+ * band_descriptions (Optional): [
+ * (Optional)[
+ * String (Optional)
+ * ]
+ * ]
+ * dtype: String (Required)
+ * nodata_type: String(Alpha/Mask/Internal/Nodata/None) (Optional)
+ * colorinterp (Optional): [
+ * String (Optional)
+ * ]
+ * driver: String (Optional)
+ * count: Integer (Optional)
+ * width: Integer (Optional)
+ * height: Integer (Optional)
+ * overviews (Optional): [
+ * int (Optional)
+ * ]
+ * scales (Optional): [
+ * int (Optional)
+ * ]
+ * offsets (Optional): [
+ * int (Optional)
+ * ]
+ * colormap (Optional): {
+ * String (Required): [
+ * String (Required)
+ * ]
+ * }
+ * minzoom: Integer (Optional)
+ * maxzoom: Integer (Optional)
+ * crs: String (Optional)
+ * }
+ * }
+ * }
* }
*
*
- * @param classmapName classmap name.
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return interval Legend
- *
- * Generate values and color swatches mapping for a given interval classmap.
- *
- * Returns a color map for intervals, where each interval is defined by:
- * - A numeric range `[min, max]` representing the interval boundaries.
- * - An RGBA color `[red, green, blue, alpha]` associated with the interval.
- *
- * The response is a 2D array of interval definitions, where each element is a pair:
- * - The first element is an array of two numbers `[min, max]` defining the interval.
- * - The second element is an array of four numbers `[red, green, blue, alpha]` defining the RGBA color.
- *
- * Example:
- * ```json
- * [
- * [
- * [-2, 0], [0, 0, 0, 0]
- * ],
- * [
- * [1, 32], [255, 255, 178, 255]
- * ]
- * ]
- * ```
- * This example defines two intervals:
- * - The interval `[-2, 0]` is mapped to the color `[0, 0, 0, 0]` (transparent black).
- * - The interval `[1, 32]` is mapped to the color `[255, 255, 178, 255]` (opaque yellow) along with
- * {@link Response} on successful completion of {@link Mono}.
+ * @return return dataset's basic info along with {@link Response} on successful completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getIntervalLegendWithResponse(String classmapName,
+ public Mono> getItemInfoWithResponse(String collectionId, String itemId,
RequestOptions requestOptions) {
- return this.serviceClient.getIntervalLegendWithResponseAsync(classmapName, requestOptions);
+ return this.serviceClient.getItemInfoWithResponseAsync(collectionId, itemId, requestOptions);
}
/**
- * Get Legend
- *
- * Generate a legend image for a given colormap.
+ * Item Info Geojson
*
- * If the colormap has non-contiguous values at the beginning or end,
- * which aren't desired in the output image, they can be trimmed by specifying
- * the number of values to trim.
+ * Return info as GeoJSON for a STAC item.
* Query Parameters
*
* Query Parameters
* Name Type Required Description height Double No The output height of the legend image width Double No The output width of the legend image trim_start Integer No Number of items to trim from the start of the
- * cmap trim_end Integer No Number of items to trim from the end of the cmap subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array.
* You can add these to a request with {@link RequestOptions#addQueryParam}
* Response Body Schema
*
*
* {@code
- * BinaryData
+ * {
+ * type: String(Feature) (Required)
+ * geometry (Required): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * properties (Required): {
+ * String (Required): {
+ * bounds (Required): [
+ * double (Required)
+ * ]
+ * band_metadata (Optional): [
+ * (Optional)[
+ * BinaryData (Optional)
+ * ]
+ * ]
+ * band_descriptions (Optional): [
+ * (Optional)[
+ * String (Optional)
+ * ]
+ * ]
+ * dtype: String (Required)
+ * nodata_type: String(Alpha/Mask/Internal/Nodata/None) (Optional)
+ * colorinterp (Optional): [
+ * String (Optional)
+ * ]
+ * driver: String (Optional)
+ * count: Integer (Optional)
+ * width: Integer (Optional)
+ * height: Integer (Optional)
+ * overviews (Optional): [
+ * int (Optional)
+ * ]
+ * scales (Optional): [
+ * int (Optional)
+ * ]
+ * offsets (Optional): [
+ * int (Optional)
+ * ]
+ * colormap (Optional): {
+ * String (Required): [
+ * String (Required)
+ * ]
+ * }
+ * minzoom: Integer (Optional)
+ * maxzoom: Integer (Optional)
+ * crs: String (Optional)
+ * }
+ * }
+ * id: String (Optional)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
* }
*
*
- * @param colorMapName The name of the registered colormap to generate a legend for.
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return legend
- *
- * Generate a legend image for a given colormap.
- *
- * If the colormap has non-contiguous values at the beginning or end,
- * which aren't desired in the output image, they can be trimmed by specifying
- * the number of values to trim along with {@link Response} on successful completion of {@link Mono}.
+ * @return geoJSON Feature object containing rio-tiler model information along with {@link Response} on successful
+ * completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getLegendWithResponse(String colorMapName, RequestOptions requestOptions) {
- return this.serviceClient.getLegendWithResponseAsync(colorMapName, requestOptions);
+ public Mono> getItemInfoGeoJsonWithResponse(String collectionId, String itemId,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getItemInfoGeoJsonWithResponseAsync(collectionId, itemId, requestOptions);
}
/**
- * Assets For Point
+ * Item Available Assets
*
- * Return a list of assets for a given point.
+ * Return a list of supported assets for a STAC item.
* Query Parameters
*
* Query Parameters
* Name Type Required Description scan_limit Integer No Return as soon as we scan N items (defaults to 10000 in
- * PgSTAC). items_limit Integer No Return as soon as we have N items per geometry (defaults
- * to 100 in PgSTAC). time_limit Integer No Return after N seconds to avoid long requests (defaults to
- * 5 in PgSTAC). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
- * to True in PgSTAC). skipcovered Boolean No Skip any items that would show up completely under the
- * previous items (defaults
- * to True in PgSTAC). coord-crs String No Coordinate Reference System of the input coords. Default to
- * `epsg:4326`. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
* You can add these to a request with {@link RequestOptions#addQueryParam}
* Response Body Schema
@@ -1975,53 +2431,13 @@ public Mono> getLegendWithResponse(String colorMapName, Req
*
* {@code
* [
- * (Required){
- * id: String (Required)
- * bbox (Required): [
- * double (Required)
- * ]
- * assets (Required): {
- * String (Required): {
- * platform: String (Optional)
- * instruments (Optional): [
- * String (Optional)
- * ]
- * constellation: String (Optional)
- * mission: String (Optional)
- * providers (Optional): [
- * (Optional){
- * name: String (Optional, Required on create)
- * description: String (Optional)
- * roles (Optional): [
- * String (Optional)
- * ]
- * url: String (Optional)
- * }
- * ]
- * gsd: Double (Optional)
- * created: OffsetDateTime (Optional)
- * updated: OffsetDateTime (Optional)
- * title: String (Optional)
- * description: String (Optional)
- * href: String (Optional, Required on create)
- * type: String (Optional)
- * roles (Optional): [
- * String (Optional)
- * ]
- * (Optional): {
- * String: Object (Required)
- * }
- * }
- * }
- * collection: String (Required)
- * }
+ * String (Required)
* ]
* }
*
*
- * @param searchId Search Id (pgSTAC Search Hash).
- * @param longitude Longitude.
- * @param latitude Latitude.
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
@@ -2031,225 +2447,365 @@ public Mono> getLegendWithResponse(String colorMapName, Req
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getMosaicsAssetsForPointWithResponse(String searchId, double longitude,
- double latitude, RequestOptions requestOptions) {
- return this.serviceClient.getMosaicsAssetsForPointWithResponseAsync(searchId, longitude, latitude,
- requestOptions);
+ public Mono> getItemAvailableAssetsWithResponse(String collectionId, String itemId,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getItemAvailableAssetsWithResponseAsync(collectionId, itemId, requestOptions);
}
/**
- * Assets For Tile Tilematrixsetid As Path
+ * Item Asset Statistics
*
- * Return a list of assets which overlap a given tile.
+ * Per asset statistics for a STAC item.
* Query Parameters
*
* Query Parameters
* Name Type Required Description scan_limit Integer No Return as soon as we scan N items (defaults to 10000 in
- * PgSTAC). items_limit Integer No Return as soon as we have N items per geometry (defaults
- * to 100 in PgSTAC). time_limit Integer No Return after N seconds to avoid long requests (defaults to
- * 5 in PgSTAC). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
- * to True in PgSTAC). skipcovered Boolean No Skip any items that would show up completely under the
- * previous items (defaults
- * to True in PgSTAC). bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Maximum dimension in pixels for the source data used to
+ * calculate statistics categorical Boolean No Return statistics for categorical dataset. c List<Integer> No List of pixel categorical values for which to report
+ * counts. In the form of "," separated string. p List<Integer> No List of percentile values (default to [2, 98]). In the
+ * form of "," separated string. histogram_bins String No Defines the number of equal-width bins in the given
+ * range (10, by default).
+ *
+ * If bins is a sequence (comma `,` delimited values), it defines a monotonically
+ * increasing array of bin edges, including the rightmost edge, allowing for
+ * non-uniform bin widths.
+ *
+ * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html histogram_range String No Comma `,` delimited range of the bins.
+ *
+ * The lower and upper range of the bins. If not provided, range is simply
+ * (a.min(), a.max()).
+ *
+ * Values outside the range are ignored. The first element of the range must be
+ * less than or equal to the second.
+ * range affects the automatic bin computation as well.
+ *
+ * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". asset_expression List<String> No Per asset band expression. In the form of
+ * "," separated string. height Integer No Force output image height. width Integer No Force output image width.
* You can add these to a request with {@link RequestOptions#addQueryParam}
* Response Body Schema
*
*
* {@code
- * [
- * (Required){
- * id: String (Required)
- * collection: String (Optional)
- * bbox (Required): [
- * double (Required)
- * ]
- * assets (Required): {
- * String (Required): {
- * platform: String (Optional)
- * instruments (Optional): [
- * String (Optional)
- * ]
- * constellation: String (Optional)
- * mission: String (Optional)
- * providers (Optional): [
- * (Optional){
- * name: String (Optional, Required on create)
- * description: String (Optional)
- * roles (Optional): [
- * String (Optional)
+ * {
+ * (Optional): {
+ * String (Required): {
+ * (Optional): {
+ * String (Required): {
+ * min: double (Required)
+ * max: double (Required)
+ * mean: double (Required)
+ * count: double (Required)
+ * sum: double (Required)
+ * std: double (Required)
+ * median: double (Required)
+ * majority: double (Required)
+ * minority: double (Required)
+ * unique: double (Required)
+ * histogram (Required): [
+ * (Required)[
+ * double (Required)
* ]
- * url: String (Optional)
- * }
- * ]
- * gsd: Double (Optional)
- * created: OffsetDateTime (Optional)
- * updated: OffsetDateTime (Optional)
- * title: String (Optional)
- * description: String (Optional)
- * href: String (Optional, Required on create)
- * type: String (Optional)
- * roles (Optional): [
- * String (Optional)
- * ]
- * (Optional): {
- * String: Object (Required)
+ * ]
+ * valid_percent: double (Required)
+ * masked_pixels: double (Required)
+ * valid_pixels: double (Required)
+ * percentile_2: double (Required)
+ * percentile_98: double (Required)
* }
* }
* }
* }
- * ]
+ * }
* }
*
*
- * @param searchId Search Id (pgSTAC Search Hash).
- * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
* @param collectionId STAC Collection Identifier.
- * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
- * representing the scaleDenominator the tile.
- * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
- * MatrixHeight-1 for the selected TileMatrix.
- * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
- * MatrixWidth-1 for the selected TileMatrix.
+ * @param itemId STAC Item Identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ * @return return dataset's statistics along with {@link Response} on successful completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getMosaicsAssetsForTileWithResponse(String searchId, String tileMatrixSetId,
- String collectionId, double z, double x, double y, RequestOptions requestOptions) {
- return this.serviceClient.getMosaicsAssetsForTileWithResponseAsync(searchId, tileMatrixSetId, collectionId, z,
- x, y, requestOptions);
+ public Mono> getItemAssetStatisticsWithResponse(String collectionId, String itemId,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getItemAssetStatisticsWithResponseAsync(collectionId, itemId, requestOptions);
}
/**
- * Info Search
+ * Item Statistics
*
- * Get Search query metadata.
+ * Merged assets statistics for a STAC item.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Maximum dimension in pixels for the source data used to
+ * calculate statistics categorical Boolean No Return statistics for categorical dataset. c List<Integer> No List of pixel categorical values for which to report
+ * counts. In the form of "," separated string. p List<Integer> No List of percentile values (default to [2, 98]). In the
+ * form of "," separated string. histogram_bins String No Defines the number of equal-width bins in the given
+ * range (10, by default).
+ *
+ * If bins is a sequence (comma `,` delimited values), it defines a monotonically
+ * increasing array of bin edges, including the rightmost edge, allowing for
+ * non-uniform bin widths.
+ *
+ * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html histogram_range String No Comma `,` delimited range of the bins.
+ *
+ * The lower and upper range of the bins. If not provided, range is simply
+ * (a.min(), a.max()).
+ *
+ * Values outside the range are ignored. The first element of the range must be
+ * less than or equal to the second.
+ * range affects the automatic bin computation as well.
+ *
+ * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Algorithm name. algorithm_params String No Algorithm parameter. height Integer No Force output image height. width Integer No Force output image width.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
* Response Body Schema
*
*
* {@code
* {
- * search (Required): {
- * hash: String (Required)
- * search (Required): {
- * String: Object (Required)
- * }
- * _where: String (Required)
- * orderby: String (Required)
- * lastused: OffsetDateTime (Required)
- * usecount: int (Required)
- * metadata (Required): {
- * type: String(mosaic/search) (Optional)
- * bounds: String (Optional)
- * minzoom: Integer (Optional)
- * maxzoom: Integer (Optional)
- * name: String (Optional)
- * assets (Optional): [
- * String (Optional)
+ * (Optional): {
+ * String (Required): {
+ * min: double (Required)
+ * max: double (Required)
+ * mean: double (Required)
+ * count: double (Required)
+ * sum: double (Required)
+ * std: double (Required)
+ * median: double (Required)
+ * majority: double (Required)
+ * minority: double (Required)
+ * unique: double (Required)
+ * histogram (Required): [
+ * (Required)[
+ * double (Required)
+ * ]
* ]
- * defaults (Optional): {
- * String: String (Required)
- * }
+ * valid_percent: double (Required)
+ * masked_pixels: double (Required)
+ * valid_pixels: double (Required)
+ * percentile_2: double (Required)
+ * percentile_98: double (Required)
* }
* }
- * links (Optional): [
- * (Optional){
- * rel: String (Optional)
- * title: String (Optional)
- * type: String(image/tiff; application=geotiff/image/jp2/image/png/image/jpeg/image/jpg/image/webp/application/x-binary/application/xml/application/json/application/geo+json/text/html/text/plain/application/x-protobuf) (Optional)
- * href: String (Optional, Required on create)
- * hreflang: String (Optional)
- * length: Integer (Optional)
- * method: String(GET/POST) (Optional)
- * headers (Optional): {
- * String: String (Required)
- * }
- * body (Optional): {
- * String: Object (Required)
- * }
- * merge: Boolean (Optional)
- * }
- * ]
* }
* }
*
*
- * @param searchId Search Id (pgSTAC Search Hash).
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return information about a registered STAC search query along with {@link Response} on successful completion of
- * {@link Mono}.
+ * @return return dataset's statistics along with {@link Response} on successful completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getMosaicsSearchInfoWithResponse(String searchId, RequestOptions requestOptions) {
- return this.serviceClient.getMosaicsSearchInfoWithResponseAsync(searchId, requestOptions);
+ public Mono> getItemStatisticsWithResponse(String collectionId, String itemId,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getItemStatisticsWithResponseAsync(collectionId, itemId, requestOptions);
}
/**
- * Register Search
- *
- * Register a Search query.
- * Request Body Schema
+ * Item Geojson Statistics
*
- *
- * {@code
- * {
- * collections (Optional): [
- * String (Optional)
- * ]
- * ids (Optional): [
- * String (Optional)
- * ]
- * bbox (Optional): [
- * double (Optional)
- * ]
- * intersects (Optional): {
- * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
- * bbox (Optional): [
- * double (Optional)
- * ]
- * }
- * query (Optional): {
- * String: Object (Required)
- * }
- * filter (Optional): {
- * String: Object (Required)
- * }
- * datetime: String (Optional)
- * sortby (Optional): [
- * (Optional){
- * field: String (Required)
- * direction: String(asc/desc) (Required)
- * }
- * ]
- * filter-lang: String(cql-json/cql2-json/cql2-text) (Optional)
- * metadata (Optional): {
- * type: String(mosaic/search) (Optional)
- * bounds: String (Optional)
- * minzoom: Integer (Optional)
- * maxzoom: Integer (Optional)
- * name: String (Optional)
- * assets (Optional): [
- * String (Optional)
+ * Get statistics from a GeoJSON feature for a STAC item.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Maximum dimension in pixels for the source data used to
+ * calculate statistics categorical Boolean No Return statistics for categorical dataset. c List<Integer> No List of pixel categorical values for which to report
+ * counts. In the form of "," separated string. p List<Integer> No List of percentile values (default to [2, 98]). In the
+ * form of "," separated string. histogram_bins String No Defines the number of equal-width bins in the given
+ * range (10, by default).
+ *
+ * If bins is a sequence (comma `,` delimited values), it defines a monotonically
+ * increasing array of bin edges, including the rightmost edge, allowing for
+ * non-uniform bin widths.
+ *
+ * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html histogram_range String No Comma `,` delimited range of the bins.
+ *
+ * The lower and upper range of the bins. If not provided, range is simply
+ * (a.min(), a.max()).
+ *
+ * Values outside the range are ignored. The first element of the range must be
+ * less than or equal to the second.
+ * range affects the automatic bin computation as well.
+ *
+ * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html dst_crs String No Output Coordinate Reference System. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Algorithm name. algorithm_params String No Algorithm parameter. height Integer No Force output image height. width Integer No Force output image width.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Request Body Schema
+ *
+ *
+ * {@code
+ * {
+ * geometry (Required): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
* ]
- * defaults (Optional): {
- * String: String (Required)
- * }
+ * }
+ * type: String(Feature) (Required)
+ * properties (Optional): {
+ * String: BinaryData (Required)
* }
* }
* }
@@ -2260,93 +2816,110 @@ public Mono> getMosaicsSearchInfoWithResponse(String search
*
* {@code
* {
- * searchid: String (Required)
- * links (Optional): [
- * (Optional){
- * rel: String (Optional)
- * title: String (Optional)
- * type: String(image/tiff; application=geotiff/image/jp2/image/png/image/jpeg/image/jpg/image/webp/application/x-binary/application/xml/application/json/application/geo+json/text/html/text/plain/application/x-protobuf) (Optional)
- * href: String (Optional, Required on create)
- * hreflang: String (Optional)
- * length: Integer (Optional)
- * method: String(GET/POST) (Optional)
- * headers (Optional): {
- * String: String (Required)
- * }
- * body (Optional): {
- * String: Object (Required)
+ * geometry (Required): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * type: String(Feature) (Required)
+ * properties (Optional): {
+ * statistics (Required): {
+ * String (Required): {
+ * min: double (Required)
+ * max: double (Required)
+ * mean: double (Required)
+ * count: double (Required)
+ * sum: double (Required)
+ * std: double (Required)
+ * median: double (Required)
+ * majority: double (Required)
+ * minority: double (Required)
+ * unique: double (Required)
+ * histogram (Required): [
+ * (Required)[
+ * double (Required)
+ * ]
+ * ]
+ * valid_percent: double (Required)
+ * masked_pixels: double (Required)
+ * valid_pixels: double (Required)
+ * percentile_2: double (Required)
+ * percentile_98: double (Required)
* }
- * merge: Boolean (Optional)
* }
- * ]
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
* }
* }
*
*
- * @param registerMosaicsSearchRequest The registerMosaicsSearchRequest parameter.
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param body Request GeoJson body.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return response from a successful mosaic registration with search ID and related links along with
- * {@link Response} on successful completion of {@link Mono}.
+ * @return sTAC Item representing a spatiotemporal asset with statistical information along with {@link Response} on
+ * successful completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> registerMosaicsSearchWithResponse(BinaryData registerMosaicsSearchRequest,
- RequestOptions requestOptions) {
- return this.serviceClient.registerMosaicsSearchWithResponseAsync(registerMosaicsSearchRequest, requestOptions);
+ public Mono> getItemFeatureStatisticsWithResponse(String collectionId, String itemId,
+ BinaryData body, RequestOptions requestOptions) {
+ return this.serviceClient.getItemFeatureStatisticsWithResponseAsync(collectionId, itemId, body, requestOptions);
}
/**
- * TileJson Tilematrixsetid As Path
+ * Item TileJson
*
- * Return TileJSON document for a searchId.
+ * Return TileJSON document for a STAC item.
* Query Parameters
*
* Query Parameters
* Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
* {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx String No Per asset band indexes (coma separated indexes, e.g.
- * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata Double No Overwrite internal Nodata value nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset scan_limit Integer No Return as soon as we scan N items (defaults to 10000 in
- * PgSTAC). items_limit Integer No Return as soon as we have N items per geometry (defaults
- * to 100 in PgSTAC). time_limit Integer No Return after N seconds to avoid long requests (defaults to
- * 5 in PgSTAC). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
- * to True in PgSTAC). skipcovered Boolean No Skip any items that would show up completely under the
- * previous items (defaults
- * to True in PgSTAC). reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
- * "contours", "normalizedIndex", "terrarium", "terrainrgb". algorithm_params String No Terrain algorithm parameters minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default:
+ * 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid",
+ * "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad",
+ * "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". tile_format String No Default will be automatically defined if the output image
* needs a mask (png) or
* not (jpeg). Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". tile_scale Integer No Tile scale factor affecting output size. Values > 1
* produce larger tiles (e.g., 1=256x256, 2=512x512). buffer String No Buffer on each side of the given tile. It must be a multiple of
+ * minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. buffer Double No Buffer on each side of the given tile. It must be a multiple of
* `0.5`. Output
* **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
* 1.0 = 258x258). color_formula String No rio-color formula (info:
* https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
* "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
- * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh". rescale List<String> No comma (',') delimited Min,Max range. Can set
* multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
@@ -2374,9 +2947,39 @@ public Mono> registerMosaicsSearchWithResponse(BinaryData r
* "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
* "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
* "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
- * "ylorrd_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
* You can add these to a request with {@link RequestOptions#addQueryParam}
* Response Body Schema
@@ -2413,8 +3016,8 @@ public Mono> registerMosaicsSearchWithResponse(BinaryData r
* }
*
*
- * @param searchId Search Id (pgSTAC Search Hash).
- * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
@@ -2427,52 +3030,52 @@ public Mono> registerMosaicsSearchWithResponse(BinaryData r
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getMosaicsTileJsonWithResponse(String searchId, String tileMatrixSetId,
+ public Mono> getItemTileJsonWithResponse(String collectionId, String itemId,
RequestOptions requestOptions) {
- return this.serviceClient.getMosaicsTileJsonWithResponseAsync(searchId, tileMatrixSetId, requestOptions);
+ return this.serviceClient.getItemTileJsonWithResponseAsync(collectionId, itemId, requestOptions);
}
/**
- * Tile Tilematrixsetid As Path
+ * Item TileJson Tilematrixsetid As Path
*
- * Create map tile.
+ * Return TileJSON document for a STAC item with TileMatrixSetId as path.
* Query Parameters
*
* Query Parameters
* Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
* {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx String No Per asset band indexes (coma separated indexes, e.g.
- * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata Double No Overwrite internal Nodata value nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset scan_limit Integer No Return as soon as we scan N items (defaults to 10000 in
- * PgSTAC). items_limit Integer No Return as soon as we have N items per geometry (defaults
- * to 100 in PgSTAC). time_limit Integer No Return after N seconds to avoid long requests (defaults to
- * 5 in PgSTAC). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
- * to True in PgSTAC). skipcovered Boolean No Skip any items that would show up completely under the
- * previous items (defaults
- * to True in PgSTAC). reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
- * "contours", "normalizedIndex", "terrarium", "terrainrgb". algorithm_params String No Terrain algorithm parameters buffer String No Buffer on each side of the given tile. It must be a multiple of
+ * tile_format String No Default will be automatically defined if the output image
+ * needs a mask (png) or
+ * not (jpeg). Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". tile_scale Integer No Tile scale factor affecting output size. Values > 1
+ * produce larger tiles (e.g., 1=256x256, 2=512x512). minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. buffer Double No Buffer on each side of the given tile. It must be a multiple of
* `0.5`. Output
* **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
* 1.0 = 258x258). color_formula String No rio-color formula (info:
* https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
* "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
- * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh". rescale List<String> No comma (',') delimited Min,Max range. Can set
* multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
@@ -2500,70 +3103,134 @@ public Mono> getMosaicsTileJsonWithResponse(String searchId
* "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
* "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
* "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
- * "ylorrd_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
* You can add these to a request with {@link RequestOptions#addQueryParam}
* Response Body Schema
*
*
* {@code
- * BinaryData
+ * {
+ * tilejson: String (Optional)
+ * name: String (Optional)
+ * description: String (Optional)
+ * version: String (Optional)
+ * attribution: String (Optional)
+ * template: String (Optional)
+ * legend: String (Optional)
+ * scheme: String(xyz/tms) (Optional)
+ * tiles (Required): [
+ * String (Required)
+ * ]
+ * grids (Optional): [
+ * String (Optional)
+ * ]
+ * data (Optional): [
+ * String (Optional)
+ * ]
+ * minzoom: Integer (Optional)
+ * maxzoom: Integer (Optional)
+ * bounds (Optional): [
+ * double (Optional)
+ * ]
+ * center (Optional): [
+ * double (Optional)
+ * ]
+ * }
* }
*
*
- * @param searchId Search Id (pgSTAC Search Hash).
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
* @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
- * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
- * representing the scaleDenominator the tile.
- * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
- * MatrixHeight-1 for the selected TileMatrix.
- * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
- * MatrixWidth-1 for the selected TileMatrix.
- * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
- * @param format Output format for the tile or image (e.g., png, jpeg, webp).
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
* @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
* @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ * @return tileJSON metadata describing a tile set according to the TileJSON specification
+ *
+ * Based on https://github.com/mapbox/tilejson-spec/tree/master/2.2.0 along with {@link Response} on successful
+ * completion of {@link Mono}.
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getMosaicsTileWithResponse(String searchId, String tileMatrixSetId, double z,
- double x, double y, double scale, String format, RequestOptions requestOptions) {
- return this.serviceClient.getMosaicsTileWithResponseAsync(searchId, tileMatrixSetId, z, x, y, scale, format,
+ public Mono> getItemTileJsonByTmsWithResponse(String collectionId, String itemId,
+ String tileMatrixSetId, RequestOptions requestOptions) {
+ return this.serviceClient.getItemTileJsonByTmsWithResponseAsync(collectionId, itemId, tileMatrixSetId,
requestOptions);
}
/**
- * Wmts Tilematrixsetid As Path
+ * Item Wmts
*
- * OGC WMTS endpoint.
+ * OGC WMTS endpoint for a STAC item.
* Query Parameters
*
* Query Parameters
* Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
* {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx String No Per asset band indexes (coma separated indexes, e.g.
- * "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image") asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata Double No Overwrite internal Nodata value nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
- * "contours", "normalizedIndex", "terrarium", "terrainrgb". algorithm_params String No Terrain algorithm parameters TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default:
+ * 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid",
+ * "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad",
+ * "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". tile_format String No Output image type. Default is png. Allowed values: "png",
* "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". tile_scale Integer No Tile scale factor affecting output size. Values > 1
* produce larger tiles (e.g., 1=256x256, 2=512x512). minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. buffer String No Buffer on each side of the given tile. It must be a multiple of
+ * buffer Double No Buffer on each side of the given tile. It must be a multiple of
* `0.5`. Output
* **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
* 1.0 = 258x258). > getMosaicsTileWithResponse(String searchId, St
* "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
* "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
* "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
- * "ylorrd_r".
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r".
* colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
* You can add these to a request with {@link RequestOptions#addQueryParam}
* Response Body Schema
@@ -2611,8 +3308,8 @@ public Mono> getMosaicsTileWithResponse(String searchId, St
* }
*
*
- * @param searchId Search Id (pgSTAC Search Hash).
- * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
* @param requestOptions The options to configure the HTTP request before HTTP client sends it.
* @throws HttpResponseException thrown if the request is rejected by server.
* @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
@@ -2622,27 +3319,7067 @@ public Mono> getMosaicsTileWithResponse(String searchId, St
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono> getMosaicsWmtsCapabilitiesWithResponse(String searchId, String tileMatrixSetId,
+ public Mono> getItemWmtsCapabilitiesWithResponse(String collectionId, String itemId,
RequestOptions requestOptions) {
- return this.serviceClient.getMosaicsWmtsCapabilitiesWithResponseAsync(searchId, tileMatrixSetId,
- requestOptions);
+ return this.serviceClient.getItemWmtsCapabilitiesWithResponseAsync(collectionId, itemId, requestOptions);
}
/**
- * Matrix Definition
- *
- * Return Matrix Definition.
- *
- * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
- * @throws IllegalArgumentException thrown if parameters fail the validation.
- * @throws HttpResponseException thrown if the request is rejected by server.
- * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
- * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
- * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
- * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
- * @return https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/tileMatrixSet.json
+ * Item Wmts Tilematrixsetid As Path
*
- * A definition of a tile matrix set following the Tile Matrix Set standard.
+ * OGC WMTS endpoint for a STAC item with TileMatrixSetId as path.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters tile_format String No Output image type. Default is png. Allowed values: "png",
+ * "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". tile_scale Integer No Tile scale factor affecting output size. Values > 1
+ * produce larger tiles (e.g., 1=256x256, 2=512x512). minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * byte[]
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represent a byte array along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getItemWmtsCapabilitiesByTmsWithResponse(String collectionId, String itemId,
+ String tileMatrixSetId, RequestOptions requestOptions) {
+ return this.serviceClient.getItemWmtsCapabilitiesByTmsWithResponseAsync(collectionId, itemId, tileMatrixSetId,
+ requestOptions);
+ }
+
+ /**
+ * Item Point
+ *
+ * Get point value for a STAC item dataset.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * coordinates (Required): [
+ * double (Required)
+ * ]
+ * values (Required): [
+ * double (Required)
+ * ]
+ * band_names (Required): [
+ * String (Required)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param longitude Longitude.
+ * @param latitude Latitude.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response model for point query operations providing values at a specific location along with
+ * {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getItemPointWithResponse(String collectionId, String itemId, double longitude,
+ double latitude, RequestOptions requestOptions) {
+ return this.serviceClient.getItemPointWithResponseAsync(collectionId, itemId, longitude, latitude,
+ requestOptions);
+ }
+
+ /**
+ * Item Preview
+ *
+ * Create preview of a STAC item dataset.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters format String No Output format for the tile or image (e.g., png, jpeg, webp).
+ * Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) dst_crs String No Output Coordinate Reference System. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Image output size limit if width and height limits are not
+ * set. height Integer No Height in pixels for the output image width Integer No Width in pixels for the output image rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getItemPreviewWithResponse(String collectionId, String itemId,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getItemPreviewWithResponseAsync(collectionId, itemId, requestOptions);
+ }
+
+ /**
+ * Item Preview With Format
+ *
+ * Create preview of a STAC item dataset with format.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) dst_crs String No Output Coordinate Reference System. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Image output size limit if width and height limits are not
+ * set. height Integer No Height in pixels for the output image width Integer No Width in pixels for the output image rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getItemPreviewWithFormatWithResponse(String collectionId, String itemId,
+ String format, RequestOptions requestOptions) {
+ return this.serviceClient.getItemPreviewWithFormatWithResponseAsync(collectionId, itemId, format,
+ requestOptions);
+ }
+
+ /**
+ * Item Bbox
+ *
+ * Create an image from part of a STAC item dataset (bounding box crop).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. dst_crs String No Output Coordinate Reference System. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Image output size limit if width and height limits are not
+ * set. height Integer No Height in pixels for the output image width Integer No Width in pixels for the output image rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param minx Bounding box min X.
+ * @param miny Bounding box min Y.
+ * @param maxx Bounding box max X.
+ * @param maxy Bounding box max Y.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getItemBboxCropWithResponse(String collectionId, String itemId, double minx,
+ double miny, double maxx, double maxy, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getItemBboxCropWithResponseAsync(collectionId, itemId, minx, miny, maxx, maxy, format,
+ requestOptions);
+ }
+
+ /**
+ * Item Bbox With Dimensions
+ *
+ * Create an image from part of a STAC item dataset (bounding box crop with dimensions).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. dst_crs String No Output Coordinate Reference System. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". max_size Integer No Image output size limit if width and height limits are not
+ * set. rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param minx Bounding box min X.
+ * @param miny Bounding box min Y.
+ * @param maxx Bounding box max X.
+ * @param maxy Bounding box max Y.
+ * @param width Force output image width.
+ * @param height Force output image height.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getItemBboxCropWithDimensionsWithResponse(String collectionId, String itemId,
+ double minx, double miny, double maxx, double maxy, int width, int height, String format,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getItemBboxCropWithDimensionsWithResponseAsync(collectionId, itemId, minx, miny, maxx,
+ maxy, width, height, format, requestOptions);
+ }
+
+ /**
+ * Collection Tileset List
+ *
+ * Return a list of available tilesets for a STAC collection.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * tilesets (Required): [
+ * (Required){
+ * title: String (Optional)
+ * dataType: String (Optional)
+ * crs: String (Optional)
+ * links (Optional): [
+ * (Optional){
+ * href: String (Required)
+ * rel: String (Required)
+ * type: String (Optional)
+ * title: String (Optional)
+ * }
+ * ]
+ * boundingBox (Optional): {
+ * lowerLeft (Required): [
+ * double (Required)
+ * ]
+ * upperRight (Required): [
+ * double (Required)
+ * ]
+ * crs: String (Optional)
+ * }
+ * accessConstraints: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response containing a list of available tilesets along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionTilesetsWithResponse(String collectionId,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionTilesetsWithResponseAsync(collectionId, requestOptions);
+ }
+
+ /**
+ * Collection Tileset Metadata
+ *
+ * Return metadata for a specific tileset of a STAC collection.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * title: String (Optional)
+ * dataType: String (Optional)
+ * crs: String (Optional)
+ * links (Optional): [
+ * (Optional){
+ * href: String (Required)
+ * rel: String (Required)
+ * type: String (Optional)
+ * title: String (Optional)
+ * }
+ * ]
+ * boundingBox (Optional): {
+ * lowerLeft (Required): [
+ * double (Required)
+ * ]
+ * upperRight (Required): [
+ * double (Required)
+ * ]
+ * crs: String (Optional)
+ * }
+ * accessConstraints: String (Optional)
+ * tileMatrixSetLimits (Optional): [
+ * (Optional){
+ * tileMatrix: String (Required)
+ * minTileRow: int (Required)
+ * maxTileRow: int (Required)
+ * minTileCol: int (Required)
+ * maxTileCol: int (Required)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return detailed metadata about a specific tileset, including tile matrix set limits along with {@link Response}
+ * on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionTilesetMetadataWithResponse(String collectionId,
+ String tileMatrixSetId, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionTilesetMetadataWithResponseAsync(collectionId, tileMatrixSetId,
+ requestOptions);
+ }
+
+ /**
+ * Collection Tile Tilematrixsetid
+ *
+ * Create map tile for a STAC collection (with TileMatrixSetId, scale, and format in path).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionTileByScaleAndFormatWithResponse(String collectionId,
+ String tileMatrixSetId, double z, double x, double y, double scale, String format,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionTileByScaleAndFormatWithResponseAsync(collectionId, tileMatrixSetId, z,
+ x, y, scale, format, requestOptions);
+ }
+
+ /**
+ * Collection Tile Tilematrixsetid Plain
+ *
+ * Create map tile for a STAC collection (with TileMatrixSetId, without scale or format).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters format String No Output format for the tile or image (e.g., png, jpeg, webp).
+ * Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". scale Integer No Numeric scale factor for the tile. Higher values produce larger
+ * tiles buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionTileWithResponse(String collectionId, String tileMatrixSetId,
+ double z, double x, double y, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionTileWithResponseAsync(collectionId, tileMatrixSetId, z, x, y,
+ requestOptions);
+ }
+
+ /**
+ * Collection Tile Tilematrixsetid Format
+ *
+ * Create map tile for a STAC collection (with TileMatrixSetId and format, without scale).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters scale Integer No Numeric scale factor for the tile. Higher values produce larger
+ * tiles buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionTileByFormatWithResponse(String collectionId, String tileMatrixSetId,
+ double z, double x, double y, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionTileByFormatWithResponseAsync(collectionId, tileMatrixSetId, z, x, y,
+ format, requestOptions);
+ }
+
+ /**
+ * Collection Tile Tilematrixsetid Scale
+ *
+ * Create map tile for a STAC collection (with TileMatrixSetId and scale, without format).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters format String No Output format for the tile or image (e.g., png, jpeg, webp).
+ * Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionTileByScaleWithResponse(String collectionId, String tileMatrixSetId,
+ double z, double x, double y, double scale, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionTileByScaleWithResponseAsync(collectionId, tileMatrixSetId, z, x, y,
+ scale, requestOptions);
+ }
+
+ /**
+ * Collection Tile
+ *
+ * Create map tile for a STAC collection (without TileMatrixSetId, with scale and format).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default:
+ * 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid",
+ * "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad",
+ * "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles (default: "1").
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp) (default: "png").
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionTileNoTmsByScaleAndFormatWithResponse(String collectionId, double z,
+ double x, double y, double scale, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionTileNoTmsByScaleAndFormatWithResponseAsync(collectionId, z, x, y, scale,
+ format, requestOptions);
+ }
+
+ /**
+ * Collection Tile Plain
+ *
+ * Create map tile for a STAC collection (without TileMatrixSetId, scale, or format).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default:
+ * 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid",
+ * "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad",
+ * "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". format String No Output format for the tile or image (e.g., png, jpeg, webp).
+ * Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". scale Integer No Numeric scale factor for the tile. Higher values produce larger
+ * tiles buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionTileNoTmsWithResponse(String collectionId, double z, double x,
+ double y, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionTileNoTmsWithResponseAsync(collectionId, z, x, y, requestOptions);
+ }
+
+ /**
+ * Collection Tile Format
+ *
+ * Create map tile for a STAC collection (with format, without TileMatrixSetId or scale).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default:
+ * 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid",
+ * "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad",
+ * "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". scale Integer No Numeric scale factor for the tile. Higher values produce larger
+ * tiles buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionTileNoTmsByFormatWithResponse(String collectionId, double z,
+ double x, double y, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionTileNoTmsByFormatWithResponseAsync(collectionId, z, x, y, format,
+ requestOptions);
+ }
+
+ /**
+ * Collection Tile Scale
+ *
+ * Create map tile for a STAC collection (with scale, without TileMatrixSetId or format).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default:
+ * 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid",
+ * "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad",
+ * "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". format String No Output format for the tile or image (e.g., png, jpeg, webp).
+ * Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionTileNoTmsByScaleWithResponse(String collectionId, double z, double x,
+ double y, double scale, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionTileNoTmsByScaleWithResponseAsync(collectionId, z, x, y, scale,
+ requestOptions);
+ }
+
+ /**
+ * Collection TileJson
+ *
+ * Return TileJSON document for a STAC collection.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default:
+ * 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid",
+ * "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad",
+ * "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". tile_format String No Default will be automatically defined if the output image
+ * needs a mask (png) or
+ * not (jpeg). Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". tile_scale Integer No Tile scale factor affecting output size. Values > 1
+ * produce larger tiles (e.g., 1=256x256, 2=512x512). minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * tilejson: String (Optional)
+ * name: String (Optional)
+ * description: String (Optional)
+ * version: String (Optional)
+ * attribution: String (Optional)
+ * template: String (Optional)
+ * legend: String (Optional)
+ * scheme: String(xyz/tms) (Optional)
+ * tiles (Required): [
+ * String (Required)
+ * ]
+ * grids (Optional): [
+ * String (Optional)
+ * ]
+ * data (Optional): [
+ * String (Optional)
+ * ]
+ * minzoom: Integer (Optional)
+ * maxzoom: Integer (Optional)
+ * bounds (Optional): [
+ * double (Optional)
+ * ]
+ * center (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return tileJSON metadata describing a tile set according to the TileJSON specification
+ *
+ * Based on https://github.com/mapbox/tilejson-spec/tree/master/2.2.0 along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionTileJsonWithResponse(String collectionId,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionTileJsonWithResponseAsync(collectionId, requestOptions);
+ }
+
+ /**
+ * Collection TileJson Tilematrixsetid As Path
+ *
+ * Return TileJSON document for a STAC collection with TileMatrixSetId as path.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters tile_format String No Default will be automatically defined if the output image
+ * needs a mask (png) or
+ * not (jpeg). Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". tile_scale Integer No Tile scale factor affecting output size. Values > 1
+ * produce larger tiles (e.g., 1=256x256, 2=512x512). minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * tilejson: String (Optional)
+ * name: String (Optional)
+ * description: String (Optional)
+ * version: String (Optional)
+ * attribution: String (Optional)
+ * template: String (Optional)
+ * legend: String (Optional)
+ * scheme: String(xyz/tms) (Optional)
+ * tiles (Required): [
+ * String (Required)
+ * ]
+ * grids (Optional): [
+ * String (Optional)
+ * ]
+ * data (Optional): [
+ * String (Optional)
+ * ]
+ * minzoom: Integer (Optional)
+ * maxzoom: Integer (Optional)
+ * bounds (Optional): [
+ * double (Optional)
+ * ]
+ * center (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return tileJSON metadata describing a tile set according to the TileJSON specification
+ *
+ * Based on https://github.com/mapbox/tilejson-spec/tree/master/2.2.0 along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionTileJsonByTmsWithResponse(String collectionId,
+ String tileMatrixSetId, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionTileJsonByTmsWithResponseAsync(collectionId, tileMatrixSetId,
+ requestOptions);
+ }
+
+ /**
+ * Collection Wmts
+ *
+ * OGC WMTS endpoint for a STAC collection.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default:
+ * 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid",
+ * "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad",
+ * "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". tile_format String No Output image type. Default is png. Allowed values: "png",
+ * "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". tile_scale Integer No Tile scale factor affecting output size. Values > 1
+ * produce larger tiles (e.g., 1=256x256, 2=512x512). minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * byte[]
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represent a byte array along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionWmtsCapabilitiesWithResponse(String collectionId,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionWmtsCapabilitiesWithResponseAsync(collectionId, requestOptions);
+ }
+
+ /**
+ * Collection Wmts Tilematrixsetid As Path
+ *
+ * OGC WMTS endpoint for a STAC collection with TileMatrixSetId as path.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. tile_format String No Output image type. Default is png. Allowed values: "png",
+ * "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". tile_scale Integer No Tile scale factor affecting output size. Values > 1
+ * produce larger tiles (e.g., 1=256x256, 2=512x512). minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * byte[]
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represent a byte array along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionWmtsCapabilitiesByTmsWithResponse(String collectionId,
+ String tileMatrixSetId, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionWmtsCapabilitiesByTmsWithResponseAsync(collectionId, tileMatrixSetId,
+ requestOptions);
+ }
+
+ /**
+ * Collection Assets For Tile Tilematrixsetid As Path
+ *
+ * Return a list of assets which overlap a given tile for a STAC collection (with TileMatrixSetId).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * [
+ * (Required){
+ * id: String (Required)
+ * collection: String (Optional)
+ * bbox (Required): [
+ * double (Required)
+ * ]
+ * assets (Required): {
+ * String (Required): {
+ * platform: String (Optional)
+ * instruments (Optional): [
+ * String (Optional)
+ * ]
+ * constellation: String (Optional)
+ * mission: String (Optional)
+ * providers (Optional): [
+ * (Optional){
+ * name: String (Optional, Required on create)
+ * description: String (Optional)
+ * roles (Optional): [
+ * String (Optional)
+ * ]
+ * url: String (Optional)
+ * }
+ * ]
+ * gsd: Double (Optional)
+ * created: OffsetDateTime (Optional)
+ * updated: OffsetDateTime (Optional)
+ * title: String (Optional)
+ * description: String (Optional)
+ * href: String (Optional, Required on create)
+ * type: String (Optional)
+ * roles (Optional): [
+ * String (Optional)
+ * ]
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ * }
+ * ]
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionAssetsForTileWithResponse(String collectionId,
+ String tileMatrixSetId, double z, double x, double y, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionAssetsForTileWithResponseAsync(collectionId, tileMatrixSetId, z, x, y,
+ requestOptions);
+ }
+
+ /**
+ * Collection Assets For Tile
+ *
+ * Return a list of assets which overlap a given tile for a STAC collection (without TileMatrixSetId).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default:
+ * 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid",
+ * "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad",
+ * "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * [
+ * BinaryData (Required)
+ * ]
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionAssetsForTileNoTmsWithResponse(String collectionId, double z,
+ double x, double y, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionAssetsForTileNoTmsWithResponseAsync(collectionId, z, x, y,
+ requestOptions);
+ }
+
+ /**
+ * Collection Assets For Bbox
+ *
+ * Return a list of assets which overlap a given bounding box for a STAC collection.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * [
+ * BinaryData (Required)
+ * ]
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param minx Bounding box min X.
+ * @param miny Bounding box min Y.
+ * @param maxx Bounding box max X.
+ * @param maxy Bounding box max Y.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionAssetsForBboxWithResponse(String collectionId, double minx,
+ double miny, double maxx, double maxy, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionAssetsForBboxWithResponseAsync(collectionId, minx, miny, maxx, maxy,
+ requestOptions);
+ }
+
+ /**
+ * Collection Info
+ *
+ * Return search query info from a STAC collection identifier.
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * search (Required): {
+ * hash: String (Required)
+ * search (Required): {
+ * String: BinaryData (Required)
+ * }
+ * lastused: OffsetDateTime (Required)
+ * usecount: int (Required)
+ * metadata (Required): {
+ * type: String(mosaic/search) (Optional)
+ * bounds: String (Optional)
+ * minzoom: Integer (Optional)
+ * maxzoom: Integer (Optional)
+ * name: String (Optional)
+ * assets (Optional): [
+ * String (Optional)
+ * ]
+ * defaults (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * links (Optional): [
+ * (Optional){
+ * rel: String (Optional)
+ * title: String (Optional)
+ * type: String(image/tiff; application=geotiff/image/jp2/image/png/image/jpeg/image/jpg/image/webp/application/x-binary/application/xml/application/json/application/geo+json/text/html/text/plain/application/x-protobuf) (Optional)
+ * href: String (Optional, Required on create)
+ * hreflang: String (Optional)
+ * length: Integer (Optional)
+ * method: String(GET/POST) (Optional)
+ * headers (Optional): {
+ * String: String (Required)
+ * }
+ * body (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * merge: Boolean (Optional)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return information about a registered STAC search query along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionInfoWithResponse(String collectionId,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionInfoWithResponseAsync(collectionId, requestOptions);
+ }
+
+ /**
+ * Collection Bbox
+ *
+ * Create an image from part of a STAC collection dataset (bounding box crop).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. dst_crs String No Output Coordinate Reference System. max_size Integer No Image output size limit if width and height limits are not
+ * set. height Integer No Height in pixels for the output image width Integer No Width in pixels for the output image color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param minx Bounding box min X.
+ * @param miny Bounding box min Y.
+ * @param maxx Bounding box max X.
+ * @param maxy Bounding box max Y.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionBboxCropWithResponse(String collectionId, double minx, double miny,
+ double maxx, double maxy, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionBboxCropWithResponseAsync(collectionId, minx, miny, maxx, maxy, format,
+ requestOptions);
+ }
+
+ /**
+ * Collection Bbox With Dimensions
+ *
+ * Create an image from part of a STAC collection dataset (bounding box crop with dimensions).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. dst_crs String No Output Coordinate Reference System. max_size Integer No Image output size limit if width and height limits are not
+ * set. color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param minx Bounding box min X.
+ * @param miny Bounding box min Y.
+ * @param maxx Bounding box max X.
+ * @param maxy Bounding box max Y.
+ * @param width Force output image width.
+ * @param height Force output image height.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionBboxCropWithDimensionsWithResponse(String collectionId, double minx,
+ double miny, double maxx, double maxy, int width, int height, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionBboxCropWithDimensionsWithResponseAsync(collectionId, minx, miny, maxx,
+ maxy, width, height, format, requestOptions);
+ }
+
+ /**
+ * Collection Geojson Feature
+ *
+ * Create image from a geojson feature (without format in path).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. max_size Integer No Image output size limit if width and height limits are not
+ * set. height Integer No Height in pixels for the output image width Integer No Width in pixels for the output image color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. dst_crs String No Output Coordinate Reference System. format String No Output image format. Allowed values: "png", "npy", "tif",
+ * "jpeg", "jpg", "jp2", "webp", "pngraw".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Request Body Schema
+ *
+ *
+ * {@code
+ * {
+ * geometry (Required): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * type: String(Feature) (Required)
+ * properties (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param body Request GeoJson body.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> cropCollectionFeatureWithResponse(String collectionId, BinaryData body,
+ RequestOptions requestOptions) {
+ return this.serviceClient.cropCollectionFeatureWithResponseAsync(collectionId, body, requestOptions);
+ }
+
+ /**
+ * Collection Geojson Feature Crop With Format
+ *
+ * Create image from a geojson feature with format.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. max_size Integer No Image output size limit if width and height limits are not
+ * set. height Integer No Height in pixels for the output image width Integer No Width in pixels for the output image color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. dst_crs String No Output Coordinate Reference System.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Request Body Schema
+ *
+ *
+ * {@code
+ * {
+ * geometry (Required): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * type: String(Feature) (Required)
+ * properties (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param body Request GeoJson body.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> cropCollectionFeatureByFormatWithResponse(String collectionId, String format,
+ BinaryData body, RequestOptions requestOptions) {
+ return this.serviceClient.cropCollectionFeatureByFormatWithResponseAsync(collectionId, format, body,
+ requestOptions);
+ }
+
+ /**
+ * Collection Geojson Feature Crop With Dimensions
+ *
+ * Create image from a geojson feature with dimensions.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. max_size Integer No Image output size limit if width and height limits are not
+ * set. color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. dst_crs String No Output Coordinate Reference System.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Request Body Schema
+ *
+ *
+ * {@code
+ * {
+ * geometry (Required): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * type: String(Feature) (Required)
+ * properties (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param width Width in pixels for the output image.
+ * @param height Height in pixels for the output image.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param body Request GeoJson body.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> cropCollectionFeatureWidthByHeightWithResponse(String collectionId, int width,
+ int height, String format, BinaryData body, RequestOptions requestOptions) {
+ return this.serviceClient.cropCollectionFeatureWidthByHeightWithResponseAsync(collectionId, width, height,
+ format, body, requestOptions);
+ }
+
+ /**
+ * Collection Point
+ *
+ * Get Point value for a collection dataset.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * coordinates (Required): [
+ * double (Required)
+ * ]
+ * values (Required): [
+ * double (Required)
+ * ]
+ * band_names (Required): [
+ * String (Required)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param longitude Longitude.
+ * @param latitude Latitude.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response model for point query operations providing values at a specific location along with
+ * {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionPointWithResponse(String collectionId, double longitude,
+ double latitude, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionPointWithResponseAsync(collectionId, longitude, latitude,
+ requestOptions);
+ }
+
+ /**
+ * Collection Point Assets
+ *
+ * Return a list of assets for a given point in a collection.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). ids String No Array of Item ids. bbox String No Bounding box (west, south, east, north). query String No JSON query expression for filtering items. sortby String No Sorting expression (e.g. +/-property). datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * [
+ * (Required){
+ * id: String (Required)
+ * bbox (Required): [
+ * double (Required)
+ * ]
+ * assets (Required): {
+ * String (Required): {
+ * platform: String (Optional)
+ * instruments (Optional): [
+ * String (Optional)
+ * ]
+ * constellation: String (Optional)
+ * mission: String (Optional)
+ * providers (Optional): [
+ * (Optional){
+ * name: String (Optional, Required on create)
+ * description: String (Optional)
+ * roles (Optional): [
+ * String (Optional)
+ * ]
+ * url: String (Optional)
+ * }
+ * ]
+ * gsd: Double (Optional)
+ * created: OffsetDateTime (Optional)
+ * updated: OffsetDateTime (Optional)
+ * title: String (Optional)
+ * description: String (Optional)
+ * href: String (Optional, Required on create)
+ * type: String (Optional)
+ * roles (Optional): [
+ * String (Optional)
+ * ]
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ * collection: String (Required)
+ * }
+ * ]
+ * }
+ *
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param longitude Longitude.
+ * @param latitude Latitude.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getCollectionPointAssetsWithResponse(String collectionId, double longitude,
+ double latitude, RequestOptions requestOptions) {
+ return this.serviceClient.getCollectionPointAssetsWithResponseAsync(collectionId, longitude, latitude,
+ requestOptions);
+ }
+
+ /**
+ * Searches Tileset List
+ *
+ * Return a list of available tilesets for a mosaic search.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * tilesets (Required): [
+ * (Required){
+ * title: String (Optional)
+ * dataType: String (Optional)
+ * crs: String (Optional)
+ * links (Optional): [
+ * (Optional){
+ * href: String (Required)
+ * rel: String (Required)
+ * type: String (Optional)
+ * title: String (Optional)
+ * }
+ * ]
+ * boundingBox (Optional): {
+ * lowerLeft (Required): [
+ * double (Required)
+ * ]
+ * upperRight (Required): [
+ * double (Required)
+ * ]
+ * crs: String (Optional)
+ * }
+ * accessConstraints: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response containing a list of available tilesets along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchTilesetsWithResponse(String searchId, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchTilesetsWithResponseAsync(searchId, requestOptions);
+ }
+
+ /**
+ * Searches Tileset Metadata
+ *
+ * Return metadata for a specific tileset of a mosaic search.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * title: String (Optional)
+ * dataType: String (Optional)
+ * crs: String (Optional)
+ * links (Optional): [
+ * (Optional){
+ * href: String (Required)
+ * rel: String (Required)
+ * type: String (Optional)
+ * title: String (Optional)
+ * }
+ * ]
+ * boundingBox (Optional): {
+ * lowerLeft (Required): [
+ * double (Required)
+ * ]
+ * upperRight (Required): [
+ * double (Required)
+ * ]
+ * crs: String (Optional)
+ * }
+ * accessConstraints: String (Optional)
+ * tileMatrixSetLimits (Optional): [
+ * (Optional){
+ * tileMatrix: String (Required)
+ * minTileRow: int (Required)
+ * maxTileRow: int (Required)
+ * minTileCol: int (Required)
+ * maxTileCol: int (Required)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return detailed metadata about a specific tileset, including tile matrix set limits along with {@link Response}
+ * on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchTilesetMetadataWithResponse(String searchId, String tileMatrixSetId,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getSearchTilesetMetadataWithResponseAsync(searchId, tileMatrixSetId, requestOptions);
+ }
+
+ /**
+ * Searches Tile Tilematrixsetid
+ *
+ * Create map tile (with TileMatrixSetId, scale, and format in path).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchTileByScaleAndFormatWithResponse(String searchId, String tileMatrixSetId,
+ double z, double x, double y, double scale, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchTileByScaleAndFormatWithResponseAsync(searchId, tileMatrixSetId, z, x, y,
+ scale, format, requestOptions);
+ }
+
+ /**
+ * Searches Tile Tilematrixsetid Plain
+ *
+ * Create map tile (with TileMatrixSetId, without scale or format).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters format String No Output format for the tile or image (e.g., png, jpeg, webp).
+ * Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". scale Integer No Numeric scale factor for the tile. Higher values produce larger
+ * tiles buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchTileWithResponse(String searchId, String tileMatrixSetId, double z,
+ double x, double y, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchTileWithResponseAsync(searchId, tileMatrixSetId, z, x, y, requestOptions);
+ }
+
+ /**
+ * Searches Tile Tilematrixsetid Format
+ *
+ * Create map tile (with TileMatrixSetId and format, without scale).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters scale Integer No Numeric scale factor for the tile. Higher values produce larger
+ * tiles buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchTileByFormatWithResponse(String searchId, String tileMatrixSetId,
+ double z, double x, double y, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchTileByFormatWithResponseAsync(searchId, tileMatrixSetId, z, x, y, format,
+ requestOptions);
+ }
+
+ /**
+ * Searches Tile Tilematrixsetid Scale
+ *
+ * Create map tile (with TileMatrixSetId and scale, without format).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters format String No Output format for the tile or image (e.g., png, jpeg, webp).
+ * Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchTileByScaleWithResponse(String searchId, String tileMatrixSetId,
+ double z, double x, double y, double scale, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchTileByScaleWithResponseAsync(searchId, tileMatrixSetId, z, x, y, scale,
+ requestOptions);
+ }
+
+ /**
+ * Searches Assets For Tile Tilematrixsetid As Path
+ *
+ * Return a list of assets which overlap a given tile.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * [
+ * (Required){
+ * id: String (Required)
+ * collection: String (Optional)
+ * bbox (Required): [
+ * double (Required)
+ * ]
+ * assets (Required): {
+ * String (Required): {
+ * platform: String (Optional)
+ * instruments (Optional): [
+ * String (Optional)
+ * ]
+ * constellation: String (Optional)
+ * mission: String (Optional)
+ * providers (Optional): [
+ * (Optional){
+ * name: String (Optional, Required on create)
+ * description: String (Optional)
+ * roles (Optional): [
+ * String (Optional)
+ * ]
+ * url: String (Optional)
+ * }
+ * ]
+ * gsd: Double (Optional)
+ * created: OffsetDateTime (Optional)
+ * updated: OffsetDateTime (Optional)
+ * title: String (Optional)
+ * description: String (Optional)
+ * href: String (Optional, Required on create)
+ * type: String (Optional)
+ * roles (Optional): [
+ * String (Optional)
+ * ]
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ * }
+ * ]
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param collectionId STAC Collection Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchAssetsForTileWithResponse(String searchId, String tileMatrixSetId,
+ String collectionId, double z, double x, double y, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchAssetsForTileWithResponseAsync(searchId, tileMatrixSetId, collectionId, z, x,
+ y, requestOptions);
+ }
+
+ /**
+ * Searches TileJson Tilematrixsetid As Path
+ *
+ * Return TileJSON document for a search with TileMatrixSetId as path.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. tile_format String No Default will be automatically defined if the output image
+ * needs a mask (png) or
+ * not (jpeg). Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". tile_scale Integer No Tile scale factor affecting output size. Values > 1
+ * produce larger tiles (e.g., 1=256x256, 2=512x512). buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * tilejson: String (Optional)
+ * name: String (Optional)
+ * description: String (Optional)
+ * version: String (Optional)
+ * attribution: String (Optional)
+ * template: String (Optional)
+ * legend: String (Optional)
+ * scheme: String(xyz/tms) (Optional)
+ * tiles (Required): [
+ * String (Required)
+ * ]
+ * grids (Optional): [
+ * String (Optional)
+ * ]
+ * data (Optional): [
+ * String (Optional)
+ * ]
+ * minzoom: Integer (Optional)
+ * maxzoom: Integer (Optional)
+ * bounds (Optional): [
+ * double (Optional)
+ * ]
+ * center (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return tileJSON metadata describing a tile set according to the TileJSON specification
+ *
+ * Based on https://github.com/mapbox/tilejson-spec/tree/master/2.2.0 along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchTileJsonByTmsWithResponse(String searchId, String tileMatrixSetId,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getSearchTileJsonByTmsWithResponseAsync(searchId, tileMatrixSetId, requestOptions);
+ }
+
+ /**
+ * Searches Wmts Tilematrixsetid As Path
+ *
+ * OGC WMTS endpoint with TileMatrixSetId as path.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description tile_format String No Output image type. Default is png. Allowed values: "png",
+ * "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". tile_scale Integer No Tile scale factor affecting output size. Values > 1
+ * produce larger tiles (e.g., 1=256x256, 2=512x512). minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * byte[]
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represent a byte array along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchWmtsCapabilitiesByTmsWithResponse(String searchId,
+ String tileMatrixSetId, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchWmtsCapabilitiesByTmsWithResponseAsync(searchId, tileMatrixSetId,
+ requestOptions);
+ }
+
+ /**
+ * Searches Info
+ *
+ * Get Search query metadata.
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * search (Required): {
+ * hash: String (Required)
+ * search (Required): {
+ * String: BinaryData (Required)
+ * }
+ * lastused: OffsetDateTime (Required)
+ * usecount: int (Required)
+ * metadata (Required): {
+ * type: String(mosaic/search) (Optional)
+ * bounds: String (Optional)
+ * minzoom: Integer (Optional)
+ * maxzoom: Integer (Optional)
+ * name: String (Optional)
+ * assets (Optional): [
+ * String (Optional)
+ * ]
+ * defaults (Optional): {
+ * String: String (Required)
+ * }
+ * }
+ * }
+ * links (Optional): [
+ * (Optional){
+ * rel: String (Optional)
+ * title: String (Optional)
+ * type: String(image/tiff; application=geotiff/image/jp2/image/png/image/jpeg/image/jpg/image/webp/application/x-binary/application/xml/application/json/application/geo+json/text/html/text/plain/application/x-protobuf) (Optional)
+ * href: String (Optional, Required on create)
+ * hreflang: String (Optional)
+ * length: Integer (Optional)
+ * method: String(GET/POST) (Optional)
+ * headers (Optional): {
+ * String: String (Required)
+ * }
+ * body (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * merge: Boolean (Optional)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return information about a registered STAC search query along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchInfoWithResponse(String searchId, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchInfoWithResponseAsync(searchId, requestOptions);
+ }
+
+ /**
+ * Searches Bbox
+ *
+ * Create an image from part of a dataset (bounding box crop).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. dst_crs String No Output Coordinate Reference System. max_size Integer No Image output size limit if width and height limits are not
+ * set. height Integer No Height in pixels for the output image width Integer No Width in pixels for the output image color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param minx Bounding box min X.
+ * @param miny Bounding box min Y.
+ * @param maxx Bounding box max X.
+ * @param maxy Bounding box max Y.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchBboxCropWithResponse(String searchId, double minx, double miny,
+ double maxx, double maxy, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchBboxCropWithResponseAsync(searchId, minx, miny, maxx, maxy, format,
+ requestOptions);
+ }
+
+ /**
+ * Searches Bbox With Dimensions
+ *
+ * Create an image from part of a dataset (bounding box crop with dimensions).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. dst_crs String No Output Coordinate Reference System. max_size Integer No Image output size limit if width and height limits are not
+ * set. color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param minx Bounding box min X.
+ * @param miny Bounding box min Y.
+ * @param maxx Bounding box max X.
+ * @param maxy Bounding box max Y.
+ * @param width Force output image width.
+ * @param height Force output image height.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchBboxCropWithDimensionsWithResponse(String searchId, double minx,
+ double miny, double maxx, double maxy, int width, int height, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchBboxCropWithDimensionsWithResponseAsync(searchId, minx, miny, maxx, maxy,
+ width, height, format, requestOptions);
+ }
+
+ /**
+ * Searches Assets For Bbox
+ *
+ * Return a list of assets which overlap a given bounding box for a search.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * [
+ * BinaryData (Required)
+ * ]
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param minx Bounding box min X.
+ * @param miny Bounding box min Y.
+ * @param maxx Bounding box max X.
+ * @param maxy Bounding box max Y.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchBboxAssetsWithResponse(String searchId, double minx, double miny,
+ double maxx, double maxy, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchBboxAssetsWithResponseAsync(searchId, minx, miny, maxx, maxy,
+ requestOptions);
+ }
+
+ /**
+ * Searches Geojson Feature
+ *
+ * Create image from a geojson feature (without format in path).
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. max_size Integer No Image output size limit if width and height limits are not
+ * set. height Integer No Height in pixels for the output image width Integer No Width in pixels for the output image color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. dst_crs String No Output Coordinate Reference System. format String No Output image format. Allowed values: "png", "npy", "tif",
+ * "jpeg", "jpg", "jp2", "webp", "pngraw".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Request Body Schema
+ *
+ *
+ * {@code
+ * {
+ * geometry (Required): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * type: String(Feature) (Required)
+ * properties (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param body Request GeoJson body.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> cropSearchFeatureWithResponse(String searchId, BinaryData body,
+ RequestOptions requestOptions) {
+ return this.serviceClient.cropSearchFeatureWithResponseAsync(searchId, body, requestOptions);
+ }
+
+ /**
+ * Searches Geojson Feature Crop With Format
+ *
+ * Create image from a geojson feature with format.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. max_size Integer No Image output size limit if width and height limits are not
+ * set. height Integer No Height in pixels for the output image width Integer No Width in pixels for the output image color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. dst_crs String No Output Coordinate Reference System.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Request Body Schema
+ *
+ *
+ * {@code
+ * {
+ * geometry (Required): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * type: String(Feature) (Required)
+ * properties (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param body Request GeoJson body.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> cropSearchFeatureByFormatWithResponse(String searchId, String format,
+ BinaryData body, RequestOptions requestOptions) {
+ return this.serviceClient.cropSearchFeatureByFormatWithResponseAsync(searchId, format, body, requestOptions);
+ }
+
+ /**
+ * Searches Geojson Feature Crop With Dimensions
+ *
+ * Create image from a geojson feature with dimensions.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. max_size Integer No Image output size limit if width and height limits are not
+ * set. color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. dst_crs String No Output Coordinate Reference System.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Request Body Schema
+ *
+ *
+ * {@code
+ * {
+ * geometry (Required): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * type: String(Feature) (Required)
+ * properties (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param width Width in pixels for the output image.
+ * @param height Height in pixels for the output image.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param body Request GeoJson body.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> cropSearchFeatureWidthByHeightWithResponse(String searchId, int width, int height,
+ String format, BinaryData body, RequestOptions requestOptions) {
+ return this.serviceClient.cropSearchFeatureWidthByHeightWithResponseAsync(searchId, width, height, format, body,
+ requestOptions);
+ }
+
+ /**
+ * Searches Wmts
+ *
+ * OGC WMTS endpoint.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default:
+ * 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad", "LINZAntarticaMapTilegrid",
+ * "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad", "WGS1984Quad",
+ * "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". tile_format String No Output image type. Default is png. Allowed values: "png",
+ * "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". tile_scale Integer No Tile scale factor affecting output size. Values > 1
+ * produce larger tiles (e.g., 1=256x256, 2=512x512). minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * byte[]
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return represent a byte array along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchWmtsCapabilitiesWithResponse(String searchId,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getSearchWmtsCapabilitiesWithResponseAsync(searchId, requestOptions);
+ }
+
+ /**
+ * Searches TileJson
+ *
+ * Return TileJSON document for a search.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default: 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad",
+ * "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad",
+ * "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". tile_format String No Default will be automatically defined if the output image
+ * needs a mask (png) or
+ * not (jpeg). Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". tile_scale Integer No Tile scale factor affecting output size. Values > 1
+ * produce larger tiles (e.g., 1=256x256, 2=512x512). minzoom Integer No Overwrite default minzoom. maxzoom Integer No Overwrite default maxzoom. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`. buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * tilejson: String (Optional)
+ * name: String (Optional)
+ * description: String (Optional)
+ * version: String (Optional)
+ * attribution: String (Optional)
+ * template: String (Optional)
+ * legend: String (Optional)
+ * scheme: String(xyz/tms) (Optional)
+ * tiles (Required): [
+ * String (Required)
+ * ]
+ * grids (Optional): [
+ * String (Optional)
+ * ]
+ * data (Optional): [
+ * String (Optional)
+ * ]
+ * minzoom: Integer (Optional)
+ * maxzoom: Integer (Optional)
+ * bounds (Optional): [
+ * double (Optional)
+ * ]
+ * center (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return tileJSON metadata describing a tile set according to the TileJSON specification
+ *
+ * Based on https://github.com/mapbox/tilejson-spec/tree/master/2.2.0 along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchTileJsonWithResponse(String searchId, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchTileJsonWithResponseAsync(searchId, requestOptions);
+ }
+
+ /**
+ * Searches Tile Plain
+ *
+ * Create a map tile for a mosaic search.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default: 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad",
+ * "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad",
+ * "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". format String No Output format for the tile or image (e.g., png, jpeg, webp).
+ * Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". scale Integer No Numeric scale factor for the tile. Higher values produce larger
+ * tiles buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchTileNoTmsWithResponse(String searchId, double z, double x, double y,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getSearchTileNoTmsWithResponseAsync(searchId, z, x, y, requestOptions);
+ }
+
+ /**
+ * Searches Tile Format
+ *
+ * Create a map tile for a mosaic search with specified format.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default: 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad",
+ * "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad",
+ * "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". scale Integer No Numeric scale factor for the tile. Higher values produce larger
+ * tiles buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchTileNoTmsByFormatWithResponse(String searchId, double z, double x,
+ double y, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchTileNoTmsByFormatWithResponseAsync(searchId, z, x, y, format,
+ requestOptions);
+ }
+
+ /**
+ * Searches Tile Scale
+ *
+ * Create a map tile for a mosaic search with specified scale.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default: 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad",
+ * "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad",
+ * "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". format String No Output format for the tile or image (e.g., png, jpeg, webp).
+ * Allowed values: "png", "npy", "tif", "jpeg", "jpg", "jp2", "webp", "pngraw". buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchTileNoTmsByScaleWithResponse(String searchId, double z, double x,
+ double y, double scale, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchTileNoTmsByScaleWithResponseAsync(searchId, z, x, y, scale, requestOptions);
+ }
+
+ /**
+ * Searches Tile
+ *
+ * Create a map tile for a mosaic search with specified scale and format.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". algorithm String No Terrain algorithm name. Allowed values: "hillshade",
+ * "contours", "normalizedIndex", "terrarium", "terrainrgb", "slope", "cast", "ceil", "floor", "min", "max",
+ * "median", "mean", "std", "var". algorithm_params String No Terrain algorithm parameters TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default: 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad",
+ * "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad",
+ * "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad". buffer Double No Buffer on each side of the given tile. It must be a multiple of
+ * `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258). color_formula String No rio-color formula (info:
+ * https://github.com/mapbox/rio-color) collection String No STAC Collection ID resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms". pixel_selection String No Pixel selection method. Allowed values: "first",
+ * "highest", "lowest", "mean", "median", "stdev", "lastbandlow", "lastbandhigh", "count". rescale List<String> No comma (',') delimited Min,Max range. Can set
+ * multiple time for multiple bands. Call {@link RequestOptions#addQueryParam} to add string to array. colormap_name String No Colormap name. Allowed values: "accent", "accent_r",
+ * "afmhot", "afmhot_r", "ai4g-lulc", "alos-fnf", "alos-palsar-mask", "autumn", "autumn_r", "binary", "binary_r",
+ * "blues", "blues_r", "bone", "bone_r", "brbg", "brbg_r", "brg", "brg_r", "bugn", "bugn_r", "bupu", "bupu_r",
+ * "bwr", "bwr_r", "c-cap", "cfastie", "chesapeake-lc-13", "chesapeake-lc-7", "chesapeake-lu", "chloris-biomass",
+ * "cividis", "cividis_r", "cmrmap", "cmrmap_r", "cool", "cool_r", "coolwarm", "coolwarm_r", "copper", "copper_r",
+ * "cubehelix", "cubehelix_r", "dark2", "dark2_r", "drcog-lulc", "esa-cci-lc", "esa-worldcover", "flag", "flag_r",
+ * "gap-lulc", "gist_earth", "gist_earth_r", "gist_gray", "gist_gray_r", "gist_heat", "gist_heat_r", "gist_ncar",
+ * "gist_ncar_r", "gist_rainbow", "gist_rainbow_r", "gist_stern", "gist_stern_r", "gist_yarg", "gist_yarg_r",
+ * "gnbu", "gnbu_r", "gnuplot", "gnuplot2", "gnuplot2_r", "gnuplot_r", "gray", "gray_r", "greens", "greens_r",
+ * "greys", "greys_r", "hot", "hot_r", "hsv", "hsv_r", "inferno", "inferno_r", "io-bii", "io-lulc",
+ * "io-lulc-9-class", "jet", "jet_r", "jrc-change", "jrc-extent", "jrc-occurrence", "jrc-recurrence",
+ * "jrc-seasonality", "jrc-transitions", "lidar-classification", "lidar-hag", "lidar-hag-alternative",
+ * "lidar-intensity", "lidar-returns", "magma", "magma_r", "modis-10A1", "modis-10A2", "modis-13A1|Q1",
+ * "modis-14A1|A2", "modis-15A2H|A3H", "modis-16A3GF-ET", "modis-16A3GF-PET", "modis-17A2H|A2HGF", "modis-17A3HGF",
+ * "modis-64A1", "mtbs-severity", "nipy_spectral", "nipy_spectral_r", "nrcan-lulc", "ocean", "ocean_r", "oranges",
+ * "oranges_r", "orrd", "orrd_r", "paired", "paired_r", "pastel1", "pastel1_r", "pastel2", "pastel2_r", "pink",
+ * "pink_r", "piyg", "piyg_r", "plasma", "plasma_r", "prgn", "prgn_r", "prism", "prism_r", "pubu", "pubu_r",
+ * "pubugn", "pubugn_r", "puor", "puor_r", "purd", "purd_r", "purples", "purples_r", "qpe", "rainbow", "rainbow_r",
+ * "rdbu", "rdbu_r", "rdgy", "rdgy_r", "rdpu", "rdpu_r", "rdylbu", "rdylbu_r", "rdylgn", "rdylgn_r", "reds",
+ * "reds_r", "rplumbo", "schwarzwald", "seismic", "seismic_r", "set1", "set1_r", "set2", "set2_r", "set3", "set3_r",
+ * "spectral", "spectral_r", "spring", "spring_r", "summer", "summer_r", "tab10", "tab10_r", "tab20", "tab20_r",
+ * "tab20b", "tab20b_r", "tab20c", "tab20c_r", "terrain", "terrain_r", "twilight", "twilight_r", "twilight_shifted",
+ * "twilight_shifted_r", "usda-cdl", "usda-cdl-corn", "usda-cdl-cotton", "usda-cdl-soybeans", "usda-cdl-wheat",
+ * "usgs-lcmap", "viirs-10a1", "viirs-13a1", "viirs-14a1", "viirs-15a2H", "viridis", "viridis_r", "winter",
+ * "winter_r", "wistia", "wistia_r", "ylgn", "ylgn_r", "ylgnbu", "ylgnbu_r", "ylorbr", "ylorbr_r", "ylorrd",
+ * "ylorrd_r", "algae", "algae_r", "amp", "amp_r", "balance", "balance_r", "curl", "curl_r", "deep", "deep_r",
+ * "delta", "delta_r", "dense", "dense_r", "diff", "diff_r", "haline", "haline_r", "ice", "ice_r", "matter",
+ * "matter_r", "oxy", "oxy_r", "phase", "phase_r", "rain", "rain_r", "solar", "solar_r", "speed", "speed_r", "tarn",
+ * "tarn_r", "tempo", "tempo_r", "thermal", "thermal_r", "topo", "topo_r", "turbid", "turbid_r", "turbo",
+ * "turbo_r". colormap String No JSON encoded custom Colormap return_mask Boolean No Add mask to the output data. padding Integer No Padding to apply to each tile edge. Helps reduce resampling
+ * artefacts along edges. Defaults to `0`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchTileNoTmsByScaleAndFormatWithResponse(String searchId, double z,
+ double x, double y, double scale, String format, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchTileNoTmsByScaleAndFormatWithResponseAsync(searchId, z, x, y, scale, format,
+ requestOptions);
+ }
+
+ /**
+ * Searches Assets For Tile
+ *
+ * Return a list of assets which overlap a given tile for a mosaic search.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". TileMatrixSetId String No Identifier selecting one of the TileMatrixSetId
+ * supported (default: 'WebMercatorQuad'). Allowed values: "CanadianNAD83_LCC", "EuropeanETRS89_LAEAQuad",
+ * "LINZAntarticaMapTilegrid", "NZTM2000Quad", "UPSAntarcticWGS84Quad", "UPSArcticWGS84Quad", "UTM31WGS84Quad",
+ * "WGS1984Quad", "WebMercatorQuad", "WorldCRS84Quad", "WorldMercatorWGS84Quad".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * [
+ * BinaryData (Required)
+ * ]
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchAssetsForTileNoTmsWithResponse(String searchId, double z, double x,
+ double y, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchAssetsForTileNoTmsWithResponseAsync(searchId, z, x, y, requestOptions);
+ }
+
+ /**
+ * Searches Point
+ *
+ * Get Point value for a search dataset.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". bidx List<Integer> No Dataset band indexes. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. assets List<String> No Asset's names. Call
+ * {@link RequestOptions#addQueryParam} to add string to array. expression String No Band math expression between assets asset_bidx List<String> No Per asset band indexes (coma separated indexes,
+ * e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image"). In the form of "," separated
+ * string. asset_as_band Boolean No Asset as Band nodata String No Overwrite internal Nodata value unscale Boolean No Apply internal Scale or Offset reproject String No WarpKernel resampling algorithm (only used when doing
+ * re-projection). Defaults to `nearest`. Allowed values: "nearest", "bilinear", "cubic", "cubic_spline", "lanczos",
+ * "average", "mode", "max", "min", "med", "q1", "q3", "sum", "rms". coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`. resampling String No Resampling method. Allowed values: "nearest", "bilinear",
+ * "cubic", "cubic_spline", "lanczos", "average", "mode", "gauss", "rms".
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * {
+ * coordinates (Required): [
+ * double (Required)
+ * ]
+ * values (Required): [
+ * double (Required)
+ * ]
+ * band_names (Required): [
+ * String (Required)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param longitude Longitude.
+ * @param latitude Latitude.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return response model for point query operations providing values at a specific location along with
+ * {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchPointWithResponse(String searchId, double longitude, double latitude,
+ RequestOptions requestOptions) {
+ return this.serviceClient.getSearchPointWithResponseAsync(searchId, longitude, latitude, requestOptions);
+ }
+
+ /**
+ * Searches Point Assets
+ *
+ * Return a list of assets for a given point in a search.
+ * Query Parameters
+ *
+ * Query Parameters
+ * Name Type Required Description scan_limit Integer No Return as soon as we scan N items (defaults to
+ * 10000). items_limit Integer No Return as soon as we have N items per geometry (defaults
+ * to 100). time_limit Integer No Return after N seconds to avoid long requests (defaults to
+ * 5). exitwhenfull Boolean No Return as soon as the geometry is fully covered (defaults
+ * to True). skipcovered Boolean No Skip any items that would show up completely under the
+ * previous items (defaults
+ * to True). subdataset_name String No The name of a subdataset within the asset. subdataset_bands List<Integer> No The index of a subdataset band within the
+ * asset. In the form of "," separated string. crs String No Coordinate Reference System. datetime String No Either a date-time or an interval, open or closed. Date and
+ * time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties. sel List<String> No Xarray Indexing using dimension names
+ * `{dimension}={value}`. Call {@link RequestOptions#addQueryParam} to add string to array. sel_method String No Xarray indexing method to use for inexact matches. Allowed
+ * values: "nearest", "linear", "bilinear", "cubic", "cubic_spline", "lanczos", "area", "mode". coord_crs String No Coordinate Reference System of the input coords. Default to
+ * `epsg:4326`.
+ * You can add these to a request with {@link RequestOptions#addQueryParam}
+ * Response Body Schema
+ *
+ *
+ * {@code
+ * [
+ * (Required){
+ * id: String (Required)
+ * bbox (Required): [
+ * double (Required)
+ * ]
+ * assets (Required): {
+ * String (Required): {
+ * platform: String (Optional)
+ * instruments (Optional): [
+ * String (Optional)
+ * ]
+ * constellation: String (Optional)
+ * mission: String (Optional)
+ * providers (Optional): [
+ * (Optional){
+ * name: String (Optional, Required on create)
+ * description: String (Optional)
+ * roles (Optional): [
+ * String (Optional)
+ * ]
+ * url: String (Optional)
+ * }
+ * ]
+ * gsd: Double (Optional)
+ * created: OffsetDateTime (Optional)
+ * updated: OffsetDateTime (Optional)
+ * title: String (Optional)
+ * description: String (Optional)
+ * href: String (Optional, Required on create)
+ * type: String (Optional)
+ * roles (Optional): [
+ * String (Optional)
+ * ]
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ * collection: String (Required)
+ * }
+ * ]
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param longitude Longitude.
+ * @param latitude Latitude.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getSearchPointWithAssetsWithResponse(String searchId, double longitude,
+ double latitude, RequestOptions requestOptions) {
+ return this.serviceClient.getSearchPointWithAssetsWithResponseAsync(searchId, longitude, latitude,
+ requestOptions);
+ }
+
+ /**
+ * Matrix Definition
+ *
+ * Return Matrix Definition.
+ *
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/tileMatrixSet.json
+ *
+ * A definition of a tile matrix set following the Tile Matrix Set standard.
* For tileset metadata, such a description (in `tileMatrixSet` property) is only
* required for offline use,
* as an alternative to a link with a
@@ -2650,18 +10387,11834 @@ public Mono> getMosaicsWmtsCapabilitiesWithResponse(String
*/
@Generated
@ServiceMethod(returns = ReturnType.SINGLE)
- public Mono getTileMatrixDefinitions(String tileMatrixSetId) {
- // Generated convenience method for getTileMatrixDefinitionsWithResponse
+ public Mono getTileMatrixDefinitions(String tileMatrixSetId) {
+ // Generated convenience method for getTileMatrixDefinitionsWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getTileMatrixDefinitionsWithResponse(tileMatrixSetId, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TileMatrixSet.class));
+ }
+
+ /**
+ * Matrix List
+ *
+ * Return Matrix List.
+ *
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getTileMatrices() {
+ // Generated convenience method for getTileMatricesWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getTileMatricesWithResponse(requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TYPE_REFERENCE_LIST_STRING));
+ }
+
+ /**
+ * Get ClassMap Legend
+ *
+ * Generate values and color swatches mapping for a given classmap.
+ *
+ * @param classmapName classmap name.
+ * @param trimStart Number of items to trim from the start of the cmap.
+ * @param trimEnd Number of items to trim from the end of the cmap.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return classMap Legend
+ *
+ * Generate values and color swatches mapping for a given classmap on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getClassMapLegend(String classmapName, Integer trimStart, Integer trimEnd) {
+ // Generated convenience method for getClassMapLegendWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (trimStart != null) {
+ requestOptions.addQueryParam("trim_start", String.valueOf(trimStart), false);
+ }
+ if (trimEnd != null) {
+ requestOptions.addQueryParam("trim_end", String.valueOf(trimEnd), false);
+ }
+ return getClassMapLegendWithResponse(classmapName, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(ClassMapLegendResponse.class));
+ }
+
+ /**
+ * Get ClassMap Legend
+ *
+ * Generate values and color swatches mapping for a given classmap.
+ *
+ * @param classmapName classmap name.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return classMap Legend
+ *
+ * Generate values and color swatches mapping for a given classmap on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getClassMapLegend(String classmapName) {
+ // Generated convenience method for getClassMapLegendWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getClassMapLegendWithResponse(classmapName, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(ClassMapLegendResponse.class));
+ }
+
+ /**
+ * Get Interval Legend
+ *
+ * Generate values and color swatches mapping for a given interval classmap.
+ *
+ * Returns a color map for intervals, where each interval is defined by
+ * a numeric range [min, max] representing the interval boundaries and
+ * an RGBA color [red, green, blue, alpha] associated with the interval.
+ *
+ * The response is a 2D array of interval definitions, where each element is a pair:
+ * the first element is an array of two numbers [min, max] defining the interval,
+ * and the second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color.
+ *
+ * Example: [[ [-2, 0], [0, 0, 0, 0] ], [ [1, 32], [255, 255, 178, 255] ]].
+ * This defines two intervals: [-2, 0] mapped to transparent black and [1, 32] mapped to opaque yellow.
+ *
+ * @param classmapName classmap name.
+ * @param trimStart Number of items to trim from the start of the cmap.
+ * @param trimEnd Number of items to trim from the end of the cmap.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return interval Legend
+ *
+ * Generate values and color swatches mapping for a given interval classmap.
+ *
+ * Returns a color map for intervals, where each interval is defined by
+ * a numeric range [min, max] representing the interval boundaries and
+ * an RGBA color [red, green, blue, alpha] associated with the interval.
+ *
+ * The response is a 2D array of interval definitions, where each element is a pair:
+ * the first element is an array of two numbers [min, max] defining the interval,
+ * and the second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color.
+ *
+ * Example: [[ [-2, 0], [0, 0, 0, 0] ], [ [1, 32], [255, 255, 178, 255] ]].
+ * This defines two intervals: [-2, 0] mapped to transparent black and [1, 32] mapped to opaque yellow on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono>>> getIntervalLegend(String classmapName, Integer trimStart, Integer trimEnd) {
+ // Generated convenience method for getIntervalLegendWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (trimStart != null) {
+ requestOptions.addQueryParam("trim_start", String.valueOf(trimStart), false);
+ }
+ if (trimEnd != null) {
+ requestOptions.addQueryParam("trim_end", String.valueOf(trimEnd), false);
+ }
+ return getIntervalLegendWithResponse(classmapName, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TYPE_REFERENCE_LIST_LIST_LIST_LONG));
+ }
+
+ /**
+ * Get Interval Legend
+ *
+ * Generate values and color swatches mapping for a given interval classmap.
+ *
+ * Returns a color map for intervals, where each interval is defined by
+ * a numeric range [min, max] representing the interval boundaries and
+ * an RGBA color [red, green, blue, alpha] associated with the interval.
+ *
+ * The response is a 2D array of interval definitions, where each element is a pair:
+ * the first element is an array of two numbers [min, max] defining the interval,
+ * and the second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color.
+ *
+ * Example: [[ [-2, 0], [0, 0, 0, 0] ], [ [1, 32], [255, 255, 178, 255] ]].
+ * This defines two intervals: [-2, 0] mapped to transparent black and [1, 32] mapped to opaque yellow.
+ *
+ * @param classmapName classmap name.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return interval Legend
+ *
+ * Generate values and color swatches mapping for a given interval classmap.
+ *
+ * Returns a color map for intervals, where each interval is defined by
+ * a numeric range [min, max] representing the interval boundaries and
+ * an RGBA color [red, green, blue, alpha] associated with the interval.
+ *
+ * The response is a 2D array of interval definitions, where each element is a pair:
+ * the first element is an array of two numbers [min, max] defining the interval,
+ * and the second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color.
+ *
+ * Example: [[ [-2, 0], [0, 0, 0, 0] ], [ [1, 32], [255, 255, 178, 255] ]].
+ * This defines two intervals: [-2, 0] mapped to transparent black and [1, 32] mapped to opaque yellow on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono>>> getIntervalLegend(String classmapName) {
+ // Generated convenience method for getIntervalLegendWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getIntervalLegendWithResponse(classmapName, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TYPE_REFERENCE_LIST_LIST_LIST_LONG));
+ }
+
+ /**
+ * Get Legend
+ *
+ * Generate a legend image for a given colormap.
+ *
+ * If the colormap has non-contiguous values at the beginning or end,
+ * which aren't desired in the output image, they can be trimmed by specifying
+ * the number of values to trim.
+ *
+ * @param colorMapName The name of the registered colormap to generate a legend for.
+ * @param height The output height of the legend image.
+ * @param width The output width of the legend image.
+ * @param trimStart Number of items to trim from the start of the cmap.
+ * @param trimEnd Number of items to trim from the end of the cmap.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return legend
+ *
+ * Generate a legend image for a given colormap.
+ *
+ * If the colormap has non-contiguous values at the beginning or end,
+ * which aren't desired in the output image, they can be trimmed by specifying
+ * the number of values to trim on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getLegend(String colorMapName, Double height, Double width, Integer trimStart,
+ Integer trimEnd) {
+ // Generated convenience method for getLegendWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (height != null) {
+ requestOptions.addQueryParam("height", String.valueOf(height), false);
+ }
+ if (width != null) {
+ requestOptions.addQueryParam("width", String.valueOf(width), false);
+ }
+ if (trimStart != null) {
+ requestOptions.addQueryParam("trim_start", String.valueOf(trimStart), false);
+ }
+ if (trimEnd != null) {
+ requestOptions.addQueryParam("trim_end", String.valueOf(trimEnd), false);
+ }
+ return getLegendWithResponse(colorMapName, requestOptions).flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Get Legend
+ *
+ * Generate a legend image for a given colormap.
+ *
+ * If the colormap has non-contiguous values at the beginning or end,
+ * which aren't desired in the output image, they can be trimmed by specifying
+ * the number of values to trim.
+ *
+ * @param colorMapName The name of the registered colormap to generate a legend for.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return legend
+ *
+ * Generate a legend image for a given colormap.
+ *
+ * If the colormap has non-contiguous values at the beginning or end,
+ * which aren't desired in the output image, they can be trimmed by specifying
+ * the number of values to trim on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getLegend(String colorMapName) {
+ // Generated convenience method for getLegendWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getLegendWithResponse(colorMapName, requestOptions).flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Register Search
+ *
+ * Register a Search query.
+ *
+ * @param options Options for registerMosaicsSearch API.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return response from a successful mosaic registration with search ID and related links on successful completion
+ * of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono registerMosaicsSearch(RegisterMosaicsSearchOptions options) {
+ // Generated convenience method for registerMosaicsSearchWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ RegisterMosaicsSearchRequest registerMosaicsSearchRequestObj
+ = new RegisterMosaicsSearchRequest().setCollections(options.getCollections())
+ .setIds(options.getIds())
+ .setBoundingBox(options.getBoundingBox())
+ .setIntersects(options.getIntersects())
+ .setQuery(options.getQuery())
+ .setFilter(options.getFilter())
+ .setDatetime(options.getDatetime())
+ .setSortBy(options.getSortBy())
+ .setFilterLanguage(options.getFilterLanguage())
+ .setMetadata(options.getMetadata());
+ BinaryData registerMosaicsSearchRequest = BinaryData.fromObject(registerMosaicsSearchRequestObj);
+ return registerMosaicsSearchWithResponse(registerMosaicsSearchRequest, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TilerMosaicSearchRegistrationResponse.class));
+ }
+
+ /**
+ * Tileset List
+ *
+ * Return a list of available tilesets for a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return response containing a list of available tilesets on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTilesets(String collectionId, String itemId, String subdatasetName,
+ List subdatasetBands, String crs, String datetime, List sel, SelMethod selMethod) {
+ // Generated convenience method for getTilesetsWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ return getTilesetsWithResponse(collectionId, itemId, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TileSetList.class));
+ }
+
+ /**
+ * Tileset List
+ *
+ * Return a list of available tilesets for a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return response containing a list of available tilesets on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTilesets(String collectionId, String itemId) {
+ // Generated convenience method for getTilesetsWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getTilesetsWithResponse(collectionId, itemId, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TileSetList.class));
+ }
+
+ /**
+ * Tileset Metadata
+ *
+ * Return metadata for a specific tileset of a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return detailed metadata about a specific tileset, including tile matrix set limits on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTilesetMetadata(String collectionId, String itemId, String tileMatrixSetId,
+ String subdatasetName, List subdatasetBands, String crs, String datetime, List sel,
+ SelMethod selMethod) {
+ // Generated convenience method for getTilesetMetadataWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ return getTilesetMetadataWithResponse(collectionId, itemId, tileMatrixSetId, requestOptions)
+ .flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TileSetMetadata.class));
+ }
+
+ /**
+ * Tileset Metadata
+ *
+ * Return metadata for a specific tileset of a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return detailed metadata about a specific tileset, including tile matrix set limits on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTilesetMetadata(String collectionId, String itemId, String tileMatrixSetId) {
+ // Generated convenience method for getTilesetMetadataWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getTilesetMetadataWithResponse(collectionId, itemId, tileMatrixSetId, requestOptions)
+ .flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TileSetMetadata.class));
+ }
+
+ /**
+ * Tile Tilematrixsetid Plain
+ *
+ * Create map tile from a dataset (without scale or format in path).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param bidx Dataset band indexes.
+ * @param assets Asset's names.
+ * @param expression Band math expression between assets.
+ * @param assetBandIndices Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1,
+ * 2, and 3 from the asset named "image").
+ * @param assetAsBand Asset as Band.
+ * @param noData Overwrite internal Nodata value.
+ * @param unscale Apply internal Scale or Offset.
+ * @param reproject WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.
+ * @param algorithm Terrain algorithm name.
+ * @param algorithmParams Terrain algorithm parameters.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param buffer Buffer on each side of the given tile. It must be a multiple of `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258).
+ * @param colorFormula rio-color formula (info: https://github.com/mapbox/rio-color).
+ * @param resampling Resampling method.
+ * @param rescale comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
+ * @param colorMapName Colormap name.
+ * @param colorMap JSON encoded custom Colormap.
+ * @param returnMask Add mask to the output data.
+ * @param padding Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to
+ * `0`.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTile(String collectionId, String itemId, String tileMatrixSetId, double z, double x,
+ double y, List bidx, List assets, String expression, List assetBandIndices,
+ Boolean assetAsBand, String noData, Boolean unscale, WarpKernelResampling reproject, TerrainAlgorithm algorithm,
+ String algorithmParams, TilerImageFormat format, Integer scale, Double buffer, String colorFormula,
+ Resampling resampling, List rescale, ColorMapNames colorMapName, String colorMap, Boolean returnMask,
+ Integer padding, String subdatasetName, List subdatasetBands, String crs, String datetime,
+ List sel, SelMethod selMethod) {
+ // Generated convenience method for getTileWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (bidx != null) {
+ for (int paramItemValue : bidx) {
+ requestOptions.addQueryParam("bidx", String.valueOf(paramItemValue), false);
+ }
+ }
+ if (assets != null) {
+ for (String paramItemValue : assets) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("assets", paramItemValue, false);
+ }
+ }
+ }
+ if (expression != null) {
+ requestOptions.addQueryParam("expression", expression, false);
+ }
+ if (assetBandIndices != null) {
+ requestOptions.addQueryParam("asset_bidx",
+ assetBandIndices.stream()
+ .map(paramItemValue -> Objects.toString(paramItemValue, ""))
+ .collect(Collectors.joining(",")),
+ false);
+ }
+ if (assetAsBand != null) {
+ requestOptions.addQueryParam("asset_as_band", String.valueOf(assetAsBand), false);
+ }
+ if (noData != null) {
+ requestOptions.addQueryParam("nodata", noData, false);
+ }
+ if (unscale != null) {
+ requestOptions.addQueryParam("unscale", String.valueOf(unscale), false);
+ }
+ if (reproject != null) {
+ requestOptions.addQueryParam("reproject", reproject.toString(), false);
+ }
+ if (algorithm != null) {
+ requestOptions.addQueryParam("algorithm", algorithm.toString(), false);
+ }
+ if (algorithmParams != null) {
+ requestOptions.addQueryParam("algorithm_params", algorithmParams, false);
+ }
+ if (format != null) {
+ requestOptions.addQueryParam("format", format.toString(), false);
+ }
+ if (scale != null) {
+ requestOptions.addQueryParam("scale", String.valueOf(scale), false);
+ }
+ if (buffer != null) {
+ requestOptions.addQueryParam("buffer", String.valueOf(buffer), false);
+ }
+ if (colorFormula != null) {
+ requestOptions.addQueryParam("color_formula", colorFormula, false);
+ }
+ if (resampling != null) {
+ requestOptions.addQueryParam("resampling", resampling.toString(), false);
+ }
+ if (rescale != null) {
+ for (String paramItemValue : rescale) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("rescale", paramItemValue, false);
+ }
+ }
+ }
+ if (colorMapName != null) {
+ requestOptions.addQueryParam("colormap_name", colorMapName.toString(), false);
+ }
+ if (colorMap != null) {
+ requestOptions.addQueryParam("colormap", colorMap, false);
+ }
+ if (returnMask != null) {
+ requestOptions.addQueryParam("return_mask", String.valueOf(returnMask), false);
+ }
+ if (padding != null) {
+ requestOptions.addQueryParam("padding", String.valueOf(padding), false);
+ }
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ return getTileWithResponse(collectionId, itemId, tileMatrixSetId, z, x, y, requestOptions)
+ .flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile Tilematrixsetid Plain
+ *
+ * Create map tile from a dataset (without scale or format in path).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTile(String collectionId, String itemId, String tileMatrixSetId, double z, double x,
+ double y) {
+ // Generated convenience method for getTileWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getTileWithResponse(collectionId, itemId, tileMatrixSetId, z, x, y, requestOptions)
+ .flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile Tilematrixsetid Format
+ *
+ * Create map tile from a dataset (with format in path, without scale).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param bidx Dataset band indexes.
+ * @param assets Asset's names.
+ * @param expression Band math expression between assets.
+ * @param assetBandIndices Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1,
+ * 2, and 3 from the asset named "image").
+ * @param assetAsBand Asset as Band.
+ * @param noData Overwrite internal Nodata value.
+ * @param unscale Apply internal Scale or Offset.
+ * @param reproject WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.
+ * @param algorithm Terrain algorithm name.
+ * @param algorithmParams Terrain algorithm parameters.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param buffer Buffer on each side of the given tile. It must be a multiple of `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258).
+ * @param colorFormula rio-color formula (info: https://github.com/mapbox/rio-color).
+ * @param resampling Resampling method.
+ * @param rescale comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
+ * @param colorMapName Colormap name.
+ * @param colorMap JSON encoded custom Colormap.
+ * @param returnMask Add mask to the output data.
+ * @param padding Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to
+ * `0`.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTileByFormat(String collectionId, String itemId, String tileMatrixSetId, double z,
+ double x, double y, String format, List bidx, List assets, String expression,
+ List assetBandIndices, Boolean assetAsBand, String noData, Boolean unscale,
+ WarpKernelResampling reproject, TerrainAlgorithm algorithm, String algorithmParams, Integer scale,
+ Double buffer, String colorFormula, Resampling resampling, List rescale, ColorMapNames colorMapName,
+ String colorMap, Boolean returnMask, Integer padding, String subdatasetName, List subdatasetBands,
+ String crs, String datetime, List sel, SelMethod selMethod) {
+ // Generated convenience method for getTileByFormatWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (bidx != null) {
+ for (int paramItemValue : bidx) {
+ requestOptions.addQueryParam("bidx", String.valueOf(paramItemValue), false);
+ }
+ }
+ if (assets != null) {
+ for (String paramItemValue : assets) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("assets", paramItemValue, false);
+ }
+ }
+ }
+ if (expression != null) {
+ requestOptions.addQueryParam("expression", expression, false);
+ }
+ if (assetBandIndices != null) {
+ requestOptions.addQueryParam("asset_bidx",
+ assetBandIndices.stream()
+ .map(paramItemValue -> Objects.toString(paramItemValue, ""))
+ .collect(Collectors.joining(",")),
+ false);
+ }
+ if (assetAsBand != null) {
+ requestOptions.addQueryParam("asset_as_band", String.valueOf(assetAsBand), false);
+ }
+ if (noData != null) {
+ requestOptions.addQueryParam("nodata", noData, false);
+ }
+ if (unscale != null) {
+ requestOptions.addQueryParam("unscale", String.valueOf(unscale), false);
+ }
+ if (reproject != null) {
+ requestOptions.addQueryParam("reproject", reproject.toString(), false);
+ }
+ if (algorithm != null) {
+ requestOptions.addQueryParam("algorithm", algorithm.toString(), false);
+ }
+ if (algorithmParams != null) {
+ requestOptions.addQueryParam("algorithm_params", algorithmParams, false);
+ }
+ if (scale != null) {
+ requestOptions.addQueryParam("scale", String.valueOf(scale), false);
+ }
+ if (buffer != null) {
+ requestOptions.addQueryParam("buffer", String.valueOf(buffer), false);
+ }
+ if (colorFormula != null) {
+ requestOptions.addQueryParam("color_formula", colorFormula, false);
+ }
+ if (resampling != null) {
+ requestOptions.addQueryParam("resampling", resampling.toString(), false);
+ }
+ if (rescale != null) {
+ for (String paramItemValue : rescale) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("rescale", paramItemValue, false);
+ }
+ }
+ }
+ if (colorMapName != null) {
+ requestOptions.addQueryParam("colormap_name", colorMapName.toString(), false);
+ }
+ if (colorMap != null) {
+ requestOptions.addQueryParam("colormap", colorMap, false);
+ }
+ if (returnMask != null) {
+ requestOptions.addQueryParam("return_mask", String.valueOf(returnMask), false);
+ }
+ if (padding != null) {
+ requestOptions.addQueryParam("padding", String.valueOf(padding), false);
+ }
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ return getTileByFormatWithResponse(collectionId, itemId, tileMatrixSetId, z, x, y, format, requestOptions)
+ .flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile Tilematrixsetid Format
+ *
+ * Create map tile from a dataset (with format in path, without scale).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTileByFormat(String collectionId, String itemId, String tileMatrixSetId, double z,
+ double x, double y, String format) {
+ // Generated convenience method for getTileByFormatWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getTileByFormatWithResponse(collectionId, itemId, tileMatrixSetId, z, x, y, format, requestOptions)
+ .flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile Tilematrixsetid Scale
+ *
+ * Create map tile from a dataset (with scale in path, without format).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param bidx Dataset band indexes.
+ * @param assets Asset's names.
+ * @param expression Band math expression between assets.
+ * @param assetBandIndices Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1,
+ * 2, and 3 from the asset named "image").
+ * @param assetAsBand Asset as Band.
+ * @param noData Overwrite internal Nodata value.
+ * @param unscale Apply internal Scale or Offset.
+ * @param reproject WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.
+ * @param algorithm Terrain algorithm name.
+ * @param algorithmParams Terrain algorithm parameters.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param buffer Buffer on each side of the given tile. It must be a multiple of `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258).
+ * @param colorFormula rio-color formula (info: https://github.com/mapbox/rio-color).
+ * @param resampling Resampling method.
+ * @param rescale comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
+ * @param colorMapName Colormap name.
+ * @param colorMap JSON encoded custom Colormap.
+ * @param returnMask Add mask to the output data.
+ * @param padding Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to
+ * `0`.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTileByScale(String collectionId, String itemId, String tileMatrixSetId, double z,
+ double x, double y, double scale, List bidx, List assets, String expression,
+ List assetBandIndices, Boolean assetAsBand, String noData, Boolean unscale,
+ WarpKernelResampling reproject, TerrainAlgorithm algorithm, String algorithmParams, TilerImageFormat format,
+ Double buffer, String colorFormula, Resampling resampling, List rescale, ColorMapNames colorMapName,
+ String colorMap, Boolean returnMask, Integer padding, String subdatasetName, List subdatasetBands,
+ String crs, String datetime, List sel, SelMethod selMethod) {
+ // Generated convenience method for getTileByScaleWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (bidx != null) {
+ for (int paramItemValue : bidx) {
+ requestOptions.addQueryParam("bidx", String.valueOf(paramItemValue), false);
+ }
+ }
+ if (assets != null) {
+ for (String paramItemValue : assets) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("assets", paramItemValue, false);
+ }
+ }
+ }
+ if (expression != null) {
+ requestOptions.addQueryParam("expression", expression, false);
+ }
+ if (assetBandIndices != null) {
+ requestOptions.addQueryParam("asset_bidx",
+ assetBandIndices.stream()
+ .map(paramItemValue -> Objects.toString(paramItemValue, ""))
+ .collect(Collectors.joining(",")),
+ false);
+ }
+ if (assetAsBand != null) {
+ requestOptions.addQueryParam("asset_as_band", String.valueOf(assetAsBand), false);
+ }
+ if (noData != null) {
+ requestOptions.addQueryParam("nodata", noData, false);
+ }
+ if (unscale != null) {
+ requestOptions.addQueryParam("unscale", String.valueOf(unscale), false);
+ }
+ if (reproject != null) {
+ requestOptions.addQueryParam("reproject", reproject.toString(), false);
+ }
+ if (algorithm != null) {
+ requestOptions.addQueryParam("algorithm", algorithm.toString(), false);
+ }
+ if (algorithmParams != null) {
+ requestOptions.addQueryParam("algorithm_params", algorithmParams, false);
+ }
+ if (format != null) {
+ requestOptions.addQueryParam("format", format.toString(), false);
+ }
+ if (buffer != null) {
+ requestOptions.addQueryParam("buffer", String.valueOf(buffer), false);
+ }
+ if (colorFormula != null) {
+ requestOptions.addQueryParam("color_formula", colorFormula, false);
+ }
+ if (resampling != null) {
+ requestOptions.addQueryParam("resampling", resampling.toString(), false);
+ }
+ if (rescale != null) {
+ for (String paramItemValue : rescale) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("rescale", paramItemValue, false);
+ }
+ }
+ }
+ if (colorMapName != null) {
+ requestOptions.addQueryParam("colormap_name", colorMapName.toString(), false);
+ }
+ if (colorMap != null) {
+ requestOptions.addQueryParam("colormap", colorMap, false);
+ }
+ if (returnMask != null) {
+ requestOptions.addQueryParam("return_mask", String.valueOf(returnMask), false);
+ }
+ if (padding != null) {
+ requestOptions.addQueryParam("padding", String.valueOf(padding), false);
+ }
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ return getTileByScaleWithResponse(collectionId, itemId, tileMatrixSetId, z, x, y, scale, requestOptions)
+ .flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile Tilematrixsetid Scale
+ *
+ * Create map tile from a dataset (with scale in path, without format).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTileByScale(String collectionId, String itemId, String tileMatrixSetId, double z,
+ double x, double y, double scale) {
+ // Generated convenience method for getTileByScaleWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getTileByScaleWithResponse(collectionId, itemId, tileMatrixSetId, z, x, y, scale, requestOptions)
+ .flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile Tilematrixsetid
+ *
+ * Create map tile from a dataset (with TileMatrixSetId, scale, and format in path).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param bidx Dataset band indexes.
+ * @param assets Asset's names.
+ * @param expression Band math expression between assets.
+ * @param assetBandIndices Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1,
+ * 2, and 3 from the asset named "image").
+ * @param assetAsBand Asset as Band.
+ * @param noData Overwrite internal Nodata value.
+ * @param unscale Apply internal Scale or Offset.
+ * @param reproject WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.
+ * @param algorithm Terrain algorithm name.
+ * @param algorithmParams Terrain algorithm parameters.
+ * @param buffer Buffer on each side of the given tile. It must be a multiple of `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258).
+ * @param colorFormula rio-color formula (info: https://github.com/mapbox/rio-color).
+ * @param resampling Resampling method.
+ * @param rescale comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
+ * @param colorMapName Colormap name.
+ * @param colorMap JSON encoded custom Colormap.
+ * @param returnMask Add mask to the output data.
+ * @param padding Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to
+ * `0`.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTileByScaleAndFormat(String collectionId, String itemId, String tileMatrixSetId,
+ double z, double x, double y, double scale, String format, List bidx, List assets,
+ String expression, List assetBandIndices, Boolean assetAsBand, String noData, Boolean unscale,
+ WarpKernelResampling reproject, TerrainAlgorithm algorithm, String algorithmParams, Double buffer,
+ String colorFormula, Resampling resampling, List rescale, ColorMapNames colorMapName, String colorMap,
+ Boolean returnMask, Integer padding, String subdatasetName, List subdatasetBands, String crs,
+ String datetime, List sel, SelMethod selMethod) {
+ // Generated convenience method for getTileByScaleAndFormatWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (bidx != null) {
+ for (int paramItemValue : bidx) {
+ requestOptions.addQueryParam("bidx", String.valueOf(paramItemValue), false);
+ }
+ }
+ if (assets != null) {
+ for (String paramItemValue : assets) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("assets", paramItemValue, false);
+ }
+ }
+ }
+ if (expression != null) {
+ requestOptions.addQueryParam("expression", expression, false);
+ }
+ if (assetBandIndices != null) {
+ requestOptions.addQueryParam("asset_bidx",
+ assetBandIndices.stream()
+ .map(paramItemValue -> Objects.toString(paramItemValue, ""))
+ .collect(Collectors.joining(",")),
+ false);
+ }
+ if (assetAsBand != null) {
+ requestOptions.addQueryParam("asset_as_band", String.valueOf(assetAsBand), false);
+ }
+ if (noData != null) {
+ requestOptions.addQueryParam("nodata", noData, false);
+ }
+ if (unscale != null) {
+ requestOptions.addQueryParam("unscale", String.valueOf(unscale), false);
+ }
+ if (reproject != null) {
+ requestOptions.addQueryParam("reproject", reproject.toString(), false);
+ }
+ if (algorithm != null) {
+ requestOptions.addQueryParam("algorithm", algorithm.toString(), false);
+ }
+ if (algorithmParams != null) {
+ requestOptions.addQueryParam("algorithm_params", algorithmParams, false);
+ }
+ if (buffer != null) {
+ requestOptions.addQueryParam("buffer", String.valueOf(buffer), false);
+ }
+ if (colorFormula != null) {
+ requestOptions.addQueryParam("color_formula", colorFormula, false);
+ }
+ if (resampling != null) {
+ requestOptions.addQueryParam("resampling", resampling.toString(), false);
+ }
+ if (rescale != null) {
+ for (String paramItemValue : rescale) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("rescale", paramItemValue, false);
+ }
+ }
+ }
+ if (colorMapName != null) {
+ requestOptions.addQueryParam("colormap_name", colorMapName.toString(), false);
+ }
+ if (colorMap != null) {
+ requestOptions.addQueryParam("colormap", colorMap, false);
+ }
+ if (returnMask != null) {
+ requestOptions.addQueryParam("return_mask", String.valueOf(returnMask), false);
+ }
+ if (padding != null) {
+ requestOptions.addQueryParam("padding", String.valueOf(padding), false);
+ }
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ return getTileByScaleAndFormatWithResponse(collectionId, itemId, tileMatrixSetId, z, x, y, scale, format,
+ requestOptions).flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile Tilematrixsetid
+ *
+ * Create map tile from a dataset (with TileMatrixSetId, scale, and format in path).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTileByScaleAndFormat(String collectionId, String itemId, String tileMatrixSetId,
+ double z, double x, double y, double scale, String format) {
+ // Generated convenience method for getTileByScaleAndFormatWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getTileByScaleAndFormatWithResponse(collectionId, itemId, tileMatrixSetId, z, x, y, scale, format,
+ requestOptions).flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile Plain
+ *
+ * Create map tile from a dataset (without TileMatrixSetId, scale or format in path).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param bidx Dataset band indexes.
+ * @param assets Asset's names.
+ * @param expression Band math expression between assets.
+ * @param assetBandIndices Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1,
+ * 2, and 3 from the asset named "image").
+ * @param assetAsBand Asset as Band.
+ * @param noData Overwrite internal Nodata value.
+ * @param unscale Apply internal Scale or Offset.
+ * @param reproject WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.
+ * @param algorithm Terrain algorithm name.
+ * @param algorithmParams Terrain algorithm parameters.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported (default:
+ * 'WebMercatorQuad').
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param buffer Buffer on each side of the given tile. It must be a multiple of `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258).
+ * @param colorFormula rio-color formula (info: https://github.com/mapbox/rio-color).
+ * @param resampling Resampling method.
+ * @param rescale comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
+ * @param colorMapName Colormap name.
+ * @param colorMap JSON encoded custom Colormap.
+ * @param returnMask Add mask to the output data.
+ * @param padding Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to
+ * `0`.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTileNoTms(String collectionId, String itemId, double z, double x, double y,
+ List bidx, List assets, String expression, List assetBandIndices, Boolean assetAsBand,
+ String noData, Boolean unscale, WarpKernelResampling reproject, TerrainAlgorithm algorithm,
+ String algorithmParams, TileMatrixSetId tileMatrixSetId, TilerImageFormat format, Integer scale, Double buffer,
+ String colorFormula, Resampling resampling, List rescale, ColorMapNames colorMapName, String colorMap,
+ Boolean returnMask, Integer padding, String subdatasetName, List subdatasetBands, String crs,
+ String datetime, List sel, SelMethod selMethod) {
+ // Generated convenience method for getTileNoTmsWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (bidx != null) {
+ for (int paramItemValue : bidx) {
+ requestOptions.addQueryParam("bidx", String.valueOf(paramItemValue), false);
+ }
+ }
+ if (assets != null) {
+ for (String paramItemValue : assets) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("assets", paramItemValue, false);
+ }
+ }
+ }
+ if (expression != null) {
+ requestOptions.addQueryParam("expression", expression, false);
+ }
+ if (assetBandIndices != null) {
+ requestOptions.addQueryParam("asset_bidx",
+ assetBandIndices.stream()
+ .map(paramItemValue -> Objects.toString(paramItemValue, ""))
+ .collect(Collectors.joining(",")),
+ false);
+ }
+ if (assetAsBand != null) {
+ requestOptions.addQueryParam("asset_as_band", String.valueOf(assetAsBand), false);
+ }
+ if (noData != null) {
+ requestOptions.addQueryParam("nodata", noData, false);
+ }
+ if (unscale != null) {
+ requestOptions.addQueryParam("unscale", String.valueOf(unscale), false);
+ }
+ if (reproject != null) {
+ requestOptions.addQueryParam("reproject", reproject.toString(), false);
+ }
+ if (algorithm != null) {
+ requestOptions.addQueryParam("algorithm", algorithm.toString(), false);
+ }
+ if (algorithmParams != null) {
+ requestOptions.addQueryParam("algorithm_params", algorithmParams, false);
+ }
+ if (tileMatrixSetId != null) {
+ requestOptions.addQueryParam("TileMatrixSetId", tileMatrixSetId.toString(), false);
+ }
+ if (format != null) {
+ requestOptions.addQueryParam("format", format.toString(), false);
+ }
+ if (scale != null) {
+ requestOptions.addQueryParam("scale", String.valueOf(scale), false);
+ }
+ if (buffer != null) {
+ requestOptions.addQueryParam("buffer", String.valueOf(buffer), false);
+ }
+ if (colorFormula != null) {
+ requestOptions.addQueryParam("color_formula", colorFormula, false);
+ }
+ if (resampling != null) {
+ requestOptions.addQueryParam("resampling", resampling.toString(), false);
+ }
+ if (rescale != null) {
+ for (String paramItemValue : rescale) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("rescale", paramItemValue, false);
+ }
+ }
+ }
+ if (colorMapName != null) {
+ requestOptions.addQueryParam("colormap_name", colorMapName.toString(), false);
+ }
+ if (colorMap != null) {
+ requestOptions.addQueryParam("colormap", colorMap, false);
+ }
+ if (returnMask != null) {
+ requestOptions.addQueryParam("return_mask", String.valueOf(returnMask), false);
+ }
+ if (padding != null) {
+ requestOptions.addQueryParam("padding", String.valueOf(padding), false);
+ }
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ return getTileNoTmsWithResponse(collectionId, itemId, z, x, y, requestOptions).flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile Plain
+ *
+ * Create map tile from a dataset (without TileMatrixSetId, scale or format in path).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTileNoTms(String collectionId, String itemId, double z, double x, double y) {
+ // Generated convenience method for getTileNoTmsWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getTileNoTmsWithResponse(collectionId, itemId, z, x, y, requestOptions).flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile Format
+ *
+ * Create map tile from a dataset (with format in path, without TileMatrixSetId or scale).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param bidx Dataset band indexes.
+ * @param assets Asset's names.
+ * @param expression Band math expression between assets.
+ * @param assetBandIndices Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1,
+ * 2, and 3 from the asset named "image").
+ * @param assetAsBand Asset as Band.
+ * @param noData Overwrite internal Nodata value.
+ * @param unscale Apply internal Scale or Offset.
+ * @param reproject WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.
+ * @param algorithm Terrain algorithm name.
+ * @param algorithmParams Terrain algorithm parameters.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported (default:
+ * 'WebMercatorQuad').
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param buffer Buffer on each side of the given tile. It must be a multiple of `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258).
+ * @param colorFormula rio-color formula (info: https://github.com/mapbox/rio-color).
+ * @param resampling Resampling method.
+ * @param rescale comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
+ * @param colorMapName Colormap name.
+ * @param colorMap JSON encoded custom Colormap.
+ * @param returnMask Add mask to the output data.
+ * @param padding Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to
+ * `0`.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTileNoTmsByFormat(String collectionId, String itemId, double z, double x, double y,
+ String format, List bidx, List assets, String expression, List assetBandIndices,
+ Boolean assetAsBand, String noData, Boolean unscale, WarpKernelResampling reproject, TerrainAlgorithm algorithm,
+ String algorithmParams, TileMatrixSetId tileMatrixSetId, Integer scale, Double buffer, String colorFormula,
+ Resampling resampling, List rescale, ColorMapNames colorMapName, String colorMap, Boolean returnMask,
+ Integer padding, String subdatasetName, List subdatasetBands, String crs, String datetime,
+ List sel, SelMethod selMethod) {
+ // Generated convenience method for getTileNoTmsByFormatWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (bidx != null) {
+ for (int paramItemValue : bidx) {
+ requestOptions.addQueryParam("bidx", String.valueOf(paramItemValue), false);
+ }
+ }
+ if (assets != null) {
+ for (String paramItemValue : assets) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("assets", paramItemValue, false);
+ }
+ }
+ }
+ if (expression != null) {
+ requestOptions.addQueryParam("expression", expression, false);
+ }
+ if (assetBandIndices != null) {
+ requestOptions.addQueryParam("asset_bidx",
+ assetBandIndices.stream()
+ .map(paramItemValue -> Objects.toString(paramItemValue, ""))
+ .collect(Collectors.joining(",")),
+ false);
+ }
+ if (assetAsBand != null) {
+ requestOptions.addQueryParam("asset_as_band", String.valueOf(assetAsBand), false);
+ }
+ if (noData != null) {
+ requestOptions.addQueryParam("nodata", noData, false);
+ }
+ if (unscale != null) {
+ requestOptions.addQueryParam("unscale", String.valueOf(unscale), false);
+ }
+ if (reproject != null) {
+ requestOptions.addQueryParam("reproject", reproject.toString(), false);
+ }
+ if (algorithm != null) {
+ requestOptions.addQueryParam("algorithm", algorithm.toString(), false);
+ }
+ if (algorithmParams != null) {
+ requestOptions.addQueryParam("algorithm_params", algorithmParams, false);
+ }
+ if (tileMatrixSetId != null) {
+ requestOptions.addQueryParam("TileMatrixSetId", tileMatrixSetId.toString(), false);
+ }
+ if (scale != null) {
+ requestOptions.addQueryParam("scale", String.valueOf(scale), false);
+ }
+ if (buffer != null) {
+ requestOptions.addQueryParam("buffer", String.valueOf(buffer), false);
+ }
+ if (colorFormula != null) {
+ requestOptions.addQueryParam("color_formula", colorFormula, false);
+ }
+ if (resampling != null) {
+ requestOptions.addQueryParam("resampling", resampling.toString(), false);
+ }
+ if (rescale != null) {
+ for (String paramItemValue : rescale) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("rescale", paramItemValue, false);
+ }
+ }
+ }
+ if (colorMapName != null) {
+ requestOptions.addQueryParam("colormap_name", colorMapName.toString(), false);
+ }
+ if (colorMap != null) {
+ requestOptions.addQueryParam("colormap", colorMap, false);
+ }
+ if (returnMask != null) {
+ requestOptions.addQueryParam("return_mask", String.valueOf(returnMask), false);
+ }
+ if (padding != null) {
+ requestOptions.addQueryParam("padding", String.valueOf(padding), false);
+ }
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ return getTileNoTmsByFormatWithResponse(collectionId, itemId, z, x, y, format, requestOptions)
+ .flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile Format
+ *
+ * Create map tile from a dataset (with format in path, without TileMatrixSetId or scale).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTileNoTmsByFormat(String collectionId, String itemId, double z, double x, double y,
+ String format) {
+ // Generated convenience method for getTileNoTmsByFormatWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getTileNoTmsByFormatWithResponse(collectionId, itemId, z, x, y, format, requestOptions)
+ .flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile Scale
+ *
+ * Create map tile from a dataset (with scale in path, without TileMatrixSetId or format).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param bidx Dataset band indexes.
+ * @param assets Asset's names.
+ * @param expression Band math expression between assets.
+ * @param assetBandIndices Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1,
+ * 2, and 3 from the asset named "image").
+ * @param assetAsBand Asset as Band.
+ * @param noData Overwrite internal Nodata value.
+ * @param unscale Apply internal Scale or Offset.
+ * @param reproject WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.
+ * @param algorithm Terrain algorithm name.
+ * @param algorithmParams Terrain algorithm parameters.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported (default:
+ * 'WebMercatorQuad').
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param buffer Buffer on each side of the given tile. It must be a multiple of `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258).
+ * @param colorFormula rio-color formula (info: https://github.com/mapbox/rio-color).
+ * @param resampling Resampling method.
+ * @param rescale comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
+ * @param colorMapName Colormap name.
+ * @param colorMap JSON encoded custom Colormap.
+ * @param returnMask Add mask to the output data.
+ * @param padding Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to
+ * `0`.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTileNoTmsByScale(String collectionId, String itemId, double z, double x, double y,
+ double scale, List bidx, List assets, String expression, List assetBandIndices,
+ Boolean assetAsBand, String noData, Boolean unscale, WarpKernelResampling reproject, TerrainAlgorithm algorithm,
+ String algorithmParams, TileMatrixSetId tileMatrixSetId, TilerImageFormat format, Double buffer,
+ String colorFormula, Resampling resampling, List rescale, ColorMapNames colorMapName, String colorMap,
+ Boolean returnMask, Integer padding, String subdatasetName, List subdatasetBands, String crs,
+ String datetime, List sel, SelMethod selMethod) {
+ // Generated convenience method for getTileNoTmsByScaleWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (bidx != null) {
+ for (int paramItemValue : bidx) {
+ requestOptions.addQueryParam("bidx", String.valueOf(paramItemValue), false);
+ }
+ }
+ if (assets != null) {
+ for (String paramItemValue : assets) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("assets", paramItemValue, false);
+ }
+ }
+ }
+ if (expression != null) {
+ requestOptions.addQueryParam("expression", expression, false);
+ }
+ if (assetBandIndices != null) {
+ requestOptions.addQueryParam("asset_bidx",
+ assetBandIndices.stream()
+ .map(paramItemValue -> Objects.toString(paramItemValue, ""))
+ .collect(Collectors.joining(",")),
+ false);
+ }
+ if (assetAsBand != null) {
+ requestOptions.addQueryParam("asset_as_band", String.valueOf(assetAsBand), false);
+ }
+ if (noData != null) {
+ requestOptions.addQueryParam("nodata", noData, false);
+ }
+ if (unscale != null) {
+ requestOptions.addQueryParam("unscale", String.valueOf(unscale), false);
+ }
+ if (reproject != null) {
+ requestOptions.addQueryParam("reproject", reproject.toString(), false);
+ }
+ if (algorithm != null) {
+ requestOptions.addQueryParam("algorithm", algorithm.toString(), false);
+ }
+ if (algorithmParams != null) {
+ requestOptions.addQueryParam("algorithm_params", algorithmParams, false);
+ }
+ if (tileMatrixSetId != null) {
+ requestOptions.addQueryParam("TileMatrixSetId", tileMatrixSetId.toString(), false);
+ }
+ if (format != null) {
+ requestOptions.addQueryParam("format", format.toString(), false);
+ }
+ if (buffer != null) {
+ requestOptions.addQueryParam("buffer", String.valueOf(buffer), false);
+ }
+ if (colorFormula != null) {
+ requestOptions.addQueryParam("color_formula", colorFormula, false);
+ }
+ if (resampling != null) {
+ requestOptions.addQueryParam("resampling", resampling.toString(), false);
+ }
+ if (rescale != null) {
+ for (String paramItemValue : rescale) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("rescale", paramItemValue, false);
+ }
+ }
+ }
+ if (colorMapName != null) {
+ requestOptions.addQueryParam("colormap_name", colorMapName.toString(), false);
+ }
+ if (colorMap != null) {
+ requestOptions.addQueryParam("colormap", colorMap, false);
+ }
+ if (returnMask != null) {
+ requestOptions.addQueryParam("return_mask", String.valueOf(returnMask), false);
+ }
+ if (padding != null) {
+ requestOptions.addQueryParam("padding", String.valueOf(padding), false);
+ }
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ return getTileNoTmsByScaleWithResponse(collectionId, itemId, z, x, y, scale, requestOptions)
+ .flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile Scale
+ *
+ * Create map tile from a dataset (with scale in path, without TileMatrixSetId or format).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTileNoTmsByScale(String collectionId, String itemId, double z, double x, double y,
+ double scale) {
+ // Generated convenience method for getTileNoTmsByScaleWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getTileNoTmsByScaleWithResponse(collectionId, itemId, z, x, y, scale, requestOptions)
+ .flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile
+ *
+ * Create map tile from a dataset (with scale and format in path, without TileMatrixSetId).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param bidx Dataset band indexes.
+ * @param assets Asset's names.
+ * @param expression Band math expression between assets.
+ * @param assetBandIndices Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1,
+ * 2, and 3 from the asset named "image").
+ * @param assetAsBand Asset as Band.
+ * @param noData Overwrite internal Nodata value.
+ * @param unscale Apply internal Scale or Offset.
+ * @param reproject WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.
+ * @param algorithm Terrain algorithm name.
+ * @param algorithmParams Terrain algorithm parameters.
+ * @param tileMatrixSetId Identifier selecting one of the TileMatrixSetId supported (default:
+ * 'WebMercatorQuad').
+ * @param buffer Buffer on each side of the given tile. It must be a multiple of `0.5`. Output
+ * **tilesize** will be expanded to `tilesize + 2 * buffer` (e.g 0.5 = 257x257,
+ * 1.0 = 258x258).
+ * @param colorFormula rio-color formula (info: https://github.com/mapbox/rio-color).
+ * @param resampling Resampling method.
+ * @param rescale comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
+ * @param colorMapName Colormap name.
+ * @param colorMap JSON encoded custom Colormap.
+ * @param returnMask Add mask to the output data.
+ * @param padding Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to
+ * `0`.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTileNoTmsByScaleAndFormat(String collectionId, String itemId, double z, double x,
+ double y, double scale, String format, List bidx, List assets, String expression,
+ List assetBandIndices, Boolean assetAsBand, String noData, Boolean unscale,
+ WarpKernelResampling reproject, TerrainAlgorithm algorithm, String algorithmParams,
+ TileMatrixSetId tileMatrixSetId, Double buffer, String colorFormula, Resampling resampling,
+ List rescale, ColorMapNames colorMapName, String colorMap, Boolean returnMask, Integer padding,
+ String subdatasetName, List subdatasetBands, String crs, String datetime, List sel,
+ SelMethod selMethod) {
+ // Generated convenience method for getTileNoTmsByScaleAndFormatWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (bidx != null) {
+ for (int paramItemValue : bidx) {
+ requestOptions.addQueryParam("bidx", String.valueOf(paramItemValue), false);
+ }
+ }
+ if (assets != null) {
+ for (String paramItemValue : assets) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("assets", paramItemValue, false);
+ }
+ }
+ }
+ if (expression != null) {
+ requestOptions.addQueryParam("expression", expression, false);
+ }
+ if (assetBandIndices != null) {
+ requestOptions.addQueryParam("asset_bidx",
+ assetBandIndices.stream()
+ .map(paramItemValue -> Objects.toString(paramItemValue, ""))
+ .collect(Collectors.joining(",")),
+ false);
+ }
+ if (assetAsBand != null) {
+ requestOptions.addQueryParam("asset_as_band", String.valueOf(assetAsBand), false);
+ }
+ if (noData != null) {
+ requestOptions.addQueryParam("nodata", noData, false);
+ }
+ if (unscale != null) {
+ requestOptions.addQueryParam("unscale", String.valueOf(unscale), false);
+ }
+ if (reproject != null) {
+ requestOptions.addQueryParam("reproject", reproject.toString(), false);
+ }
+ if (algorithm != null) {
+ requestOptions.addQueryParam("algorithm", algorithm.toString(), false);
+ }
+ if (algorithmParams != null) {
+ requestOptions.addQueryParam("algorithm_params", algorithmParams, false);
+ }
+ if (tileMatrixSetId != null) {
+ requestOptions.addQueryParam("TileMatrixSetId", tileMatrixSetId.toString(), false);
+ }
+ if (buffer != null) {
+ requestOptions.addQueryParam("buffer", String.valueOf(buffer), false);
+ }
+ if (colorFormula != null) {
+ requestOptions.addQueryParam("color_formula", colorFormula, false);
+ }
+ if (resampling != null) {
+ requestOptions.addQueryParam("resampling", resampling.toString(), false);
+ }
+ if (rescale != null) {
+ for (String paramItemValue : rescale) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("rescale", paramItemValue, false);
+ }
+ }
+ }
+ if (colorMapName != null) {
+ requestOptions.addQueryParam("colormap_name", colorMapName.toString(), false);
+ }
+ if (colorMap != null) {
+ requestOptions.addQueryParam("colormap", colorMap, false);
+ }
+ if (returnMask != null) {
+ requestOptions.addQueryParam("return_mask", String.valueOf(returnMask), false);
+ }
+ if (padding != null) {
+ requestOptions.addQueryParam("padding", String.valueOf(padding), false);
+ }
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ return getTileNoTmsByScaleAndFormatWithResponse(collectionId, itemId, z, x, y, scale, format, requestOptions)
+ .flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Tile
+ *
+ * Create map tile from a dataset (with scale and format in path, without TileMatrixSetId).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param z Identifier (Z) selecting one of the scales defined in the TileMatrixSet and
+ * representing the scaleDenominator the tile.
+ * @param x Column (X) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixHeight-1 for the selected TileMatrix.
+ * @param y Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the
+ * MatrixWidth-1 for the selected TileMatrix.
+ * @param scale Numeric scale factor for the tile. Higher values produce larger tiles.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getTileNoTmsByScaleAndFormat(String collectionId, String itemId, double z, double x,
+ double y, double scale, String format) {
+ // Generated convenience method for getTileNoTmsByScaleAndFormatWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getTileNoTmsByScaleAndFormatWithResponse(collectionId, itemId, z, x, y, scale, format, requestOptions)
+ .flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Geojson Feature
+ *
+ * Create image from a geojson feature (without format in path).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param body Request GeoJson body.
+ * @param bidx Dataset band indexes.
+ * @param assets Asset's names.
+ * @param expression Band math expression between assets.
+ * @param assetBandIndices Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1,
+ * 2, and 3 from the asset named "image").
+ * @param assetAsBand Asset as Band.
+ * @param noData Overwrite internal Nodata value.
+ * @param unscale Apply internal Scale or Offset.
+ * @param reproject WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.
+ * @param algorithm Terrain algorithm name.
+ * @param algorithmParams Terrain algorithm parameters.
+ * @param colorFormula rio-color formula (info: https://github.com/mapbox/rio-color).
+ * @param coordinateReferenceSystem Coordinate Reference System of the input coords. Default to `epsg:4326`.
+ * @param resampling Resampling method.
+ * @param maxSize Image output size limit if width and height limits are not set.
+ * @param height Height in pixels for the output image.
+ * @param width Width in pixels for the output image.
+ * @param rescale comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
+ * @param colorMapName Colormap name.
+ * @param colorMap JSON encoded custom Colormap.
+ * @param returnMask Add mask to the output data.
+ * @param destinationCrs Output Coordinate Reference System.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @param format Output image format.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono cropFeature(String collectionId, String itemId, Feature body, List bidx,
+ List assets, String expression, List assetBandIndices, Boolean assetAsBand, String noData,
+ Boolean unscale, WarpKernelResampling reproject, TerrainAlgorithm algorithm, String algorithmParams,
+ String colorFormula, String coordinateReferenceSystem, Resampling resampling, Integer maxSize, Integer height,
+ Integer width, List rescale, ColorMapNames colorMapName, String colorMap, Boolean returnMask,
+ String destinationCrs, String subdatasetName, List subdatasetBands, String crs, String datetime,
+ List sel, SelMethod selMethod, TilerImageFormat format) {
+ // Generated convenience method for cropFeatureWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (bidx != null) {
+ for (int paramItemValue : bidx) {
+ requestOptions.addQueryParam("bidx", String.valueOf(paramItemValue), false);
+ }
+ }
+ if (assets != null) {
+ for (String paramItemValue : assets) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("assets", paramItemValue, false);
+ }
+ }
+ }
+ if (expression != null) {
+ requestOptions.addQueryParam("expression", expression, false);
+ }
+ if (assetBandIndices != null) {
+ requestOptions.addQueryParam("asset_bidx",
+ assetBandIndices.stream()
+ .map(paramItemValue -> Objects.toString(paramItemValue, ""))
+ .collect(Collectors.joining(",")),
+ false);
+ }
+ if (assetAsBand != null) {
+ requestOptions.addQueryParam("asset_as_band", String.valueOf(assetAsBand), false);
+ }
+ if (noData != null) {
+ requestOptions.addQueryParam("nodata", noData, false);
+ }
+ if (unscale != null) {
+ requestOptions.addQueryParam("unscale", String.valueOf(unscale), false);
+ }
+ if (reproject != null) {
+ requestOptions.addQueryParam("reproject", reproject.toString(), false);
+ }
+ if (algorithm != null) {
+ requestOptions.addQueryParam("algorithm", algorithm.toString(), false);
+ }
+ if (algorithmParams != null) {
+ requestOptions.addQueryParam("algorithm_params", algorithmParams, false);
+ }
+ if (colorFormula != null) {
+ requestOptions.addQueryParam("color_formula", colorFormula, false);
+ }
+ if (coordinateReferenceSystem != null) {
+ requestOptions.addQueryParam("coord_crs", coordinateReferenceSystem, false);
+ }
+ if (resampling != null) {
+ requestOptions.addQueryParam("resampling", resampling.toString(), false);
+ }
+ if (maxSize != null) {
+ requestOptions.addQueryParam("max_size", String.valueOf(maxSize), false);
+ }
+ if (height != null) {
+ requestOptions.addQueryParam("height", String.valueOf(height), false);
+ }
+ if (width != null) {
+ requestOptions.addQueryParam("width", String.valueOf(width), false);
+ }
+ if (rescale != null) {
+ for (String paramItemValue : rescale) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("rescale", paramItemValue, false);
+ }
+ }
+ }
+ if (colorMapName != null) {
+ requestOptions.addQueryParam("colormap_name", colorMapName.toString(), false);
+ }
+ if (colorMap != null) {
+ requestOptions.addQueryParam("colormap", colorMap, false);
+ }
+ if (returnMask != null) {
+ requestOptions.addQueryParam("return_mask", String.valueOf(returnMask), false);
+ }
+ if (destinationCrs != null) {
+ requestOptions.addQueryParam("dst_crs", destinationCrs, false);
+ }
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ if (format != null) {
+ requestOptions.addQueryParam("format", format.toString(), false);
+ }
+ return cropFeatureWithResponse(collectionId, itemId, BinaryData.fromObject(body), requestOptions)
+ .flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Geojson Feature
+ *
+ * Create image from a geojson feature (without format in path).
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param body Request GeoJson body.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono cropFeature(String collectionId, String itemId, Feature body) {
+ // Generated convenience method for cropFeatureWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return cropFeatureWithResponse(collectionId, itemId, BinaryData.fromObject(body), requestOptions)
+ .flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Geojson Feature Crop With Format
+ *
+ * Create image from a geojson feature with format.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param body Request GeoJson body.
+ * @param bidx Dataset band indexes.
+ * @param assets Asset's names.
+ * @param expression Band math expression between assets.
+ * @param assetBandIndices Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1,
+ * 2, and 3 from the asset named "image").
+ * @param assetAsBand Asset as Band.
+ * @param noData Overwrite internal Nodata value.
+ * @param unscale Apply internal Scale or Offset.
+ * @param reproject WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.
+ * @param algorithm Terrain algorithm name.
+ * @param algorithmParams Terrain algorithm parameters.
+ * @param colorFormula rio-color formula (info: https://github.com/mapbox/rio-color).
+ * @param coordinateReferenceSystem Coordinate Reference System of the input coords. Default to `epsg:4326`.
+ * @param resampling Resampling method.
+ * @param maxSize Image output size limit if width and height limits are not set.
+ * @param height Height in pixels for the output image.
+ * @param width Width in pixels for the output image.
+ * @param rescale comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
+ * @param colorMapName Colormap name.
+ * @param colorMap JSON encoded custom Colormap.
+ * @param returnMask Add mask to the output data.
+ * @param destinationCrs Output Coordinate Reference System.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono cropFeatureByFormat(String collectionId, String itemId, String format, Feature body,
+ List bidx, List assets, String expression, List assetBandIndices, Boolean assetAsBand,
+ String noData, Boolean unscale, WarpKernelResampling reproject, TerrainAlgorithm algorithm,
+ String algorithmParams, String colorFormula, String coordinateReferenceSystem, Resampling resampling,
+ Integer maxSize, Integer height, Integer width, List rescale, ColorMapNames colorMapName,
+ String colorMap, Boolean returnMask, String destinationCrs, String subdatasetName,
+ List subdatasetBands, String crs, String datetime, List sel, SelMethod selMethod) {
+ // Generated convenience method for cropFeatureByFormatWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (bidx != null) {
+ for (int paramItemValue : bidx) {
+ requestOptions.addQueryParam("bidx", String.valueOf(paramItemValue), false);
+ }
+ }
+ if (assets != null) {
+ for (String paramItemValue : assets) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("assets", paramItemValue, false);
+ }
+ }
+ }
+ if (expression != null) {
+ requestOptions.addQueryParam("expression", expression, false);
+ }
+ if (assetBandIndices != null) {
+ requestOptions.addQueryParam("asset_bidx",
+ assetBandIndices.stream()
+ .map(paramItemValue -> Objects.toString(paramItemValue, ""))
+ .collect(Collectors.joining(",")),
+ false);
+ }
+ if (assetAsBand != null) {
+ requestOptions.addQueryParam("asset_as_band", String.valueOf(assetAsBand), false);
+ }
+ if (noData != null) {
+ requestOptions.addQueryParam("nodata", noData, false);
+ }
+ if (unscale != null) {
+ requestOptions.addQueryParam("unscale", String.valueOf(unscale), false);
+ }
+ if (reproject != null) {
+ requestOptions.addQueryParam("reproject", reproject.toString(), false);
+ }
+ if (algorithm != null) {
+ requestOptions.addQueryParam("algorithm", algorithm.toString(), false);
+ }
+ if (algorithmParams != null) {
+ requestOptions.addQueryParam("algorithm_params", algorithmParams, false);
+ }
+ if (colorFormula != null) {
+ requestOptions.addQueryParam("color_formula", colorFormula, false);
+ }
+ if (coordinateReferenceSystem != null) {
+ requestOptions.addQueryParam("coord_crs", coordinateReferenceSystem, false);
+ }
+ if (resampling != null) {
+ requestOptions.addQueryParam("resampling", resampling.toString(), false);
+ }
+ if (maxSize != null) {
+ requestOptions.addQueryParam("max_size", String.valueOf(maxSize), false);
+ }
+ if (height != null) {
+ requestOptions.addQueryParam("height", String.valueOf(height), false);
+ }
+ if (width != null) {
+ requestOptions.addQueryParam("width", String.valueOf(width), false);
+ }
+ if (rescale != null) {
+ for (String paramItemValue : rescale) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("rescale", paramItemValue, false);
+ }
+ }
+ }
+ if (colorMapName != null) {
+ requestOptions.addQueryParam("colormap_name", colorMapName.toString(), false);
+ }
+ if (colorMap != null) {
+ requestOptions.addQueryParam("colormap", colorMap, false);
+ }
+ if (returnMask != null) {
+ requestOptions.addQueryParam("return_mask", String.valueOf(returnMask), false);
+ }
+ if (destinationCrs != null) {
+ requestOptions.addQueryParam("dst_crs", destinationCrs, false);
+ }
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ return cropFeatureByFormatWithResponse(collectionId, itemId, format, BinaryData.fromObject(body),
+ requestOptions).flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Geojson Feature Crop With Format
+ *
+ * Create image from a geojson feature with format.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param body Request GeoJson body.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono cropFeatureByFormat(String collectionId, String itemId, String format, Feature body) {
+ // Generated convenience method for cropFeatureByFormatWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return cropFeatureByFormatWithResponse(collectionId, itemId, format, BinaryData.fromObject(body),
+ requestOptions).flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Geojson Feature Crop With Dimensions
+ *
+ * Create image from a geojson feature with dimensions.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param width Width in pixels for the output image.
+ * @param height Height in pixels for the output image.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param body Request GeoJson body.
+ * @param bidx Dataset band indexes.
+ * @param assets Asset's names.
+ * @param expression Band math expression between assets.
+ * @param assetBandIndices Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1,
+ * 2, and 3 from the asset named "image").
+ * @param assetAsBand Asset as Band.
+ * @param noData Overwrite internal Nodata value.
+ * @param unscale Apply internal Scale or Offset.
+ * @param reproject WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.
+ * @param algorithm Terrain algorithm name.
+ * @param algorithmParams Terrain algorithm parameters.
+ * @param colorFormula rio-color formula (info: https://github.com/mapbox/rio-color).
+ * @param coordinateReferenceSystem Coordinate Reference System of the input coords. Default to `epsg:4326`.
+ * @param resampling Resampling method.
+ * @param maxSize Image output size limit if width and height limits are not set.
+ * @param rescale comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
+ * @param colorMapName Colormap name.
+ * @param colorMap JSON encoded custom Colormap.
+ * @param returnMask Add mask to the output data.
+ * @param destinationCrs Output Coordinate Reference System.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono cropFeatureWidthByHeight(String collectionId, String itemId, int width, int height,
+ String format, Feature body, List bidx, List assets, String expression,
+ List assetBandIndices, Boolean assetAsBand, String noData, Boolean unscale,
+ WarpKernelResampling reproject, TerrainAlgorithm algorithm, String algorithmParams, String colorFormula,
+ String coordinateReferenceSystem, Resampling resampling, Integer maxSize, List rescale,
+ ColorMapNames colorMapName, String colorMap, Boolean returnMask, String destinationCrs, String subdatasetName,
+ List subdatasetBands, String crs, String datetime, List sel, SelMethod selMethod) {
+ // Generated convenience method for cropFeatureWidthByHeightWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (bidx != null) {
+ for (int paramItemValue : bidx) {
+ requestOptions.addQueryParam("bidx", String.valueOf(paramItemValue), false);
+ }
+ }
+ if (assets != null) {
+ for (String paramItemValue : assets) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("assets", paramItemValue, false);
+ }
+ }
+ }
+ if (expression != null) {
+ requestOptions.addQueryParam("expression", expression, false);
+ }
+ if (assetBandIndices != null) {
+ requestOptions.addQueryParam("asset_bidx",
+ assetBandIndices.stream()
+ .map(paramItemValue -> Objects.toString(paramItemValue, ""))
+ .collect(Collectors.joining(",")),
+ false);
+ }
+ if (assetAsBand != null) {
+ requestOptions.addQueryParam("asset_as_band", String.valueOf(assetAsBand), false);
+ }
+ if (noData != null) {
+ requestOptions.addQueryParam("nodata", noData, false);
+ }
+ if (unscale != null) {
+ requestOptions.addQueryParam("unscale", String.valueOf(unscale), false);
+ }
+ if (reproject != null) {
+ requestOptions.addQueryParam("reproject", reproject.toString(), false);
+ }
+ if (algorithm != null) {
+ requestOptions.addQueryParam("algorithm", algorithm.toString(), false);
+ }
+ if (algorithmParams != null) {
+ requestOptions.addQueryParam("algorithm_params", algorithmParams, false);
+ }
+ if (colorFormula != null) {
+ requestOptions.addQueryParam("color_formula", colorFormula, false);
+ }
+ if (coordinateReferenceSystem != null) {
+ requestOptions.addQueryParam("coord_crs", coordinateReferenceSystem, false);
+ }
+ if (resampling != null) {
+ requestOptions.addQueryParam("resampling", resampling.toString(), false);
+ }
+ if (maxSize != null) {
+ requestOptions.addQueryParam("max_size", String.valueOf(maxSize), false);
+ }
+ if (rescale != null) {
+ for (String paramItemValue : rescale) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("rescale", paramItemValue, false);
+ }
+ }
+ }
+ if (colorMapName != null) {
+ requestOptions.addQueryParam("colormap_name", colorMapName.toString(), false);
+ }
+ if (colorMap != null) {
+ requestOptions.addQueryParam("colormap", colorMap, false);
+ }
+ if (returnMask != null) {
+ requestOptions.addQueryParam("return_mask", String.valueOf(returnMask), false);
+ }
+ if (destinationCrs != null) {
+ requestOptions.addQueryParam("dst_crs", destinationCrs, false);
+ }
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ return cropFeatureWidthByHeightWithResponse(collectionId, itemId, width, height, format,
+ BinaryData.fromObject(body), requestOptions).flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Geojson Feature Crop With Dimensions
+ *
+ * Create image from a geojson feature with dimensions.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param width Width in pixels for the output image.
+ * @param height Height in pixels for the output image.
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp).
+ * @param body Request GeoJson body.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono cropFeatureWidthByHeight(String collectionId, String itemId, int width, int height,
+ String format, Feature body) {
+ // Generated convenience method for cropFeatureWidthByHeightWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return cropFeatureWidthByHeightWithResponse(collectionId, itemId, width, height, format,
+ BinaryData.fromObject(body), requestOptions).flatMap(FluxUtil::toMono);
+ }
+
+ /**
+ * Item Bounds
+ *
+ * Return the bounds for a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return geographic extent of a dataset expressed as a bounding box on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getItemBounds(String collectionId, String itemId, String subdatasetName,
+ List subdatasetBands, String crs, String datetime, List sel, SelMethod selMethod) {
+ // Generated convenience method for getItemBoundsWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ return getItemBoundsWithResponse(collectionId, itemId, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(StacItemBounds.class));
+ }
+
+ /**
+ * Item Bounds
+ *
+ * Return the bounds for a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return geographic extent of a dataset expressed as a bounding box on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getItemBounds(String collectionId, String itemId) {
+ // Generated convenience method for getItemBoundsWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getItemBoundsWithResponse(collectionId, itemId, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(StacItemBounds.class));
+ }
+
+ /**
+ * Item Info
+ *
+ * Return dataset's basic info for a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @param assets Asset's names.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return return dataset's basic info on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getItemInfo(String collectionId, String itemId, String subdatasetName,
+ List subdatasetBands, String crs, String datetime, List sel, SelMethod selMethod,
+ List assets) {
+ // Generated convenience method for getItemInfoWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ if (assets != null) {
+ for (String paramItemValue : assets) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("assets", paramItemValue, false);
+ }
+ }
+ }
+ return getItemInfoWithResponse(collectionId, itemId, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TilerInfoMapResponse.class));
+ }
+
+ /**
+ * Item Info
+ *
+ * Return dataset's basic info for a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return return dataset's basic info on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getItemInfo(String collectionId, String itemId) {
+ // Generated convenience method for getItemInfoWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getItemInfoWithResponse(collectionId, itemId, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TilerInfoMapResponse.class));
+ }
+
+ /**
+ * Item Info Geojson
+ *
+ * Return info as GeoJSON for a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @param assets Asset's names.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return geoJSON Feature object containing rio-tiler model information on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getItemInfoGeoJson(String collectionId, String itemId, String subdatasetName,
+ List subdatasetBands, String crs, String datetime, List sel, SelMethod selMethod,
+ List assets) {
+ // Generated convenience method for getItemInfoGeoJsonWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ if (assets != null) {
+ for (String paramItemValue : assets) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("assets", paramItemValue, false);
+ }
+ }
+ }
+ return getItemInfoGeoJsonWithResponse(collectionId, itemId, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TilerInfoGeoJsonFeature.class));
+ }
+
+ /**
+ * Item Info Geojson
+ *
+ * Return info as GeoJSON for a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return geoJSON Feature object containing rio-tiler model information on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getItemInfoGeoJson(String collectionId, String itemId) {
+ // Generated convenience method for getItemInfoGeoJsonWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getItemInfoGeoJsonWithResponse(collectionId, itemId, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TilerInfoGeoJsonFeature.class));
+ }
+
+ /**
+ * Item Available Assets
+ *
+ * Return a list of supported assets for a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getItemAvailableAssets(String collectionId, String itemId, String subdatasetName,
+ List subdatasetBands, String crs, String datetime, List sel, SelMethod selMethod) {
+ // Generated convenience method for getItemAvailableAssetsWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ return getItemAvailableAssetsWithResponse(collectionId, itemId, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TYPE_REFERENCE_LIST_STRING));
+ }
+
+ /**
+ * Item Available Assets
+ *
+ * Return a list of supported assets for a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return the response body on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono> getItemAvailableAssets(String collectionId, String itemId) {
+ // Generated convenience method for getItemAvailableAssetsWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getItemAvailableAssetsWithResponse(collectionId, itemId, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(TYPE_REFERENCE_LIST_STRING));
+ }
+
+ /**
+ * Item Asset Statistics
+ *
+ * Per asset statistics for a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param bidx Dataset band indexes.
+ * @param assets Asset's names.
+ * @param assetBandIndices Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1,
+ * 2, and 3 from the asset named "image").
+ * @param noData Overwrite internal Nodata value.
+ * @param unscale Apply internal Scale or Offset.
+ * @param reproject WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.
+ * @param resampling Resampling method.
+ * @param maxSize Maximum dimension in pixels for the source data used to calculate statistics.
+ * @param categorical Return statistics for categorical dataset.
+ * @param categoriesPixels List of pixel categorical values for which to report counts.
+ * @param percentiles List of percentile values (default to [2, 98]).
+ * @param histogramBins Defines the number of equal-width bins in the given range (10, by default).
+ *
+ * If bins is a sequence (comma `,` delimited values), it defines a monotonically
+ * increasing array of bin edges, including the rightmost edge, allowing for
+ * non-uniform bin widths.
+ *
+ * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html.
+ * @param histogramRange Comma `,` delimited range of the bins.
+ *
+ * The lower and upper range of the bins. If not provided, range is simply
+ * (a.min(), a.max()).
+ *
+ * Values outside the range are ignored. The first element of the range must be
+ * less than or equal to the second.
+ * range affects the automatic bin computation as well.
+ *
+ * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @param assetExpression Per asset band expression.
+ * @param height Force output image height.
+ * @param width Force output image width.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return return dataset's statistics on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getItemAssetStatistics(String collectionId, String itemId, List bidx,
+ List assets, List assetBandIndices, String noData, Boolean unscale,
+ WarpKernelResampling reproject, Resampling resampling, Integer maxSize, Boolean categorical,
+ List categoriesPixels, List percentiles, String histogramBins, String histogramRange,
+ String subdatasetName, List subdatasetBands, String crs, String datetime, List sel,
+ SelMethod selMethod, List assetExpression, Integer height, Integer width) {
+ // Generated convenience method for getItemAssetStatisticsWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ if (bidx != null) {
+ for (int paramItemValue : bidx) {
+ requestOptions.addQueryParam("bidx", String.valueOf(paramItemValue), false);
+ }
+ }
+ if (assets != null) {
+ for (String paramItemValue : assets) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("assets", paramItemValue, false);
+ }
+ }
+ }
+ if (assetBandIndices != null) {
+ requestOptions.addQueryParam("asset_bidx",
+ assetBandIndices.stream()
+ .map(paramItemValue -> Objects.toString(paramItemValue, ""))
+ .collect(Collectors.joining(",")),
+ false);
+ }
+ if (noData != null) {
+ requestOptions.addQueryParam("nodata", noData, false);
+ }
+ if (unscale != null) {
+ requestOptions.addQueryParam("unscale", String.valueOf(unscale), false);
+ }
+ if (reproject != null) {
+ requestOptions.addQueryParam("reproject", reproject.toString(), false);
+ }
+ if (resampling != null) {
+ requestOptions.addQueryParam("resampling", resampling.toString(), false);
+ }
+ if (maxSize != null) {
+ requestOptions.addQueryParam("max_size", String.valueOf(maxSize), false);
+ }
+ if (categorical != null) {
+ requestOptions.addQueryParam("categorical", String.valueOf(categorical), false);
+ }
+ if (categoriesPixels != null) {
+ requestOptions.addQueryParam("c", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(categoriesPixels, CollectionFormat.CSV), false);
+ }
+ if (percentiles != null) {
+ requestOptions.addQueryParam("p",
+ JacksonAdapter.createDefaultSerializerAdapter().serializeIterable(percentiles, CollectionFormat.CSV),
+ false);
+ }
+ if (histogramBins != null) {
+ requestOptions.addQueryParam("histogram_bins", histogramBins, false);
+ }
+ if (histogramRange != null) {
+ requestOptions.addQueryParam("histogram_range", histogramRange, false);
+ }
+ if (subdatasetName != null) {
+ requestOptions.addQueryParam("subdataset_name", subdatasetName, false);
+ }
+ if (subdatasetBands != null) {
+ requestOptions.addQueryParam("subdataset_bands", JacksonAdapter.createDefaultSerializerAdapter()
+ .serializeIterable(subdatasetBands, CollectionFormat.CSV), false);
+ }
+ if (crs != null) {
+ requestOptions.addQueryParam("crs", crs, false);
+ }
+ if (datetime != null) {
+ requestOptions.addQueryParam("datetime", datetime, false);
+ }
+ if (sel != null) {
+ for (String paramItemValue : sel) {
+ if (paramItemValue != null) {
+ requestOptions.addQueryParam("sel", paramItemValue, false);
+ }
+ }
+ }
+ if (selMethod != null) {
+ requestOptions.addQueryParam("sel_method", selMethod.toString(), false);
+ }
+ if (assetExpression != null) {
+ requestOptions.addQueryParam("asset_expression",
+ assetExpression.stream()
+ .map(paramItemValue -> Objects.toString(paramItemValue, ""))
+ .collect(Collectors.joining(",")),
+ false);
+ }
+ if (height != null) {
+ requestOptions.addQueryParam("height", String.valueOf(height), false);
+ }
+ if (width != null) {
+ requestOptions.addQueryParam("width", String.valueOf(width), false);
+ }
+ return getItemAssetStatisticsWithResponse(collectionId, itemId, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(AssetStatisticsResponse.class));
+ }
+
+ /**
+ * Item Asset Statistics
+ *
+ * Per asset statistics for a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return return dataset's statistics on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getItemAssetStatistics(String collectionId, String itemId) {
+ // Generated convenience method for getItemAssetStatisticsWithResponse
+ RequestOptions requestOptions = new RequestOptions();
+ return getItemAssetStatisticsWithResponse(collectionId, itemId, requestOptions).flatMap(FluxUtil::toMono)
+ .map(protocolMethodData -> protocolMethodData.toObject(AssetStatisticsResponse.class));
+ }
+
+ /**
+ * Item Statistics
+ *
+ * Merged assets statistics for a STAC item.
+ *
+ * @param collectionId STAC Collection Identifier.
+ * @param itemId STAC Item Identifier.
+ * @param bidx Dataset band indexes.
+ * @param assets Asset's names.
+ * @param expression Band math expression between assets.
+ * @param assetBandIndices Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1,
+ * 2, and 3 from the asset named "image").
+ * @param assetAsBand Asset as Band.
+ * @param noData Overwrite internal Nodata value.
+ * @param unscale Apply internal Scale or Offset.
+ * @param reproject WarpKernel resampling algorithm (only used when doing re-projection). Defaults to `nearest`.
+ * @param resampling Resampling method.
+ * @param maxSize Maximum dimension in pixels for the source data used to calculate statistics.
+ * @param categorical Return statistics for categorical dataset.
+ * @param categoriesPixels List of pixel categorical values for which to report counts.
+ * @param percentiles List of percentile values (default to [2, 98]).
+ * @param histogramBins Defines the number of equal-width bins in the given range (10, by default).
+ *
+ * If bins is a sequence (comma `,` delimited values), it defines a monotonically
+ * increasing array of bin edges, including the rightmost edge, allowing for
+ * non-uniform bin widths.
+ *
+ * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html.
+ * @param histogramRange Comma `,` delimited range of the bins.
+ *
+ * The lower and upper range of the bins. If not provided, range is simply
+ * (a.min(), a.max()).
+ *
+ * Values outside the range are ignored. The first element of the range must be
+ * less than or equal to the second.
+ * range affects the automatic bin computation as well.
+ *
+ * link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html.
+ * @param subdatasetName The name of a subdataset within the asset.
+ * @param subdatasetBands The index of a subdataset band within the asset.
+ * @param crs Coordinate Reference System.
+ * @param datetime Either a date-time or an interval, open or closed. Date and time expressions
+ * adhere to RFC 3339. Open intervals are expressed using double-dots.
+ *
+ * Examples:
+ *
+ * - A date-time: "2018-02-12T23:20:50Z"
+ * - A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
+ * - Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"
+ *
+ * Only features that have a temporal property that intersects the value of
+ * `datetime` are selected.
+ *
+ * If a feature has multiple temporal properties, it is the decision of the
+ * server whether only a single temporal property is used to determine
+ * the extent or all relevant temporal properties.
+ * @param sel Xarray Indexing using dimension names `{dimension}={value}`.
+ * @param selMethod Xarray indexing method to use for inexact matches.
+ * @param algorithm Algorithm name.
+ * @param algorithmParams Algorithm parameter.
+ * @param height Force output image height.
+ * @param width Force output image width.
+ * @throws IllegalArgumentException thrown if parameters fail the validation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+ * @return return dataset's statistics on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono getItemStatistics(String collectionId, String itemId, List bidx,
+ List assets, String expression, List assetBandIndices, Boolean assetAsBand, String noData,
+ Boolean unscale, WarpKernelResampling reproject, Resampling resampling, Integer maxSize, Boolean categorical,
+ List categoriesPixels, List percentiles, String histogramBins, String histogramRange,
+ String subdatasetName, List subdatasetBands, String crs, String datetime, List