DataClient.GetCollectionInfo 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
GetCollectionInfo(String, RequestContext)	[Protocol Method] Return search query info from a STAC collection identifier. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCollectionInfo(String, CancellationToken)	Return search query info from a STAC collection identifier.

Name

Description

GetCollectionInfo(String, RequestContext)

[Protocol Method] Return search query info from a STAC collection identifier.

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

GetCollectionInfo(String, CancellationToken)

Return search query info from a STAC collection identifier.

GetCollectionInfo(String, RequestContext)

Source:: DataClient.cs

[Protocol Method] Return search query info from a STAC collection identifier.

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

public virtual Azure.Response GetCollectionInfo(string collectionId, Azure.RequestContext context);

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

Public Overridable Function GetCollectionInfo (collectionId As String, context As RequestContext) As Response

Parameters

collectionId: String

STAC Collection Identifier.

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

collectionId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Applies to

GetCollectionInfo(String, CancellationToken)

Source:: DataClient.cs

Return search query info from a STAC collection identifier.

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

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

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