Class GeminiCorporaGetRequest

Namespace

Uralstech.UGemini.CorporaAPI

Gets information about a specific Corpora API resource. Response type can be GeminiCorpus, GeminiCorpusDocument or GeminiCorpusChunk.

public class GeminiCorporaGetRequest : IGeminiGetRequest, IGeminiRequest

Inheritance

object

GeminiCorporaGetRequest

Implements

IGeminiGetRequest

IGeminiRequest

Extension Methods

GeminiFieldMaskGenerator.GetFieldMask(object)

Remarks

Only available in the beta API.

Constructors

GeminiCorporaGetRequest(IGeminiCorpusResourceId, bool)

Creates a new GeminiCorporaGetRequest.

public GeminiCorporaGetRequest(IGeminiCorpusResourceId resourceId, bool useBetaApi = true)

Parameters

resourceId IGeminiCorpusResourceId

The ID of the resource to get.

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

ResourceId

The ID of the resource to get.

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.