Class ScenesAsyncClient

java.lang.Object
com.azure.verticals.agrifood.farming.ScenesAsyncClient

public final class ScenesAsyncClient extends Object
Initializes a new instance of the asynchronous FarmBeatsClient type.
  • Method Summary

    Modifier and Type
    Method
    Description
    com.azure.core.util.polling.PollerFlux<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData>
    beginCreateSatelliteDataIngestionJob(String jobId, com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)
    Create a satellite data ingestion job.
    Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
    downloadWithResponse(String filePath, com.azure.core.http.rest.RequestOptions requestOptions)
    Downloads and returns file Stream as response for the given input filePath.
    Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
    getSatelliteDataIngestionJobDetailsWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
    Get a satellite data ingestion job.
    Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
    getStacFeatureWithResponse(String collectionId, String featureId, com.azure.core.http.rest.RequestOptions requestOptions)
    Get a feature(SpatioTemporal Asset Catalog (STAC) Item) for given collection and feature id.
    com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData>
    list(String provider, String partyId, String boundaryId, String source, com.azure.core.http.rest.RequestOptions requestOptions)
    Returns a paginated list of scene resources.
    Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>>
    searchFeaturesWithResponse(String collectionId, com.azure.core.util.BinaryData searchFeaturesQuery, com.azure.core.http.rest.RequestOptions requestOptions)
    Search for STAC features by collection id, bbox, intersecting geometry, start and end datetime.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Method Details

    • list

      public com.azure.core.http.rest.PagedFlux<com.azure.core.util.BinaryData> list(String provider, String partyId, String boundaryId, String source, com.azure.core.http.rest.RequestOptions requestOptions)
      Returns a paginated list of scene resources.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      startDateTimeOffsetDateTimeNoScene start UTC datetime (inclusive), sample format: yyyy-MM-ddThh:mm:ssZ.
      endDateTimeOffsetDateTimeNoScene end UTC datetime (inclusive), sample format: yyyy-MM-dThh:mm:ssZ.
      maxCloudCoveragePercentageDoubleNoFilter scenes with cloud coverage percentage less than max value. Range [0 to 100.0].
      maxDarkPixelCoveragePercentageDoubleNoFilter scenes with dark pixel coverage percentage less than max value. Range [0 to 100.0].
      imageNamesList<String>NoList of image names to be filtered. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      imageResolutionsList<Double>NoList of image resolutions in meters to be filtered. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      imageFormatsList<String>NoList of image formats to be filtered. Call RequestOptions.addQueryParam(java.lang.String, java.lang.String) to add string to array.
      maxPageSizeIntegerNoMaximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
      skipTokenStringNoSkip token for getting next set of results.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

      
       {
           sceneDateTime: OffsetDateTime (Optional)
           provider: String (Optional)
           source: String (Optional)
           imageFiles (Optional): [
                (Optional){
                   fileLink: String (Optional)
                   name: String (Required)
                   imageFormat: String(TIF) (Optional)
                   resolution: Double (Optional)
               }
           ]
           imageFormat: String(TIF) (Optional)
           cloudCoverPercentage: Double (Optional)
           darkPixelPercentage: Double (Optional)
           ndviMedianValue: Double (Optional)
           boundaryId: String (Optional)
           partyId: String (Optional)
           id: String (Optional)
           eTag: String (Optional)
       }
       
      Parameters:
      provider - Provider name of scene data.
      partyId - PartyId.
      boundaryId - BoundaryId.
      source - Source name of scene data, Available Values: Sentinel_2_L2A, Sentinel_2_L1C.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged response contains list of requested objects and a URL link to get the next set of results as paginated response with PagedFlux.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • downloadWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> downloadWithResponse(String filePath, com.azure.core.http.rest.RequestOptions requestOptions)
      Downloads and returns file Stream as response for the given input filePath.

      Response Body Schema

      
       BinaryData
       
      Parameters:
      filePath - cloud storage path of scene file.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the response body along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • beginCreateSatelliteDataIngestionJob

      public com.azure.core.util.polling.PollerFlux<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginCreateSatelliteDataIngestionJob(String jobId, com.azure.core.util.BinaryData job, com.azure.core.http.rest.RequestOptions requestOptions)
      Create a satellite data ingestion job.

      Request Body Schema

      
       {
           partyId: String (Required)
           boundaryId: String (Required)
           startDateTime: OffsetDateTime (Required)
           endDateTime: OffsetDateTime (Required)
           provider: String(Microsoft) (Optional)
           source: String(Sentinel_2_L2A/Sentinel_2_L1C) (Required)
           data (Optional): {
               imageNames (Optional): [
                   String (Optional)
               ]
               imageFormats (Optional): [
                   String (Optional)
               ]
               imageResolutions (Optional): [
                   double (Optional)
               ]
           }
           id: String (Optional)
           status: String (Optional)
           durationInSeconds: Double (Optional)
           message: String (Optional)
           errorCode: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           lastActionDateTime: OffsetDateTime (Optional)
           startTime: OffsetDateTime (Optional)
           endTime: OffsetDateTime (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       

      Response Body Schema

      
       {
           partyId: String (Required)
           boundaryId: String (Required)
           startDateTime: OffsetDateTime (Required)
           endDateTime: OffsetDateTime (Required)
           provider: String(Microsoft) (Optional)
           source: String(Sentinel_2_L2A/Sentinel_2_L1C) (Required)
           data (Optional): {
               imageNames (Optional): [
                   String (Optional)
               ]
               imageFormats (Optional): [
                   String (Optional)
               ]
               imageResolutions (Optional): [
                   double (Optional)
               ]
           }
           id: String (Optional)
           status: String (Optional)
           durationInSeconds: Double (Optional)
           message: String (Optional)
           errorCode: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           lastActionDateTime: OffsetDateTime (Optional)
           startTime: OffsetDateTime (Optional)
           endTime: OffsetDateTime (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       
      Parameters:
      jobId - JobId provided by user.
      job - Job parameters supplied by user.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the PollerFlux for polling of schema of satellite data ingestion job.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • getSatelliteDataIngestionJobDetailsWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getSatelliteDataIngestionJobDetailsWithResponse(String jobId, com.azure.core.http.rest.RequestOptions requestOptions)
      Get a satellite data ingestion job.

      Response Body Schema

      
       {
           partyId: String (Required)
           boundaryId: String (Required)
           startDateTime: OffsetDateTime (Required)
           endDateTime: OffsetDateTime (Required)
           provider: String(Microsoft) (Optional)
           source: String(Sentinel_2_L2A/Sentinel_2_L1C) (Required)
           data (Optional): {
               imageNames (Optional): [
                   String (Optional)
               ]
               imageFormats (Optional): [
                   String (Optional)
               ]
               imageResolutions (Optional): [
                   double (Optional)
               ]
           }
           id: String (Optional)
           status: String (Optional)
           durationInSeconds: Double (Optional)
           message: String (Optional)
           errorCode: String (Optional)
           createdDateTime: OffsetDateTime (Optional)
           lastActionDateTime: OffsetDateTime (Optional)
           startTime: OffsetDateTime (Optional)
           endTime: OffsetDateTime (Optional)
           name: String (Optional)
           description: String (Optional)
           createdBy: String (Optional)
           modifiedBy: String (Optional)
           properties (Optional): {
               String: Object (Optional)
           }
       }
       
      Parameters:
      jobId - Id of the job.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      a satellite data ingestion job along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • searchFeaturesWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> searchFeaturesWithResponse(String collectionId, com.azure.core.util.BinaryData searchFeaturesQuery, com.azure.core.http.rest.RequestOptions requestOptions)
      Search for STAC features by collection id, bbox, intersecting geometry, start and end datetime.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      maxpagesizeIntegerNoMaximum number of features needed (inclusive). Minimum = 1, Maximum = 100, Default value = 10.
      skipIntegerNoSkip token for getting next set of results.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Request Body Schema

      
       {
           startDateTime: OffsetDateTime (Required)
           endDateTime: OffsetDateTime (Required)
           intersects (Optional): {
           }
           bbox (Optional): [
               double (Optional)
           ]
           featureIds (Optional): [
               String (Optional)
           ]
       }
       

      Response Body Schema

      
       {
           features (Required): [
                (Required){
                   stacVersion: String (Required)
                   stacExtensions (Optional): [
                       String (Optional)
                   ]
                   id: String (Required)
                   type: String (Required)
                   geometry: Object (Optional)
                   bbox (Optional): [
                       double (Optional)
                   ]
                   properties: Object (Required)
                   links (Required): [
                        (Required){
                           href: String (Required)
                           rel: String (Required)
                           type: String (Optional)
                           title: String (Optional)
                       }
                   ]
                   assets (Required): {
                       String (Required): {
                           href: String (Required)
                           title: String (Optional)
                           description: String (Optional)
                           type: String (Optional)
                           roles (Optional): [
                               String (Optional)
                           ]
                       }
                   }
                   collection: String (Optional)
               }
           ]
           nextLink: String (Optional)
       }
       
      Parameters:
      collectionId - Collection Id to be searched. Allowed values: "Sentinel_2_L2A", "Sentinel_2_L1C".
      searchFeaturesQuery - Query filters.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged response contains list of features and next property to get the next set of results along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
    • getStacFeatureWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getStacFeatureWithResponse(String collectionId, String featureId, com.azure.core.http.rest.RequestOptions requestOptions)
      Get a feature(SpatioTemporal Asset Catalog (STAC) Item) for given collection and feature id.

      Response Body Schema

      
       {
           stacVersion: String (Required)
           stacExtensions (Optional): [
               String (Optional)
           ]
           id: String (Required)
           type: String (Required)
           geometry: Object (Optional)
           bbox (Optional): [
               double (Optional)
           ]
           properties: Object (Required)
           links (Required): [
                (Required){
                   href: String (Required)
                   rel: String (Required)
                   type: String (Optional)
                   title: String (Optional)
               }
           ]
           assets (Required): {
               String (Required): {
                   href: String (Required)
                   title: String (Optional)
                   description: String (Optional)
                   type: String (Optional)
                   roles (Optional): [
                       String (Optional)
                   ]
               }
           }
           collection: String (Optional)
       }
       
      Parameters:
      collectionId - Collection Id to be fetched. Allowed values: "Sentinel_2_L2A", "Sentinel_2_L1C".
      featureId - Feature Id to be fetched.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      a feature(SpatioTemporal Asset Catalog (STAC) Item) for given collection and feature id along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.