StacClient.GetCollectionsAsync Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

Name	Description
GetCollectionsAsync(Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)	List all collections in the GeoCatalog instance.
GetCollectionsAsync(String, Nullable<Int32>, RequestContext)	[Protocol Method] List all collections in the GeoCatalog instance This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

GetCollectionsAsync(Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)

Source:

StacClient.cs

List all collections in the GeoCatalog instance.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.StacCatalogCollections>> GetCollectionsAsync(Azure.Analytics.PlanetaryComputer.StacAssetUrlSigningMode? sign = default, int? durationInMinutes = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetCollectionsAsync : Nullable<Azure.Analytics.PlanetaryComputer.StacAssetUrlSigningMode> * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.StacCatalogCollections>>
override this.GetCollectionsAsync : Nullable<Azure.Analytics.PlanetaryComputer.StacAssetUrlSigningMode> * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.PlanetaryComputer.StacCatalogCollections>>

Public Overridable Function GetCollectionsAsync (Optional sign As Nullable(Of StacAssetUrlSigningMode) = Nothing, Optional durationInMinutes As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of StacCatalogCollections))

Parameters

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

Task<Response<StacCatalogCollections>>

Exceptions

RequestFailedException

Service returned a non-success status code.

GetCollectionsAsync(String, Nullable<Int32>, RequestContext)

Source:

StacClient.cs

[Protocol Method] List all collections in the GeoCatalog instance

• 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> GetCollectionsAsync(string sign, int? durationInMinutes, Azure.RequestContext context);

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

Public Overridable Function GetCollectionsAsync (sign As String, durationInMinutes As Nullable(Of Integer), context As RequestContext) As Task(Of Response)

Parameters

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

Task<Response>

The response returned from the service.

Exceptions

RequestFailedException

Service returned a non-success status code.