StacClient.GetMosaics Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| GetMosaics(String, RequestContext) |
[Protocol Method] Get the mosaic definitions for a given collection
|
| GetMosaics(String, CancellationToken) |
Get the mosaic definitions for a given collection. |
GetMosaics(String, RequestContext)
- Source:
- StacClient.cs
[Protocol Method] Get the mosaic definitions for a given collection
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual Azure.Response GetMosaics(string collectionId, Azure.RequestContext context);
abstract member GetMosaics : string * Azure.RequestContext -> Azure.Response
override this.GetMosaics : string * Azure.RequestContext -> Azure.Response
Public Overridable Function GetMosaics (collectionId As String, context As RequestContext) As Response
Parameters
- collectionId
- String
Unique identifier for the STAC collection.
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
collectionId is null.
collectionId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
GetMosaics(String, CancellationToken)
- Source:
- StacClient.cs
Get the mosaic definitions for a given collection.
public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.PlanetaryComputer.StacMosaic>> GetMosaics(string collectionId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetMosaics : string * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.PlanetaryComputer.StacMosaic>>
override this.GetMosaics : string * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.PlanetaryComputer.StacMosaic>>
Public Overridable Function GetMosaics (collectionId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of StacMosaic))
Parameters
- collectionId
- String
Unique identifier for the STAC collection.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
collectionId is null.
collectionId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.