Class GeminiCorporaChunkBatchDeleteRequest

Namespace

Uralstech.UGemini.CorporaAPI.Chunks

Deletes multiple Chunk resources. There is no response.

public class GeminiCorporaChunkBatchDeleteRequest : IGeminiPostRequest, IGeminiRequest

Inheritance

object

GeminiCorporaChunkBatchDeleteRequest

Implements

IGeminiPostRequest

IGeminiRequest

Extension Methods

GeminiFieldMaskGenerator.GetFieldMask(object)

Remarks

Only available in the beta API.

Constructors

GeminiCorporaChunkBatchDeleteRequest(bool)

Creates a new GeminiCorporaChunkBatchDeleteRequest.

public GeminiCorporaChunkBatchDeleteRequest(bool useBetaApi = true)

Parameters

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

ParentDocumentId

Optional. The parent Document containing the Chunks to delete.

public GeminiCorpusDocumentId ParentDocumentId

Field Value

GeminiCorpusDocumentId

Remarks

If given, the parent field in every GeminiCorporaChunkBatchDeleteRequestPart must match this value.

Requests

The request messages specifying the Chunks to delete.

public GeminiCorporaChunkBatchDeleteRequestPart[] Requests

Field Value

GeminiCorporaChunkBatchDeleteRequestPart[]

Properties

AuthMethod

The preferred authentication method.

public GeminiAuthMethod AuthMethod { get; set; }

Property Value

GeminiAuthMethod

ContentType

The MIME type of the request content.

public string ContentType { get; }

Property Value

string

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.

GetUtf8EncodedData()

Converts the request object to a UTF-8 encoded string.

public string GetUtf8EncodedData()

Returns

string

The string data.