DataClient.GetSearchInfoAsync Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

Name	Description
GetSearchInfoAsync(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.
GetSearchInfoAsync(String, CancellationToken)	Get Search query metadata.

GetSearchInfoAsync(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 System.Threading.Tasks.Task<Azure.Response> GetSearchInfoAsync(string searchId, Azure.RequestContext context);

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

Public Overridable Function GetSearchInfoAsync (searchId As String, context As RequestContext) As Task(Of 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

Task<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.

GetSearchInfoAsync(String, CancellationToken)

Source:

DataClient.cs

Get Search query metadata.

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

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

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

Parameters

searchId

String

Search Id (pgSTAC Search Hash).

cancellationToken

CancellationToken

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

Returns

Task<Response<TilerStacSearchRegistration>>

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.