StacClient.GetRenderOption Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

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

GetRenderOption(String, String, CancellationToken)

Source:

StacClient.cs

Get a render option for a given collection.

public virtual Azure.Response<Azure.Analytics.PlanetaryComputer.RenderConfiguration> GetRenderOption(string collectionId, string renderOptionId, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetRenderOption (collectionId As String, renderOptionId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RenderConfiguration)

Parameters

collectionId

String

Unique identifier for the STAC collection.

renderOptionId

String

Unique identifier for the render option.

cancellationToken

CancellationToken

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

Returns

Response<RenderConfiguration>

Exceptions

ArgumentNullException

collectionId or renderOptionId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

GetRenderOption(String, String, RequestContext)

Source:

StacClient.cs

[Protocol Method] Get a render option 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 GetRenderOption(string collectionId, string renderOptionId, Azure.RequestContext context);

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

Public Overridable Function GetRenderOption (collectionId As String, renderOptionId As String, context As RequestContext) As Response

Parameters

collectionId

String

Unique identifier for the STAC collection.

renderOptionId

String

Unique identifier for the render option.

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 renderOptionId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.