StacClient.ReplaceItemAsync Method

Definition

Overloads

ReplaceItemAsync(WaitUntil, String, String, StacItem, CancellationToken)

Source:
StacClient.cs

Replace a STAC item in a collection.

public virtual System.Threading.Tasks.Task<Azure.Operation> ReplaceItemAsync(Azure.WaitUntil waitUntil, string collectionId, string itemId, Azure.Analytics.PlanetaryComputer.StacItem body, System.Threading.CancellationToken cancellationToken = default);
abstract member ReplaceItemAsync : Azure.WaitUntil * string * string * Azure.Analytics.PlanetaryComputer.StacItem * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation>
override this.ReplaceItemAsync : Azure.WaitUntil * string * string * Azure.Analytics.PlanetaryComputer.StacItem * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation>
Public Overridable Function ReplaceItemAsync (waitUntil As WaitUntil, collectionId As String, itemId As String, body As StacItem, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

collectionId
String

Catalog collection id.

itemId
String

STAC Item id.

body
StacItem

STAC Item.

cancellationToken
CancellationToken

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

Returns

Exceptions

collectionId, itemId or body is null.

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

Applies to

ReplaceItemAsync(WaitUntil, String, String, RequestContent, RequestContext)

Source:
StacClient.cs

Replace a STAC item in a collection.

public virtual System.Threading.Tasks.Task<Azure.Operation> ReplaceItemAsync(Azure.WaitUntil waitUntil, string collectionId, string itemId, Azure.Core.RequestContent content, Azure.RequestContext context = default);
abstract member ReplaceItemAsync : Azure.WaitUntil * string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
override this.ReplaceItemAsync : Azure.WaitUntil * string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
Public Overridable Function ReplaceItemAsync (waitUntil As WaitUntil, collectionId As String, itemId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

collectionId
String

Catalog collection id.

itemId
String

STAC Item id.

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

The response returned from the service.

Exceptions

collectionId, itemId or content is null.

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

Applies to