StacClient.GetCollectionConfiguration Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

Name	Description
GetCollectionConfiguration(String, CancellationToken)	Get the complete user configuration for a given collection.
GetCollectionConfiguration(String, RequestContext)	[Protocol Method] Get the complete user configuration for a given collection This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

GetCollectionConfiguration(String, CancellationToken)

Source:

StacClient.cs

Get the complete user configuration for a given collection.

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

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

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

Parameters

collectionId

String

Unique identifier for the STAC collection.

cancellationToken

CancellationToken

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

Returns

Response<UserCollectionSettings>

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.

GetCollectionConfiguration(String, RequestContext)

Source:

StacClient.cs

[Protocol Method] Get the complete user configuration for a given collection

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

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

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

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

Parameters

collectionId

String

Unique identifier for the STAC collection.

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.