Compartilhar via


Scenes.GetScenes Método

Definição

Retorna uma lista paginada de recursos de cena.

public virtual Azure.Pageable<BinaryData> GetScenes (string provider, string partyId, string boundaryId, string source, DateTimeOffset? startDateTime = default, DateTimeOffset? endDateTime = default, double? maxCloudCoveragePercentage = default, double? maxDarkPixelCoveragePercentage = default, System.Collections.Generic.IEnumerable<string> imageNames = default, System.Collections.Generic.IEnumerable<double> imageResolutions = default, System.Collections.Generic.IEnumerable<string> imageFormats = default, int? maxPageSize = default, string skipToken = default, Azure.RequestContext context = default);
abstract member GetScenes : string * string * string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<double> * Nullable<double> * seq<string> * seq<double> * seq<string> * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetScenes : string * string * string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<double> * Nullable<double> * seq<string> * seq<double> * seq<string> * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
Public Overridable Function GetScenes (provider As String, partyId As String, boundaryId As String, source As String, Optional startDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional endDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxCloudCoveragePercentage As Nullable(Of Double) = Nothing, Optional maxDarkPixelCoveragePercentage As Nullable(Of Double) = Nothing, Optional imageNames As IEnumerable(Of String) = Nothing, Optional imageResolutions As IEnumerable(Of Double) = Nothing, Optional imageFormats As IEnumerable(Of String) = Nothing, Optional maxPageSize As Nullable(Of Integer) = Nothing, Optional skipToken As String = Nothing, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)

Parâmetros

provider
String

Nome do provedor de dados de cena.

partyId
String

PartyId.

boundaryId
String

BoundaryId.

source
String

Nome de origem dos dados de cena, Valores Disponíveis: Sentinel_2_L2A, Sentinel_2_L1C.

startDateTime
Nullable<DateTimeOffset>

Início da cena UTC datetime (inclusive), formato de exemplo: yyyy-MM-ddThh:mm:ssZ.

endDateTime
Nullable<DateTimeOffset>

Datetime UTC de término da cena (inclusive), formato de exemplo:yyy-MM-dThh:mm:ssZ.

maxCloudCoveragePercentage
Nullable<Double>

Filtrar cenas com percentual de cobertura de nuvem menor que o valor máximo. Intervalo [0 a 100.0].

maxDarkPixelCoveragePercentage
Nullable<Double>

Filtrar cenas com percentual de cobertura de pixel escuro menor que o valor máximo. Intervalo [0 a 100.0].

imageNames
IEnumerable<String>

Lista de nomes de imagem a serem filtrados.

imageResolutions
IEnumerable<Double>

Lista de resoluções de imagem em medidores a serem filtrados.

imageFormats
IEnumerable<String>

Lista de formatos de imagem a serem filtrados.

maxPageSize
Nullable<Int32>

Número máximo de itens necessários (inclusive). Mínimo = 10, Máximo = 1000, Valor padrão = 50.

skipToken
String

Ignore o token para obter o próximo conjunto de resultados.

context
RequestContext

O contexto de solicitação, que pode substituir os comportamentos padrão do pipeline do cliente por chamada.

Retornos

O Pageable<T> do serviço que contém uma lista de BinaryData objetos. Os detalhes do esquema do corpo de cada item na coleção estão na seção Comentários abaixo.

Exceções

provider, partyId, boundaryId ou source é nulo.

O serviço retornou um código de status sem êxito.

Exemplos

Este exemplo mostra como chamar GetScenes com os parâmetros necessários e analisar o resultado.

var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetScenesClient(<2022-11-01-preview>);

foreach (var data in client.GetScenes("<provider>", "<partyId>", "<boundaryId>", "<source>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

Este exemplo mostra como chamar GetScenes com todos os parâmetros e como analisar o resultado.

var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetScenesClient(<2022-11-01-preview>);

foreach (var data in client.GetScenes("<provider>", "<partyId>", "<boundaryId>", "<source>", DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, 1234, 1234, new String[]{"<imageNames>"}, new Double[]{1234}, new String[]{"<imageFormats>"}, 1234, "<skipToken>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("sceneDateTime").ToString());
    Console.WriteLine(result.GetProperty("provider").ToString());
    Console.WriteLine(result.GetProperty("source").ToString());
    Console.WriteLine(result.GetProperty("imageFiles")[0].GetProperty("fileLink").ToString());
    Console.WriteLine(result.GetProperty("imageFiles")[0].GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("imageFiles")[0].GetProperty("imageFormat").ToString());
    Console.WriteLine(result.GetProperty("imageFiles")[0].GetProperty("resolution").ToString());
    Console.WriteLine(result.GetProperty("imageFormat").ToString());
    Console.WriteLine(result.GetProperty("cloudCoverPercentage").ToString());
    Console.WriteLine(result.GetProperty("darkPixelPercentage").ToString());
    Console.WriteLine(result.GetProperty("ndviMedianValue").ToString());
    Console.WriteLine(result.GetProperty("boundaryId").ToString());
    Console.WriteLine(result.GetProperty("partyId").ToString());
    Console.WriteLine(result.GetProperty("id").ToString());
    Console.WriteLine(result.GetProperty("eTag").ToString());
}

Comentários

Abaixo está o esquema JSON de um item na resposta paginável.

Corpo da resposta:

Esquema para SceneListResponseValue:

{
  sceneDateTime: string (ISO 8601 Format), # Optional. Date-time of the scene, sample format: yyyy-MM-ddTHH:mm:ssZ.
  provider: string, # Optional. Data provider of the scene.
  source: string, # Optional. Data source of the scene.
  imageFiles: [
    {
      fileLink: string, # Optional. Link of the image file.
      name: string, # Required. Name of the image file.
      imageFormat: "TIF", # Optional. ImageFormat. Available value: TIF.
      resolution: number, # Optional. Resolution of image file in meters.
    }
  ], # Optional. Collection of image files.
  imageFormat: "TIF", # Optional. ImageFormat. Available value: TIF.
  cloudCoverPercentage: number, # Optional. Cloud cover percentage of the scene.
  darkPixelPercentage: number, # Optional. Dark pixel percentage of the scene.
  ndviMedianValue: number, # Optional. Median of NDVI of the scene.
  boundaryId: string, # Optional. Boundary ID which belongs to the scene.
  partyId: string, # Optional. Party ID which belongs to the scene.
  id: string, # Optional. Unique scene resource ID.
  eTag: string, # Optional. The ETag value to implement optimistic concurrency.
}

Aplica-se a