@maienm/pulumi-prowlarr
Version:
A Pulumi package for creating and managing Prowlarr resources. Based on terraform-provider-prowlarr: version v2.3.0
104 lines (103 loc) • 2.28 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* <!-- subcategory:Indexers -->Indexer schema definition.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as prowlarr from "@pulumi/prowlarr";
*
* const test = prowlarr.Indexers.getSchema({
* name: "AlphaRatio",
* });
* ```
*/
export declare function getSchema(args: GetSchemaArgs, opts?: pulumi.InvokeOptions): Promise<GetSchemaResult>;
/**
* A collection of arguments for invoking getSchema.
*/
export interface GetSchemaArgs {
/**
* Field name.
*/
name: string;
}
/**
* A collection of values returned by getSchema.
*/
export interface GetSchemaResult {
/**
* Indexer configuration template.
*/
readonly configContract: string;
/**
* Indexer description.
*/
readonly description: string;
/**
* Indexer encoding.
*/
readonly encoding: string;
/**
* Set of configuration fields.
*/
readonly fields: outputs.Indexers.GetSchemaField[];
/**
* Schema ID.
*/
readonly id: number;
/**
* Indexer implementation name.
*/
readonly implementation: string;
/**
* List of available URLs.
*/
readonly indexerUrls: string[];
/**
* Language.
*/
readonly language: string;
/**
* List of legacy URLs.
*/
readonly legacyUrls: string[];
/**
* Indexer name.
*/
readonly name: string;
/**
* Privacy.
*/
readonly privacy: string;
/**
* Protocol. Valid values are 'usenet' and 'torrent'.
*/
readonly protocol: string;
}
/**
* <!-- subcategory:Indexers -->Indexer schema definition.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as prowlarr from "@pulumi/prowlarr";
*
* const test = prowlarr.Indexers.getSchema({
* name: "AlphaRatio",
* });
* ```
*/
export declare function getSchemaOutput(args: GetSchemaOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetSchemaResult>;
/**
* A collection of arguments for invoking getSchema.
*/
export interface GetSchemaOutputArgs {
/**
* Field name.
*/
name: pulumi.Input<string>;
}