@pulumi/scm/getHipObjectList.d.ts

A Pulumi package for managing resources on Strata Cloud Manager.. Based on terraform-provider-scm: version v0.2.1

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * Retrieves a listing of config items.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scm from "@pulumi/scm";
 *
 * // Fetch a list of all HIP Object objects in the Shared folder.
 * const allShared = scm.getHipObjectList({
 *     folder: "All",
 * });
 * export const hipObjectsListAllShared = allShared.then(allShared => allShared.datas);
 * // Example of using pagination to get the first 10 HIP objects.
 * const paginated = scm.getHipObjectList({
 *     folder: "All",
 *     limit: 10,
 *     offset: 0,
 * });
 * export const hipObjectsListPaginated = paginated.then(paginated => paginated.datas);
 * ```
 */
export declare function getHipObjectList(args?: GetHipObjectListArgs, opts?: pulumi.InvokeOptions): Promise<GetHipObjectListResult>;
/**
 * A collection of arguments for invoking getHipObjectList.
 */
export interface GetHipObjectListArgs {
    /**
     * The device of the item.
     */
    device?: string;
    /**
     * The folder of the item. Default: Shared.
     */
    folder?: string;
    /**
     * The max number of items to return. Default: 200.
     */
    limit?: number;
    /**
     * The name of the item.
     */
    name?: string;
    /**
     * The offset of the first item to return.
     */
    offset?: number;
    /**
     * The snippet of the item.
     */
    snippet?: string;
}
/**
 * A collection of values returned by getHipObjectList.
 */
export interface GetHipObjectListResult {
    /**
     * The data.
     */
    readonly datas: outputs.GetHipObjectListData[];
    /**
     * The device of the item.
     */
    readonly device?: string;
    /**
     * The folder of the item. Default: Shared.
     */
    readonly folder?: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The max number of items to return. Default: 200.
     */
    readonly limit?: number;
    /**
     * The name of the item.
     */
    readonly name?: string;
    /**
     * The offset of the first item to return.
     */
    readonly offset?: number;
    /**
     * The snippet of the item.
     */
    readonly snippet?: string;
    readonly tfid: string;
    /**
     * The total number of items.
     */
    readonly total: number;
}
/**
 * Retrieves a listing of config items.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scm from "@pulumi/scm";
 *
 * // Fetch a list of all HIP Object objects in the Shared folder.
 * const allShared = scm.getHipObjectList({
 *     folder: "All",
 * });
 * export const hipObjectsListAllShared = allShared.then(allShared => allShared.datas);
 * // Example of using pagination to get the first 10 HIP objects.
 * const paginated = scm.getHipObjectList({
 *     folder: "All",
 *     limit: 10,
 *     offset: 0,
 * });
 * export const hipObjectsListPaginated = paginated.then(paginated => paginated.datas);
 * ```
 */
export declare function getHipObjectListOutput(args?: GetHipObjectListOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetHipObjectListResult>;
/**
 * A collection of arguments for invoking getHipObjectList.
 */
export interface GetHipObjectListOutputArgs {
    /**
     * The device of the item.
     */
    device?: pulumi.Input<string>;
    /**
     * The folder of the item. Default: Shared.
     */
    folder?: pulumi.Input<string>;
    /**
     * The max number of items to return. Default: 200.
     */
    limit?: pulumi.Input<number>;
    /**
     * The name of the item.
     */
    name?: pulumi.Input<string>;
    /**
     * The offset of the first item to return.
     */
    offset?: pulumi.Input<number>;
    /**
     * The snippet of the item.
     */
    snippet?: pulumi.Input<string>;
}