DataClient.GetSearchInfo 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
GetSearchInfo(String, RequestContext)	[Protocol Method] Get Search query metadata. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSearchInfo(String, CancellationToken)	Get Search query metadata.

Name

Description

GetSearchInfo(String, RequestContext)

[Protocol Method] Get Search query metadata.

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

GetSearchInfo(String, CancellationToken)

Get Search query metadata.

GetSearchInfo(String, RequestContext)

Source:: DataClient.cs

[Protocol Method] Get Search query metadata.

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

public virtual Azure.Response GetSearchInfo(string searchId, Azure.RequestContext context);

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

Public Overridable Function GetSearchInfo (searchId As String, context As RequestContext) As Response

Parameters

searchId: String

Search Id (pgSTAC Search Hash).

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

searchId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Applies to

GetSearchInfo(String, CancellationToken)

Source:: DataClient.cs

Get Search query metadata.

public virtual Azure.Response<Azure.Analytics.PlanetaryComputer.TilerStacSearchRegistration> GetSearchInfo(string searchId, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetSearchInfo (searchId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of TilerStacSearchRegistration)