StacClient.GetCollection Method

Definition

Namespace:
Azure.Analytics.PlanetaryComputer
Assembly:
Azure.Analytics.PlanetaryComputer.dll
Package:
Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

Name Description
GetCollection(String, Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)

Get a collection in the GeoCatalog instance.
GetCollection(String, String, Nullable<Int32>, RequestContext)

[Protocol Method] Get a collection in the GeoCatalog instance

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

GetCollection(String, Nullable<StacAssetUrlSigningMode>, Nullable<Int32>, CancellationToken)

Source:
StacClient.cs

Get a collection in the GeoCatalog instance.

public virtual Azure.Response<Azure.Analytics.PlanetaryComputer.StacCollection> GetCollection(string collectionId, Azure.Analytics.PlanetaryComputer.StacAssetUrlSigningMode? sign = default, int? durationInMinutes = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetCollection : string * Nullable<Azure.Analytics.PlanetaryComputer.StacAssetUrlSigningMode> * Nullable<int> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.PlanetaryComputer.StacCollection>
override this.GetCollection : string * Nullable<Azure.Analytics.PlanetaryComputer.StacAssetUrlSigningMode> * Nullable<int> * System.Threading.CancellationToken -> Azure.Response<Azure.Analytics.PlanetaryComputer.StacCollection>
Public Overridable Function GetCollection (collectionId As String, Optional sign As Nullable(Of StacAssetUrlSigningMode) = Nothing, Optional durationInMinutes As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of StacCollection)

Parameters

collectionId
String

Catalog collection id.

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<StacCollection>

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

GetCollection(String, String, Nullable<Int32>, RequestContext)

Source:
StacClient.cs

[Protocol Method] Get a collection in the GeoCatalog instance

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. 
public virtual Azure.Response GetCollection(string collectionId, string sign, int? durationInMinutes, Azure.RequestContext context);
abstract member GetCollection : string * string * Nullable<int> * Azure.RequestContext -> Azure.Response
override this.GetCollection : string * string * Nullable<int> * Azure.RequestContext -> Azure.Response
Public Overridable Function GetCollection (collectionId As String, sign As String, durationInMinutes As Nullable(Of Integer), context As RequestContext) As Response

Parameters

collectionId
String

Catalog collection id.

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

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