DataClient.GetClassMapLegendAsync Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

Name	Description
GetClassMapLegendAsync(String, Nullable<Int32>, Nullable<Int32>, RequestContext)	[Protocol Method] Generate values and color swatches mapping for a given classmap. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetClassMapLegendAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)	Generate values and color swatches mapping for a given classmap.

GetClassMapLegendAsync(String, Nullable<Int32>, Nullable<Int32>, RequestContext)

Source:

DataClient.cs

[Protocol Method] Generate values and color swatches mapping for a given classmap.

• 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> GetClassMapLegendAsync(string classmapName, int? trimStart, int? trimEnd, Azure.RequestContext context);

abstract member GetClassMapLegendAsync : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetClassMapLegendAsync : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetClassMapLegendAsync (classmapName As String, trimStart As Nullable(Of Integer), trimEnd As Nullable(Of Integer), context As RequestContext) As Task(Of Response)

Parameters

classmapName

String

classmap name.

trimStart

Nullable<Int32>

Number of items to trim from the start of the cmap.

trimEnd

Nullable<Int32>

Number of items to trim from the end of the cmap.

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

classmapName is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

GetClassMapLegendAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Source:

DataClient.cs

Generate values and color swatches mapping for a given classmap.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.ClassMapLegendResult>> GetClassMapLegendAsync(string classmapName, int? trimStart = default, int? trimEnd = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetClassMapLegendAsync : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.ClassMapLegendResult>>
override this.GetClassMapLegendAsync : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.ClassMapLegendResult>>

Public Overridable Function GetClassMapLegendAsync (classmapName As String, Optional trimStart As Nullable(Of Integer) = Nothing, Optional trimEnd As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ClassMapLegendResult))

Parameters

classmapName

String

classmap name.

trimStart

Nullable<Int32>

Number of items to trim from the start of the cmap.

trimEnd

Nullable<Int32>

Number of items to trim from the end of the cmap.

cancellationToken

CancellationToken

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

Returns

Task<Response<ClassMapLegendResult>>

Exceptions

ArgumentNullException

classmapName is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.