DataClient.GetClassMapLegend 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
GetClassMapLegend(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.
GetClassMapLegend(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)	Generate values and color swatches mapping for a given classmap.

Name

Description

GetClassMapLegend(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.

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

Generate values and color swatches mapping for a given classmap.

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

abstract member GetClassMapLegend : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Response
override this.GetClassMapLegend : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Response

Public Overridable Function GetClassMapLegend (classmapName As String, trimStart As Nullable(Of Integer), trimEnd As Nullable(Of Integer), context As RequestContext) As 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

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.

Applies to

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

Source:: DataClient.cs

Generate values and color swatches mapping for a given classmap.

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

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

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