Class GeminiCorporaDeleteRequest

Namespace

Uralstech.UGemini.CorporaAPI

Deletes a Corpora API resource.

public class GeminiCorporaDeleteRequest : IGeminiDeleteRequest, IGeminiRequest

Inheritance

object

GeminiCorporaDeleteRequest

Implements

IGeminiDeleteRequest

IGeminiRequest

Extension Methods

GeminiFieldMaskGenerator.GetFieldMask(object)

Remarks

Only available in the beta API.

Constructors

GeminiCorporaDeleteRequest(IGeminiCorpusResourceId, bool)

Creates a new GeminiCorporaDeleteRequest.

public GeminiCorporaDeleteRequest(IGeminiCorpusResourceId resourceId, bool useBetaApi = true)

Parameters

resourceId IGeminiCorpusResourceId

The ID of the Corpora API resource to delete.

useBetaApi bool

Should the request use the Beta API?

Remarks

Only available in the beta API.

Fields

ApiVersion

The API version to use.

public string ApiVersion

Field Value

string

ForceDelete

If set to true, any Documents/Chunks and objects related to this Corpus/Document will also be deleted. If false, a FAILED_PRECONDITION error will be returned if the Corpus/Document contains any Documents/Chunks.

public bool ForceDelete

Field Value

bool

Remarks

Unsupported for Chunk deletion requests.

ResourceId

The ID of the Corpora API resource to delete.

public IGeminiCorpusResourceId ResourceId

Field Value

IGeminiCorpusResourceId

Properties

AuthMethod

The preferred authentication method.

public GeminiAuthMethod AuthMethod { get; set; }

Property Value

GeminiAuthMethod

OAuthAccessToken

The OAuth access token to authenticate the request, if using OAuthAccessToken as AuthMethod.

public string OAuthAccessToken { get; set; }

Property Value

string

Methods

GetEndpointUri(GeminiRequestMetadata)

Gets the URI to the API endpoint.

public string GetEndpointUri(GeminiRequestMetadata metadata)

Parameters

metadata GeminiRequestMetadata

The metadata of the request to be carried out on the URI.

Returns

string

The URI.