Class GeminiFileGetRequest

Namespace

Uralstech.UGemini.FileAPI

Requests metadata for an existing file. Return type is GeminiFile.

public class GeminiFileGetRequest : IGeminiGetRequest, IGeminiRequest

Inheritance

object

GeminiFileGetRequest

Implements

IGeminiGetRequest

IGeminiRequest

Extension Methods

GeminiFieldMaskGenerator.GetFieldMask<T>(T)

Remarks

Only available in the beta API.

Constructors

GeminiFileGetRequest(string, bool)

Creates a new GeminiFileGetRequest.

public GeminiFileGetRequest(string fileNameOrId, bool useBetaApi = true)

Parameters

fileNameOrId string

The name (format 'files/{fileId}') or ID of the file 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

FileId

The ID of the file to get.

public string FileId

Field Value

string

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.