StacClient.ReplaceCollection Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Overloads

Name	Description
ReplaceCollection(String, StacCollection, CancellationToken)	Replace an existing collection in the GeoCatalog instance.
ReplaceCollection(String, RequestContent, RequestContext)	[Protocol Method] Replace an existing collection in the GeoCatalog instance This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

ReplaceCollection(String, StacCollection, CancellationToken)

Source:

StacClient.cs

Replace an existing collection in the GeoCatalog instance.

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

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

Public Overridable Function ReplaceCollection (collectionId As String, body As StacCollection, Optional cancellationToken As CancellationToken = Nothing) As Response(Of StacCollection)

Parameters

collectionId

String

Catalog collection id.

body

StacCollection

Request collection body.

cancellationToken

CancellationToken

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

Returns

Response<StacCollection>

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.

ReplaceCollection(String, RequestContent, RequestContext)

Source:

StacClient.cs

[Protocol Method] Replace an existing 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 ReplaceCollection(string collectionId, Azure.Core.RequestContent content, Azure.RequestContext context = default);

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

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

Parameters

collectionId

String

Catalog collection 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

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.