Response Body Schema
+ * + *
+ * {@code
+ * {
+ * authn_app_id: String (Required)
+ * tenant_id: String (Required)
+ * instance: String (Required)
+ * redirect_uri: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @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 auth Config
+ *
+ * Get the app id and tenant id information to make a MSAL request for this
+ * GeoCatalog instance along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * client_id: String (Required)
+ * }
+ * }
+ *
+ *
+ * @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 azmaps Client Id
+ *
+ * Fetch the client id for the Azure Maps API service based on the current
+ * on the current identity along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * token: String (Required)
+ * expires_on: int (Required)
+ * }
+ * }
+ *
+ *
+ * @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 azmaps Token
+ *
+ * Fetch a token for the Azure Maps API service based on the current
+ * service identity along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * authn_app_id: String (Required)
+ * tenant_id: String (Required)
+ * instance: String (Required)
+ * redirect_uri: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @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 auth Config
+ *
+ * Get the app id and tenant id information to make a MSAL request for this
+ * GeoCatalog instance along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * client_id: String (Required)
+ * }
+ * }
+ *
+ *
+ * @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 azmaps Client Id
+ *
+ * Fetch the client id for the Azure Maps API service based on the current
+ * on the current identity along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * token: String (Required)
+ * expires_on: int (Required)
+ * }
+ * }
+ *
+ *
+ * @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 azmaps Token
+ *
+ * Fetch a token for the Azure Maps API service based on the current
+ * service identity along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * cql (Required): {
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * 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)
+ * format: String(png/cog) (Optional)
+ * showBranding: Boolean (Optional)
+ * mask: Boolean (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection ID.
+ * @param accept The accept parameter.
+ * @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 the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection ID.
+ * @param id Image export ID.
+ * @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}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * cql (Required): {
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * 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)
+ * format: String(png/cog) (Optional)
+ * showBranding: Boolean (Optional)
+ * mask: Boolean (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection ID.
+ * @param accept The accept parameter.
+ * @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 the response body along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * BinaryData
+ * }
+ *
+ *
+ * @param collectionId STAC Collection ID.
+ * @param id Image export ID.
+ * @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}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| $top | Long | No | The number of items to return |
| $skip | Long | No | The number of items to skip |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * id: String (Required)
+ * importType: String(StaticCatalog) (Optional, Required on create)
+ * displayName: String (Optional)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * creationTime: OffsetDateTime (Required)
+ * status: String(Ready/Deleting) (Required)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @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 ingestions of a catalog along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * importType: String(StaticCatalog) (Optional, Required on create)
+ * displayName: String (Optional)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * creationTime: OffsetDateTime (Required)
+ * status: String(Ready/Deleting) (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * importType: String(StaticCatalog) (Optional, Required on create)
+ * displayName: String (Optional)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * creationTime: OffsetDateTime (Required)
+ * status: String(Ready/Deleting) (Required)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param definition Definition of the ingestion.
+ * @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 microsoft Planetary Computer Pro geo-catalog ingestion creation model along with {@link Response} on
+ * successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * importType: String(StaticCatalog) (Optional, Required on create)
+ * displayName: String (Optional)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * creationTime: OffsetDateTime (Required)
+ * status: String(Ready/Deleting) (Required)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param ingestionId Ingestion id.
+ * @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 definition of an ingestion along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * importType: String(StaticCatalog) (Optional, Required on create)
+ * displayName: String (Optional)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * creationTime: OffsetDateTime (Required)
+ * status: String(Ready/Deleting) (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * importType: String(StaticCatalog) (Optional, Required on create)
+ * displayName: String (Optional)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * creationTime: OffsetDateTime (Required)
+ * status: String(Ready/Deleting) (Required)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param ingestionId Ingestion id.
+ * @param definition Ingestion properties to update.
+ * @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 microsoft Planetary Computer Pro geo-catalog ingestion creation model along with {@link Response} on
+ * successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * type: String (Required)
+ * creationTime: OffsetDateTime (Required)
+ * collectionId: String (Optional)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * additionalInformation (Optional): {
+ * String: String (Required)
+ * }
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param ingestionId Ingestion id.
+ * @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 {@link PollerFlux} for polling of microsoft Planetary Computer Pro geo-catalog operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| $top | Long | No | The number of items to return |
| $skip | Long | No | The number of items to skip |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * id: String (Required)
+ * parentRunId: String (Optional)
+ * operation (Required): {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * creationTime: OffsetDateTime (Required)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * totalItems: int (Required)
+ * totalPendingItems: int (Required)
+ * totalSuccessfulItems: int (Required)
+ * totalFailedItems: int (Required)
+ * }
+ * creationTime: OffsetDateTime (Required)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param ingestionId Ingestion id.
+ * @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 runs of an ingestion along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * parentRunId: String (Optional)
+ * operation (Required): {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * creationTime: OffsetDateTime (Required)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * totalItems: int (Required)
+ * totalPendingItems: int (Required)
+ * totalSuccessfulItems: int (Required)
+ * totalFailedItems: int (Required)
+ * }
+ * creationTime: OffsetDateTime (Required)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param ingestionId Ingestion id.
+ * @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 microsoft Planetary Computer Pro geo-catalog ingestion run along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * parentRunId: String (Optional)
+ * operation (Required): {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * creationTime: OffsetDateTime (Required)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * totalItems: int (Required)
+ * totalPendingItems: int (Required)
+ * totalSuccessfulItems: int (Required)
+ * totalFailedItems: int (Required)
+ * }
+ * creationTime: OffsetDateTime (Required)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param ingestionId Ingestion id.
+ * @param runId Run id.
+ * @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 a run of an ingestion along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| $top | Long | No | The number of items to return |
| $skip | Long | No | The number of items to skip |
| collectionId | String | No | Operation id used to filter the results |
| status | String | No | Operation status used to filter the results. Allowed values: + * "Pending", "Running", "Succeeded", "Canceled", "Canceling", "Failed". |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * type: String (Required)
+ * creationTime: OffsetDateTime (Required)
+ * collectionId: String (Optional)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * additionalInformation (Optional): {
+ * String: String (Required)
+ * }
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @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 operations of a geo-catalog collection along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * type: String (Required)
+ * creationTime: OffsetDateTime (Required)
+ * collectionId: String (Optional)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * additionalInformation (Optional): {
+ * String: String (Required)
+ * }
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param operationId Operation id.
+ * @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 an operation of a geo-catalog collection along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| $top | Long | No | The number of items to return |
| $skip | Long | No | The number of items to skip |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * id: String (Required)
+ * importType: String(StaticCatalog) (Optional, Required on create)
+ * displayName: String (Optional)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * creationTime: OffsetDateTime (Required)
+ * status: String(Ready/Deleting) (Required)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @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 ingestions of a catalog along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * importType: String(StaticCatalog) (Optional, Required on create)
+ * displayName: String (Optional)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * creationTime: OffsetDateTime (Required)
+ * status: String(Ready/Deleting) (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * importType: String(StaticCatalog) (Optional, Required on create)
+ * displayName: String (Optional)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * creationTime: OffsetDateTime (Required)
+ * status: String(Ready/Deleting) (Required)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param definition Definition of the ingestion.
+ * @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 microsoft Planetary Computer Pro geo-catalog ingestion creation model along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * importType: String(StaticCatalog) (Optional, Required on create)
+ * displayName: String (Optional)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * creationTime: OffsetDateTime (Required)
+ * status: String(Ready/Deleting) (Required)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param ingestionId Ingestion id.
+ * @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 definition of an ingestion along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * importType: String(StaticCatalog) (Optional, Required on create)
+ * displayName: String (Optional)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * creationTime: OffsetDateTime (Required)
+ * status: String(Ready/Deleting) (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * importType: String(StaticCatalog) (Optional, Required on create)
+ * displayName: String (Optional)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * creationTime: OffsetDateTime (Required)
+ * status: String(Ready/Deleting) (Required)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param ingestionId Ingestion id.
+ * @param definition Ingestion properties to update.
+ * @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 microsoft Planetary Computer Pro geo-catalog ingestion creation model along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * type: String (Required)
+ * creationTime: OffsetDateTime (Required)
+ * collectionId: String (Optional)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * additionalInformation (Optional): {
+ * String: String (Required)
+ * }
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param ingestionId Ingestion id.
+ * @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 {@link SyncPoller} for polling of microsoft Planetary Computer Pro geo-catalog operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| $top | Long | No | The number of items to return |
| $skip | Long | No | The number of items to skip |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * id: String (Required)
+ * parentRunId: String (Optional)
+ * operation (Required): {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * creationTime: OffsetDateTime (Required)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * totalItems: int (Required)
+ * totalPendingItems: int (Required)
+ * totalSuccessfulItems: int (Required)
+ * totalFailedItems: int (Required)
+ * }
+ * creationTime: OffsetDateTime (Required)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param ingestionId Ingestion id.
+ * @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 runs of an ingestion along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * parentRunId: String (Optional)
+ * operation (Required): {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * creationTime: OffsetDateTime (Required)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * totalItems: int (Required)
+ * totalPendingItems: int (Required)
+ * totalSuccessfulItems: int (Required)
+ * totalFailedItems: int (Required)
+ * }
+ * creationTime: OffsetDateTime (Required)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param ingestionId Ingestion id.
+ * @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 microsoft Planetary Computer Pro geo-catalog ingestion run along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * parentRunId: String (Optional)
+ * operation (Required): {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * creationTime: OffsetDateTime (Required)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * totalItems: int (Required)
+ * totalPendingItems: int (Required)
+ * totalSuccessfulItems: int (Required)
+ * totalFailedItems: int (Required)
+ * }
+ * creationTime: OffsetDateTime (Required)
+ * sourceCatalogUrl: String (Optional)
+ * skipExistingItems: Boolean (Optional)
+ * keepOriginalAssets: Boolean (Optional)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param ingestionId Ingestion id.
+ * @param runId Run id.
+ * @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 a run of an ingestion along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| $top | Long | No | The number of items to return |
| $skip | Long | No | The number of items to skip |
| collectionId | String | No | Operation id used to filter the results |
| status | String | No | Operation status used to filter the results. Allowed values: + * "Pending", "Running", "Succeeded", "Canceled", "Canceling", "Failed". |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * type: String (Required)
+ * creationTime: OffsetDateTime (Required)
+ * collectionId: String (Optional)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * additionalInformation (Optional): {
+ * String: String (Required)
+ * }
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @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 operations of a geo-catalog collection along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * type: String (Required)
+ * creationTime: OffsetDateTime (Required)
+ * collectionId: String (Optional)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * additionalInformation (Optional): {
+ * String: String (Required)
+ * }
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param operationId Operation id.
+ * @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 an operation of a geo-catalog collection along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| $top | Long | No | The number of items to return |
| $skip | Long | No | The number of items to skip |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * id: String (Required)
+ * kind: String(SasToken/BlobManagedIdentity) (Required)
+ * created: OffsetDateTime (Required)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @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 ingestion sources in a geo-catalog along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * kind: String(SasToken/BlobManagedIdentity) (Required)
+ * id: String (Required)
+ * created: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * kind: String(SasToken/BlobManagedIdentity) (Required)
+ * id: String (Required)
+ * created: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ *
+ * @param ingestionSource Definition of the ingestion source.
+ * @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 ingestion Source along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * kind: String(SasToken/BlobManagedIdentity) (Required)
+ * id: String (Required)
+ * created: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ *
+ * @param id Ingestion source id.
+ * @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 an ingestion source in a geo-catalog along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * kind: String(SasToken/BlobManagedIdentity) (Required)
+ * id: String (Required)
+ * created: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * kind: String(SasToken/BlobManagedIdentity) (Required)
+ * id: String (Required)
+ * created: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ *
+ * @param id Ingestion source id.
+ * @param ingestionSource Definition of the ingestion source.
+ * @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 ingestion Source along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * objectId: String (Required)
+ * resourceId: String (Required)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @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 all managed identities with access to storage accounts configured for a geo-catalog along with
+ * {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| $top | Long | No | The number of items to return |
| $skip | Long | No | The number of items to skip |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * id: String (Required)
+ * kind: String(SasToken/BlobManagedIdentity) (Required)
+ * created: OffsetDateTime (Required)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @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 ingestion sources in a geo-catalog along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * kind: String(SasToken/BlobManagedIdentity) (Required)
+ * id: String (Required)
+ * created: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * kind: String(SasToken/BlobManagedIdentity) (Required)
+ * id: String (Required)
+ * created: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ *
+ * @param ingestionSource Definition of the ingestion source.
+ * @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 ingestion Source along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * kind: String(SasToken/BlobManagedIdentity) (Required)
+ * id: String (Required)
+ * created: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ *
+ * @param id Ingestion source id.
+ * @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 an ingestion source in a geo-catalog along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * kind: String(SasToken/BlobManagedIdentity) (Required)
+ * id: String (Required)
+ * created: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * kind: String(SasToken/BlobManagedIdentity) (Required)
+ * id: String (Required)
+ * created: OffsetDateTime (Required)
+ * }
+ * }
+ *
+ *
+ * @param id Ingestion source id.
+ * @param ingestionSource Definition of the ingestion source.
+ * @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 ingestion Source along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * objectId: String (Required)
+ * resourceId: String (Required)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @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 all managed identities with access to storage accounts configured for a geo-catalog along with
+ * {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery 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
+ * {
+ * (Optional): {
+ * String (Required): [
+ * long (Required)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @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 classmap Legend
+ *
+ * Generate values and color swatches mapping for a given classmap.
+ *
+ * Args:
+ * trim_start (int, optional): Number of items to trim
+ * from the start of the cmap
+ * trim_end (int, optional): Number of items to trim from the end of the cmap 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
+ * BinaryData
+ * }
+ *
+ *
+ * @param cmapName 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 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.
+ *
+ * Args:
+ * cmap_name (string): The name of the registered colormap to generate
+ * a legend for
+ * height (float, optional): The output height of the legend image
+ * width (float, optional): The output width of the legend image
+ * trim_start (int, optional): Number of items to trim from
+ * the start of the cmap
+ * trim_end (int, optional): Number of items to trim from the end of the cmap
+ *
+ * Returns:
+ * HTTP response with jpeg encoded image data along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ 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
+ * [
+ * (Required)[
+ * BinaryData (Required)
+ * ]
+ * ]
+ * }
+ *
+ *
+ * @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 interval Legend
+ *
+ * Generate values and color swatches mapping for a given interval classmap.
+ *
+ * Args:
+ * trim_start (int, optional): Number of items to trim from
+ * the start of the cmap
+ * trim_end (int, optional): Number of items to trim from the end of the cmap along with {@link Response} on
+ * successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ 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
+ * {
+ * (Optional): {
+ * String (Required): [
+ * long (Required)
+ * ]
+ * }
+ * }
+ * }
+ *
+ *
+ * @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 classmap Legend
+ *
+ * Generate values and color swatches mapping for a given classmap.
+ *
+ * Args:
+ * trim_start (int, optional): Number of items to trim
+ * from the start of the cmap
+ * trim_end (int, optional): Number of items to trim from the end of the cmap along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery 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
+ * BinaryData
+ * }
+ *
+ *
+ * @param cmapName 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 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.
+ *
+ * Args:
+ * cmap_name (string): The name of the registered colormap to generate
+ * a legend for
+ * height (float, optional): The output height of the legend image
+ * width (float, optional): The output width of the legend image
+ * trim_start (int, optional): Number of items to trim from
+ * the start of the cmap
+ * trim_end (int, optional): Number of items to trim from the end of the cmap
+ *
+ * Returns:
+ * HTTP response with jpeg encoded image data along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery 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
+ * [
+ * (Required)[
+ * BinaryData (Required)
+ * ]
+ * ]
+ * }
+ *
+ *
+ * @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 interval Legend
+ *
+ * Generate values and color swatches mapping for a given interval classmap.
+ *
+ * Args:
+ * trim_start (int, optional): Number of items to trim from
+ * the start of the cmap
+ * trim_end (int, optional): Number of items to trim from the end of the cmap along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery 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 | List<String> | No | Per asset band indexes (coma separated indexes). + * In the form of "," separated string. |
| asset_as_band | Boolean | No | Asset as Band |
| nodata | Double | 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). |
| algorithm | String | No | Algorithm name. Allowed values: "hillshade", "contours", + * "normalizedIndex", "terrarium", "terrainrgb". |
| algorithm_params | String | No | Algorithm parameter |
| 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 | 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) |
| 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", "lastbandhight". |
| 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. |
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 (default: "1").
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp) (default: "png").
+ * @param accept The accept 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 the response body 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 | List<String> | No | Per asset band indexes (coma separated indexes). + * In the form of "," separated string. |
| asset_as_band | Boolean | No | Asset as Band |
| nodata | Double | 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). |
| algorithm | String | No | Algorithm name. Allowed values: "hillshade", "contours", + * "normalizedIndex", "terrarium", "terrainrgb". |
| algorithm_params | String | No | Algorithm parameter |
| 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) |
| 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", "lastbandhight". |
| 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. |
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 (default: "1").
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp) (default: "png").
+ * @param accept The accept 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 the response body 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 | List<String> | No | Per asset band indexes (coma separated indexes). + * In the form of "," separated string. |
| asset_as_band | Boolean | No | Asset as Band |
| nodata | Double | 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). |
| 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", "lastbandhight". |
| algorithm | String | No | Algorithm name. Allowed values: "hillshade", "contours", + * "normalizedIndex", "terrarium", "terrainrgb". |
| algorithm_params | String | No | Algorithm parameter |
| 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. |
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 model.
+ *
+ * Based on https://github.com/mapbox/tilejson-spec/tree/master/2.2.0TileJSON metadata describing a tile set
+ * according to the TileJSON specification 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 | List<String> | No | Per asset band indexes (coma separated indexes). + * In the form of "," separated string. |
| asset_as_band | Boolean | No | Asset as Band |
| nodata | Double | 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). |
| algorithm | String | No | Algorithm name. Allowed values: "hillshade", "contours", + * "normalizedIndex", "terrarium", "terrainrgb". |
| algorithm_params | String | No | Algorithm parameter |
| 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 | 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) |
| 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", "lastbandhight". |
| 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. |
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 model.
+ *
+ * Based on https://github.com/mapbox/tilejson-spec/tree/master/2.2.0TileJSON metadata describing a tile set
+ * according to the TileJSON specification 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 | List<String> | No | Per asset band indexes (coma separated indexes). + * In the form of "," separated string. |
| 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 | Algorithm name. Allowed values: "hillshade", "contours", + * "normalizedIndex", "terrarium", "terrainrgb". |
| algorithm_params | String | No | Algorithm parameter |
| 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 + * `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". |
| colormap | String | No | JSON encoded custom Colormap |
| return_mask | Boolean | No | Add mask to the output data. |
Response Body Schema
+ * + *
+ * {@code
+ * String
+ * }
+ *
+ *
+ * @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 a sequence of textual characters 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 | List<String> | No | Per asset band indexes (coma separated indexes). + * In the form of "," separated string. |
| 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 | Algorithm name. Allowed values: "hillshade", "contours", + * "normalizedIndex", "terrarium", "terrainrgb". |
| algorithm_params | String | No | Algorithm parameter |
| 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) |
| 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". |
| colormap | String | No | JSON encoded custom Colormap |
| return_mask | Boolean | No | Add mask to the output data. |
Response Body Schema
+ * + *
+ * {@code
+ * String
+ * }
+ *
+ *
+ * @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 a sequence of textual characters along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * collections (Optional): [
+ * String (Optional)
+ * ]
+ * ids (Optional): [
+ * String (Optional)
+ * ]
+ * bbox: Double (Optional)
+ * intersects (Optional): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * query (Optional): {
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * filter: String (Optional)
+ * 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)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@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: BinaryData (Required)
+ * }
+ * merge: Boolean (Optional)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param registerSearchRequest The registerSearchRequest 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 MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * search (Required): {
+ * hash: String (Required)
+ * search (Required): {
+ * (Optional): {
+ * String: BinaryData (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)
+ * ]
+ * 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 MonoQuery 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). |
| 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". |
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 MonoQuery 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). |
Response Body Schema
+ * + *
+ * {@code
+ * [
+ * BinaryData (Required)
+ * ]
+ * }
+ *
+ *
+ * @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 MonoQuery 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`. |
Response Body Schema
+ * + *
+ * {@code
+ * [
+ * BinaryData (Required)
+ * ]
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param lon Longitude.
+ * @param lat 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 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 | List<String> | No | Per asset band indexes (coma separated indexes). + * In the form of "," separated string. |
| asset_as_band | Boolean | No | Asset as Band |
| nodata | Double | 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). |
| algorithm | String | No | Algorithm name. Allowed values: "hillshade", "contours", + * "normalizedIndex", "terrarium", "terrainrgb". |
| algorithm_params | String | No | Algorithm parameter |
| 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 | 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) |
| 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", "lastbandhight". |
| 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. |
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 (default: "1").
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp) (default: "png").
+ * @param accept The accept 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 the response body along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery 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 | List<String> | No | Per asset band indexes (coma separated indexes). + * In the form of "," separated string. |
| asset_as_band | Boolean | No | Asset as Band |
| nodata | Double | 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). |
| algorithm | String | No | Algorithm name. Allowed values: "hillshade", "contours", + * "normalizedIndex", "terrarium", "terrainrgb". |
| algorithm_params | String | No | Algorithm parameter |
| 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) |
| 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", "lastbandhight". |
| 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. |
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 (default: "1").
+ * @param format Output format for the tile or image (e.g., png, jpeg, webp) (default: "png").
+ * @param accept The accept 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 the response body along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery 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 | List<String> | No | Per asset band indexes (coma separated indexes). + * In the form of "," separated string. |
| asset_as_band | Boolean | No | Asset as Band |
| nodata | Double | 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). |
| 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", "lastbandhight". |
| algorithm | String | No | Algorithm name. Allowed values: "hillshade", "contours", + * "normalizedIndex", "terrarium", "terrainrgb". |
| algorithm_params | String | No | Algorithm parameter |
| 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. |
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 model.
+ *
+ * Based on https://github.com/mapbox/tilejson-spec/tree/master/2.2.0TileJSON metadata describing a tile set
+ * according to the TileJSON specification along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery 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 | List<String> | No | Per asset band indexes (coma separated indexes). + * In the form of "," separated string. |
| asset_as_band | Boolean | No | Asset as Band |
| nodata | Double | 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). |
| algorithm | String | No | Algorithm name. Allowed values: "hillshade", "contours", + * "normalizedIndex", "terrarium", "terrainrgb". |
| algorithm_params | String | No | Algorithm parameter |
| 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 | 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) |
| 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", "lastbandhight". |
| 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. |
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 model.
+ *
+ * Based on https://github.com/mapbox/tilejson-spec/tree/master/2.2.0TileJSON metadata describing a tile set
+ * according to the TileJSON specification along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery 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 | List<String> | No | Per asset band indexes (coma separated indexes). + * In the form of "," separated string. |
| 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 | Algorithm name. Allowed values: "hillshade", "contours", + * "normalizedIndex", "terrarium", "terrainrgb". |
| algorithm_params | String | No | Algorithm parameter |
| 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 + * `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". |
| colormap | String | No | JSON encoded custom Colormap |
| return_mask | Boolean | No | Add mask to the output data. |
Response Body Schema
+ * + *
+ * {@code
+ * String
+ * }
+ *
+ *
+ * @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 a sequence of textual characters along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery 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 | List<String> | No | Per asset band indexes (coma separated indexes). + * In the form of "," separated string. |
| 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 | Algorithm name. Allowed values: "hillshade", "contours", + * "normalizedIndex", "terrarium", "terrainrgb". |
| algorithm_params | String | No | Algorithm parameter |
| 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) |
| 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". |
| colormap | String | No | JSON encoded custom Colormap |
| return_mask | Boolean | No | Add mask to the output data. |
Response Body Schema
+ * + *
+ * {@code
+ * String
+ * }
+ *
+ *
+ * @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 a sequence of textual characters along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * collections (Optional): [
+ * String (Optional)
+ * ]
+ * ids (Optional): [
+ * String (Optional)
+ * ]
+ * bbox: Double (Optional)
+ * intersects (Optional): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * query (Optional): {
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * filter: String (Optional)
+ * 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)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@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: BinaryData (Required)
+ * }
+ * merge: Boolean (Optional)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param registerSearchRequest The registerSearchRequest 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}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * search (Required): {
+ * hash: String (Required)
+ * search (Required): {
+ * (Optional): {
+ * String: BinaryData (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)
+ * ]
+ * 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}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery 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). |
| 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". |
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}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery 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). |
Response Body Schema
+ * + *
+ * {@code
+ * [
+ * BinaryData (Required)
+ * ]
+ * }
+ *
+ *
+ * @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}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery 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`. |
Response Body Schema
+ * + *
+ * {@code
+ * [
+ * BinaryData (Required)
+ * ]
+ * }
+ *
+ *
+ * @param searchId Search Id (pgSTAC Search Hash).
+ * @param lon Longitude.
+ * @param lat 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}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| duration | Long | No | Duration + * + * The duration, in minutes, that the SAS token will be valid. Only valid for approved users. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * msft:expiry: OffsetDateTime (Required)
+ * token: String (Required)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Collection Id
+ *
+ * The name of the Collection that the SAS token will be issued 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 sasToken along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| duration | Long | No | Duration + * + * The duration, in minutes, that the SAS token will be valid. Only valid for approved users. |
Query Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| duration | Long | No | Duration + * + * The duration, in minutes, that the SAS token will be valid. Only valid for approved users. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * msft:expiry: OffsetDateTime (Optional)
+ * href: String (Required)
+ * }
+ * }
+ *
+ *
+ * @param href Href
+ *
+ * HREF (URL) to sign.
+ * @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 unsignedLink along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| duration | Long | No | Duration + * + * The duration, in minutes, that the SAS token will be valid. Only valid for approved users. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * msft:expiry: OffsetDateTime (Required)
+ * token: String (Required)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Collection Id
+ *
+ * The name of the Collection that the SAS token will be issued 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 sasToken along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| duration | Long | No | Duration + * + * The duration, in minutes, that the SAS token will be valid. Only valid for approved users. |
Query Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| duration | Long | No | Duration + * + * The duration, in minutes, that the SAS token will be valid. Only valid for approved users. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * msft:expiry: OffsetDateTime (Optional)
+ * href: String (Required)
+ * }
+ * }
+ *
+ *
+ * @param href Href
+ *
+ * HREF (URL) to sign.
+ * @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 unsignedLink along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * msft:_created: String (Optional)
+ * msft:_updated: String (Optional)
+ * msft:short_description: String (Optional)
+ * stac_extensions (Optional): [
+ * String (Optional)
+ * ]
+ * id: String (Required)
+ * description: String (Required)
+ * title: String (Optional)
+ * stac_version: String (Optional)
+ * conformsTo (Required): [
+ * String (Required)
+ * ]
+ * links (Required): [
+ * (Required){
+ * 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)
+ * }
+ * ]
+ * type: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @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 https://github.com/radiantearth/stac-api-spec/blob/master/api-spec.md#ogc-api---features-endpoints
+ *
+ * Represents the STAC API landing page with links to available resources along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| sign | String | No | Whether to sign asset URLs in the response. Allowed values: + * "true", "false". |
| duration | Integer | No | URL signature duration in seconds. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * links (Required): [
+ * (Required){
+ * 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)
+ * }
+ * ]
+ * collections (Required): [
+ * (Required){
+ * msft:_created: String (Optional)
+ * msft:_updated: String (Optional)
+ * msft:short_description: String (Optional)
+ * stac_extensions (Optional): [
+ * String (Optional)
+ * ]
+ * id: String (Required)
+ * description: String (Required)
+ * stac_version: String (Optional)
+ * links (Required): [
+ * (recursive schema, see above)
+ * ]
+ * title: String (Optional)
+ * type: String (Optional)
+ * assets (Optional): {
+ * 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)
+ * }
+ * }
+ * }
+ * license: String (Required)
+ * extent (Required): {
+ * spatial (Required): {
+ * bbox (Optional): [
+ * (Optional)[
+ * double (Optional)
+ * ]
+ * ]
+ * }
+ * temporal (Required): {
+ * interval (Required): [
+ * (Required)[
+ * String (Required)
+ * ]
+ * ]
+ * }
+ * }
+ * keywords (Optional): [
+ * String (Optional)
+ * ]
+ * providers (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * summaries (Optional): {
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @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 collections
+ *
+ * Endpoint along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * msft:_created: String (Optional)
+ * msft:_updated: String (Optional)
+ * msft:short_description: String (Optional)
+ * stac_extensions (Optional): [
+ * String (Optional)
+ * ]
+ * id: String (Required)
+ * description: String (Required)
+ * stac_version: String (Optional)
+ * links (Required): [
+ * (Required){
+ * 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)
+ * }
+ * ]
+ * title: String (Optional)
+ * type: String (Optional)
+ * assets (Optional): {
+ * 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)
+ * }
+ * }
+ * }
+ * license: String (Required)
+ * extent (Required): {
+ * spatial (Required): {
+ * bbox (Optional): [
+ * (Optional)[
+ * double (Optional)
+ * ]
+ * ]
+ * }
+ * temporal (Required): {
+ * interval (Required): [
+ * (Required)[
+ * String (Required)
+ * ]
+ * ]
+ * }
+ * }
+ * keywords (Optional): [
+ * String (Optional)
+ * ]
+ * providers (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * summaries (Optional): {
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * type: String (Required)
+ * creationTime: OffsetDateTime (Required)
+ * collectionId: String (Optional)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * additionalInformation (Optional): {
+ * String: String (Required)
+ * }
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param body Request collection 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 {@link PollerFlux} for polling of microsoft Planetary Computer Pro geo-catalog operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| sign | String | No | Whether to sign asset URLs in the response. Allowed values: + * "true", "false". |
| duration | Integer | No | URL signature duration in seconds. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * msft:_created: String (Optional)
+ * msft:_updated: String (Optional)
+ * msft:short_description: String (Optional)
+ * stac_extensions (Optional): [
+ * String (Optional)
+ * ]
+ * id: String (Required)
+ * description: String (Required)
+ * stac_version: String (Optional)
+ * links (Required): [
+ * (Required){
+ * 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)
+ * }
+ * ]
+ * title: String (Optional)
+ * type: String (Optional)
+ * assets (Optional): {
+ * 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)
+ * }
+ * }
+ * }
+ * license: String (Required)
+ * extent (Required): {
+ * spatial (Required): {
+ * bbox (Optional): [
+ * (Optional)[
+ * double (Optional)
+ * ]
+ * ]
+ * }
+ * temporal (Required): {
+ * interval (Required): [
+ * (Required)[
+ * String (Required)
+ * ]
+ * ]
+ * }
+ * }
+ * keywords (Optional): [
+ * String (Optional)
+ * ]
+ * providers (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * summaries (Optional): {
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param collectionId Unique identifier for the collection.
+ * @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 collection
+ *
+ * Get a collection in the GeoCatalog instance along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * msft:_created: String (Optional)
+ * msft:_updated: String (Optional)
+ * msft:short_description: String (Optional)
+ * stac_extensions (Optional): [
+ * String (Optional)
+ * ]
+ * id: String (Required)
+ * description: String (Required)
+ * stac_version: String (Optional)
+ * links (Required): [
+ * (Required){
+ * 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)
+ * }
+ * ]
+ * title: String (Optional)
+ * type: String (Optional)
+ * assets (Optional): {
+ * 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)
+ * }
+ * }
+ * }
+ * license: String (Required)
+ * extent (Required): {
+ * spatial (Required): {
+ * bbox (Optional): [
+ * (Optional)[
+ * double (Optional)
+ * ]
+ * ]
+ * }
+ * temporal (Required): {
+ * interval (Required): [
+ * (Required)[
+ * String (Required)
+ * ]
+ * ]
+ * }
+ * }
+ * keywords (Optional): [
+ * String (Optional)
+ * ]
+ * providers (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * summaries (Optional): {
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * type: String (Required)
+ * creationTime: OffsetDateTime (Required)
+ * collectionId: String (Optional)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * additionalInformation (Optional): {
+ * String: String (Required)
+ * }
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param body Request collection 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 {@link PollerFlux} for polling of microsoft Planetary Computer Pro geo-catalog operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * type: String (Required)
+ * creationTime: OffsetDateTime (Required)
+ * collectionId: String (Optional)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * additionalInformation (Optional): {
+ * String: String (Required)
+ * }
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @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 {@link PollerFlux} for polling of microsoft Planetary Computer Pro geo-catalog operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| limit | Long | No | The optional limit parameter recommends the number of items that + * should be present in the response document. + * + * If the limit parameter value is greater than advertised limit maximum, the server must return the + * maximum possible number of items, rather than responding with an error. + * + * Only items are counted that are on the first level of the collection in the response document. + * Nested objects contained within the explicitly requested items must not be counted. + * + * Minimum = 1. Maximum = 10000. Default = 10. |
| bbox | List<String> | No | Only features that have a geometry that intersects the + * bounding box are selected. + * The bounding box is provided as four or six numbers, depending on whether the + * coordinate reference system includes a vertical axis (height or depth): + * + * - Lower left corner, coordinate axis 1 + * - Lower left corner, coordinate axis 2 + * - Minimum value, coordinate axis 3 (optional) + * - Upper right corner, coordinate axis 1 + * - Upper right corner, coordinate axis 2 + * - Maximum value, coordinate axis 3 (optional) + * + * The coordinate reference system of the values is WGS 84 longitude/latitude + * (http://www.opengis.net/def/crs/OGC/1.3/CRS84). + * + * For WGS 84 longitude/latitude the values are in most cases the sequence of + * minimum longitude, minimum latitude, maximum longitude and maximum latitude. + * However, in cases where the box spans the antimeridian the first value + * (west-most box edge) is larger than the third value (east-most box edge). + * + * If the vertical axis is included, the third and the sixth number are + * the bottom and the top of the 3-dimensional bounding box. + * + * If a feature has multiple spatial geometry properties, it is the decision of the + * server whether only a single spatial geometry property is used to determine + * the extent or all relevant geometries. Call {@link RequestOptions#addQueryParam} to add string to + * array. |
| 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. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * type: String(Feature/FeatureCollection) (Required)
+ * stac_version: String (Optional)
+ * 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)
+ * }
+ * ]
+ * msft:_created: String (Optional)
+ * msft:_updated: String (Optional)
+ * msft:short_description: String (Optional)
+ * stac_extensions (Optional): [
+ * String (Optional)
+ * ]
+ * features (Optional, Required on create): [
+ * (Optional, Required on create){
+ * type: String(Feature/FeatureCollection) (Required)
+ * stac_version: String (Optional)
+ * links (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * msft:_created: String (Optional)
+ * msft:_updated: String (Optional)
+ * msft:short_description: String (Optional)
+ * stac_extensions (Optional): [
+ * String (Optional)
+ * ]
+ * geometry (Optional, Required on create): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * bbox (Optional, Required on create): [
+ * double (Optional, Required on create)
+ * ]
+ * id: String (Required)
+ * collection: String (Optional)
+ * properties (Optional, Required on create): {
+ * 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)
+ * datetime: String (Optional, Required on create)
+ * start_datetime: OffsetDateTime (Optional)
+ * end_datetime: OffsetDateTime (Optional)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * assets (Optional, Required on create): {
+ * String (Required): {
+ * platform: String (Optional)
+ * instruments (Optional): [
+ * String (Optional)
+ * ]
+ * constellation: String (Optional)
+ * mission: String (Optional)
+ * providers (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * 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)
+ * }
+ * }
+ * }
+ * _msft:ts: String (Optional)
+ * _msft:etag: String (Optional)
+ * }
+ * ]
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * context (Optional): {
+ * returned: int (Optional, Required on create)
+ * limit: Integer (Optional)
+ * matched: Integer (Optional)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @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 https://github.com/radiantearth/stac-spec/blob/v1.0.0/item-spec/itemcollection-spec.md
+ *
+ * Represents a collection of STAC Items as a GeoJSON FeatureCollection along with {@link Response} on successful
+ * completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * type: String(Feature/FeatureCollection) (Required)
+ * stac_version: String (Optional)
+ * 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)
+ * }
+ * ]
+ * msft:_created: String (Optional)
+ * msft:_updated: String (Optional)
+ * msft:short_description: String (Optional)
+ * stac_extensions (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * type: String (Required)
+ * creationTime: OffsetDateTime (Required)
+ * collectionId: String (Optional)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * additionalInformation (Optional): {
+ * String: String (Required)
+ * }
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param body STAC Item or ItemCollection
+ *
+ * Represents a STAC Item or ItemCollectionModel as defined by the STAC 1.0.0 standard.
+ *
+ * **Item**: A GeoJSON Feature that represents a single spatiotemporal asset.
+ * It includes metadata such as geometry, datetime, and links to related assets.
+ * Example: A satellite image with its metadata.
+ *
+ * **ItemCollectionModel**: A GeoJSON FeatureCollection that contains multiple Items.
+ * It is used to group multiple related Items together, such as a collection of satellite images.
+ *
+ * This union allows the request body to accept either a single Item or a collection of Items.
+ * @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 {@link PollerFlux} for polling of microsoft Planetary Computer Pro geo-catalog operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * type: String(Feature/FeatureCollection) (Required)
+ * stac_version: String (Optional)
+ * 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)
+ * }
+ * ]
+ * msft:_created: String (Optional)
+ * msft:_updated: String (Optional)
+ * msft:short_description: String (Optional)
+ * stac_extensions (Optional): [
+ * String (Optional)
+ * ]
+ * geometry (Optional, Required on create): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * bbox (Optional, Required on create): [
+ * double (Optional, Required on create)
+ * ]
+ * id: String (Required)
+ * collection: String (Optional)
+ * properties (Optional, Required on create): {
+ * 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)
+ * datetime: String (Optional, Required on create)
+ * start_datetime: OffsetDateTime (Optional)
+ * end_datetime: OffsetDateTime (Optional)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * assets (Optional, Required on create): {
+ * String (Required): {
+ * platform: String (Optional)
+ * instruments (Optional): [
+ * String (Optional)
+ * ]
+ * constellation: String (Optional)
+ * mission: String (Optional)
+ * providers (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * 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)
+ * }
+ * }
+ * }
+ * _msft:ts: String (Optional)
+ * _msft:etag: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param itemId STAC Item id.
+ * @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 represents a STAC Item, which is a GeoJSON Feature with additional metadata along with {@link Response}
+ * on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * type: String(Feature/FeatureCollection) (Required)
+ * stac_version: String (Optional)
+ * 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)
+ * }
+ * ]
+ * msft:_created: String (Optional)
+ * msft:_updated: String (Optional)
+ * msft:short_description: String (Optional)
+ * stac_extensions (Optional): [
+ * String (Optional)
+ * ]
+ * geometry (Optional, Required on create): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * bbox (Optional, Required on create): [
+ * double (Optional, Required on create)
+ * ]
+ * id: String (Required)
+ * collection: String (Optional)
+ * properties (Optional, Required on create): {
+ * 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)
+ * datetime: String (Optional, Required on create)
+ * start_datetime: OffsetDateTime (Optional)
+ * end_datetime: OffsetDateTime (Optional)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * assets (Optional, Required on create): {
+ * String (Required): {
+ * platform: String (Optional)
+ * instruments (Optional): [
+ * String (Optional)
+ * ]
+ * constellation: String (Optional)
+ * mission: String (Optional)
+ * providers (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * 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)
+ * }
+ * }
+ * }
+ * _msft:ts: String (Optional)
+ * _msft:etag: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * type: String (Required)
+ * creationTime: OffsetDateTime (Required)
+ * collectionId: String (Optional)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * additionalInformation (Optional): {
+ * String: String (Required)
+ * }
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param itemId STAC Item id.
+ * @param body STAC Item.
+ * @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 {@link PollerFlux} for polling of microsoft Planetary Computer Pro geo-catalog operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * type: String(Feature/FeatureCollection) (Required)
+ * stac_version: String (Optional)
+ * 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)
+ * }
+ * ]
+ * msft:_created: String (Optional)
+ * msft:_updated: String (Optional)
+ * msft:short_description: String (Optional)
+ * stac_extensions (Optional): [
+ * String (Optional)
+ * ]
+ * geometry (Optional, Required on create): {
+ * type: String(Point/LineString/Polygon/MultiPoint/MultiLineString/MultiPolygon) (Required)
+ * bbox (Optional): [
+ * double (Optional)
+ * ]
+ * }
+ * bbox (Optional, Required on create): [
+ * double (Optional, Required on create)
+ * ]
+ * id: String (Required)
+ * collection: String (Optional)
+ * properties (Optional, Required on create): {
+ * 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)
+ * datetime: String (Optional, Required on create)
+ * start_datetime: OffsetDateTime (Optional)
+ * end_datetime: OffsetDateTime (Optional)
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * assets (Optional, Required on create): {
+ * String (Required): {
+ * platform: String (Optional)
+ * instruments (Optional): [
+ * String (Optional)
+ * ]
+ * constellation: String (Optional)
+ * mission: String (Optional)
+ * providers (Optional): [
+ * (recursive schema, see above)
+ * ]
+ * 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)
+ * }
+ * }
+ * }
+ * _msft:ts: String (Optional)
+ * _msft:etag: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * type: String (Required)
+ * creationTime: OffsetDateTime (Required)
+ * collectionId: String (Optional)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * additionalInformation (Optional): {
+ * String: String (Required)
+ * }
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param itemId STAC Item id.
+ * @param body STAC Item.
+ * @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 {@link PollerFlux} for polling of microsoft Planetary Computer Pro geo-catalog operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * type: String (Required)
+ * creationTime: OffsetDateTime (Required)
+ * collectionId: String (Optional)
+ * statusHistory (Required): [
+ * (Required){
+ * timestamp: OffsetDateTime (Required)
+ * status: String(Pending/Running/Succeeded/Canceled/Canceling/Failed) (Required)
+ * errorCode: String (Optional)
+ * errorMessage: String (Optional)
+ * }
+ * ]
+ * startTime: OffsetDateTime (Optional)
+ * finishTime: OffsetDateTime (Optional)
+ * additionalInformation (Optional): {
+ * String: String (Required)
+ * }
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param collectionId Catalog collection id.
+ * @param itemId STAC Item id.
+ * @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 {@link PollerFlux} for polling of microsoft Planetary Computer Pro geo-catalog operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @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 jSON Schema structure for STAC Queryables along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono