StacClient.GetMosaic Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

Name	Description
GetMosaic(String, String, RequestContext)	[Protocol Method] Get a mosaic definition from a given collection This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetMosaic(String, String, CancellationToken)	Get a mosaic definition from a given collection.

GetMosaic(String, String, RequestContext)

Source:

StacClient.cs

[Protocol Method] Get a mosaic definition from a given collection

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual Azure.Response GetMosaic(string collectionId, string mosaicId, Azure.RequestContext context);

abstract member GetMosaic : string * string * Azure.RequestContext -> Azure.Response
override this.GetMosaic : string * string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetMosaic (collectionId As String, mosaicId As String, context As RequestContext) As Response

Parameters

collectionId

String

Unique identifier for the STAC collection.

mosaicId

String

Unique identifier for the mosaic configuration.

context

RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

collectionId or mosaicId is null.

ArgumentException

collectionId or mosaicId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

GetMosaic(String, String, CancellationToken)

Source:

StacClient.cs

Get a mosaic definition from a given collection.

public virtual Azure.Response<Azure.Analytics.PlanetaryComputer.StacMosaic> GetMosaic(string collectionId, string mosaicId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetMosaic : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.PlanetaryComputer.StacMosaic>
override this.GetMosaic : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.PlanetaryComputer.StacMosaic>

Public Overridable Function GetMosaic (collectionId As String, mosaicId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of StacMosaic)

Parameters

collectionId

String

Unique identifier for the STAC collection.

mosaicId

String

Unique identifier for the mosaic configuration.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Response<StacMosaic>

Exceptions

ArgumentNullException

collectionId or mosaicId is null.

ArgumentException

collectionId or mosaicId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.