StacClient.CreateRenderOptionAsync Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

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

CreateRenderOptionAsync(String, RenderConfiguration, CancellationToken)

Source:

StacClient.cs

Add a render option for a given collection.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.RenderConfiguration>> CreateRenderOptionAsync(string collectionId, Azure.Analytics.PlanetaryComputer.RenderConfiguration body, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function CreateRenderOptionAsync (collectionId As String, body As RenderConfiguration, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RenderConfiguration))

Parameters

collectionId

String

Unique identifier for the STAC collection.

body

RenderConfiguration

Render option configuration to be created or updated.

cancellationToken

CancellationToken

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

Returns

Task<Response<RenderConfiguration>>

Exceptions

ArgumentNullException

collectionId or body is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

CreateRenderOptionAsync(String, RequestContent, RequestContext)

Source:

StacClient.cs

[Protocol Method] Add 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 System.Threading.Tasks.Task<Azure.Response> CreateRenderOptionAsync(string collectionId, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member CreateRenderOptionAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateRenderOptionAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function CreateRenderOptionAsync (collectionId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

collectionId

String

Unique identifier for the STAC collection.

content

RequestContent

The content to send as the body of the request.

context

RequestContext

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

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

collectionId or content is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.