StacClient.GetRenderOptions Method

Definition

Namespace:: Azure.Analytics.PlanetaryComputer

Assembly:: Azure.Analytics.PlanetaryComputer.dll

Package:: Azure.Analytics.PlanetaryComputer v1.0.0

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
GetRenderOptions(String, RequestContext)	[Protocol Method] Get all render options for a given collection This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRenderOptions(String, CancellationToken)	Get all render options for a given collection.

Name

Description

GetRenderOptions(String, RequestContext)

[Protocol Method] Get all render options for a given collection

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

GetRenderOptions(String, CancellationToken)

Get all render options for a given collection.

GetRenderOptions(String, RequestContext)

Source:: StacClient.cs

[Protocol Method] Get all render options 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 GetRenderOptions(string collectionId, Azure.RequestContext context);

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

Public Overridable Function GetRenderOptions (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

Response

The response returned from the service.

Exceptions

ArgumentNullException

collectionId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Applies to

GetRenderOptions(String, CancellationToken)

Source:: StacClient.cs

Get all render options for a given collection.

public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.PlanetaryComputer.RenderConfiguration>> GetRenderOptions(string collectionId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetRenderOptions : string * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.PlanetaryComputer.RenderConfiguration>>
override this.GetRenderOptions : string * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.PlanetaryComputer.RenderConfiguration>>

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