StacClient.ReplacePartitionTypeAsync Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

Name	Description
ReplacePartitionTypeAsync(String, PartitionKind, CancellationToken)	Updates partition type for a GeoCatalog Collection. This will determine the partitioning scheme for items within the database, and can only be set before any items are loaded. Ideal partitioning schemes result in partitions of roughly 100k items each. The default partitioning scheme is "none" which does not partition items.
ReplacePartitionTypeAsync(String, RequestContent, RequestContext)	[Protocol Method] Updates partition type for a GeoCatalog Collection. This will determine the partitioning scheme for items within the database, and can only be set before any items are loaded. Ideal partitioning schemes result in partitions of roughly 100k items each. The default partitioning scheme is "none" which does not partition items. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

ReplacePartitionTypeAsync(String, PartitionKind, CancellationToken)

Source:

StacClient.cs

Updates partition type for a GeoCatalog Collection. This will determine the partitioning scheme for items within the database, and can only be set before any items are loaded. Ideal partitioning schemes result in partitions of roughly 100k items each. The default partitioning scheme is "none" which does not partition items.

public virtual System.Threading.Tasks.Task<Azure.Response> ReplacePartitionTypeAsync(string collectionId, Azure.Analytics.PlanetaryComputer.PartitionKind body, System.Threading.CancellationToken cancellationToken = default);

abstract member ReplacePartitionTypeAsync : string * Azure.Analytics.PlanetaryComputer.PartitionKind * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.ReplacePartitionTypeAsync : string * Azure.Analytics.PlanetaryComputer.PartitionKind * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function ReplacePartitionTypeAsync (collectionId As String, body As PartitionKind, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

collectionId

String

Unique identifier for the STAC collection.

body

PartitionKind

Partition type configuration determining how items are partitioned in storage.

cancellationToken

CancellationToken

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

Returns

Task<Response>

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.

ReplacePartitionTypeAsync(String, RequestContent, RequestContext)

Source:

StacClient.cs

[Protocol Method] Updates partition type for a GeoCatalog Collection. This will determine the partitioning scheme for items within the database, and can only be set before any items are loaded. Ideal partitioning schemes result in partitions of roughly 100k items each. The default partitioning scheme is "none" which does not partition items.

• 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> ReplacePartitionTypeAsync(string collectionId, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member ReplacePartitionTypeAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.ReplacePartitionTypeAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function ReplacePartitionTypeAsync (collectionId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of 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

Task<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.