StacClient.CreateQueryables Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

Name	Description
CreateQueryables(String, IEnumerable<StacQueryable>, CancellationToken)	Set queryables for a collection given a list of queryable definitions.
CreateQueryables(String, RequestContent, RequestContext)	[Protocol Method] Set queryables for a collection given a list of queryable definitions This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

CreateQueryables(String, IEnumerable<StacQueryable>, CancellationToken)

Source:

StacClient.cs

Set queryables for a collection given a list of queryable definitions.

public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.PlanetaryComputer.StacQueryable>> CreateQueryables(string collectionId, System.Collections.Generic.IEnumerable<Azure.Analytics.PlanetaryComputer.StacQueryable> body, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateQueryables : string * seq<Azure.Analytics.PlanetaryComputer.StacQueryable> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.PlanetaryComputer.StacQueryable>>
override this.CreateQueryables : string * seq<Azure.Analytics.PlanetaryComputer.StacQueryable> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.PlanetaryComputer.StacQueryable>>

Public Overridable Function CreateQueryables (collectionId As String, body As IEnumerable(Of StacQueryable), Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of StacQueryable))

Parameters

collectionId

String

Unique identifier for the STAC collection.

body

IEnumerable<StacQueryable>

Request queryable definition body.

cancellationToken

CancellationToken

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

Returns

Response<IReadOnlyList<StacQueryable>>

Exceptions

ArgumentNullException

collectionId or body is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

CreateQueryables(String, RequestContent, RequestContext)

Source:

StacClient.cs

[Protocol Method] Set queryables for a collection given a list of queryable definitions

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

public virtual Azure.Response CreateQueryables(string collectionId, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member CreateQueryables : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.CreateQueryables : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response

Public Overridable Function CreateQueryables (collectionId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response

Parameters

collectionId

String

Unique identifier for the STAC collection.

content

RequestContent

The content to send as the body of the request.

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 or content is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.