StacClient.Search Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

Name	Description
Search(StacSearchParameters, Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)	STAC search operation.
Search(RequestContent, String, Nullable<Int32>, RequestContext)	[Protocol Method] STAC search operation. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

Search(StacSearchParameters, Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)

Source:

StacClient.cs

STAC search operation.

public virtual Azure.Response<Azure.Analytics.PlanetaryComputer.StacItemCollection> Search(Azure.Analytics.PlanetaryComputer.StacSearchParameters body, Azure.Analytics.PlanetaryComputer.StacAssetUrlSigningMode? sign = default, int? durationInMinutes = default, System.Threading.CancellationToken cancellationToken = default);

abstract member Search : Azure.Analytics.PlanetaryComputer.StacSearchParameters * Nullable<Azure.Analytics.PlanetaryComputer.StacAssetUrlSigningMode> * Nullable<int> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.PlanetaryComputer.StacItemCollection>
override this.Search : Azure.Analytics.PlanetaryComputer.StacSearchParameters * Nullable<Azure.Analytics.PlanetaryComputer.StacAssetUrlSigningMode> * Nullable<int> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.PlanetaryComputer.StacItemCollection>

Public Overridable Function Search (body As StacSearchParameters, Optional sign As Nullable(Of StacAssetUrlSigningMode) = Nothing, Optional durationInMinutes As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of StacItemCollection)

Parameters

body

StacSearchParameters

Request body.

sign

Nullable<StacAssetUrlSigningMode>

Whether to sign asset URLs in the response.

durationInMinutes

Nullable<Int32>

URL signature duration in minutes.

cancellationToken

CancellationToken

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

Returns

Response<StacItemCollection>

Exceptions

ArgumentNullException

body is null.

RequestFailedException

Service returned a non-success status code.

Search(RequestContent, String, Nullable<Int32>, RequestContext)

Source:

StacClient.cs

[Protocol Method] STAC search operation.

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

public virtual Azure.Response Search(Azure.Core.RequestContent content, string sign = default, int? durationInMinutes = default, Azure.RequestContext context = default);

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

Public Overridable Function Search (content As RequestContent, Optional sign As String = Nothing, Optional durationInMinutes As Nullable(Of Integer) = Nothing, Optional context As RequestContext = Nothing) As Response

Parameters

content

RequestContent

The content to send as the body of the request.

sign

String

Whether to sign asset URLs in the response.

durationInMinutes

Nullable<Int32>

URL signature duration in minutes.

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

content is null.

RequestFailedException

Service returned a non-success status code.