@volcengine/pulumi/rocketmq/getTopics.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to query detailed information of rocketmq topics
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const foo = volcengine.rocketmq.getTopics({
 *     instanceId: "rocketmq-cnoeea6b32118fc2",
 * });
 * ```
 */
export declare function getTopics(args: GetTopicsArgs, opts?: pulumi.InvokeOptions): Promise<GetTopicsResult>;
/**
 * A collection of arguments for invoking getTopics.
 */
export interface GetTopicsArgs {
    /**
     * The id of rocketmq instance.
     */
    instanceId: string;
    /**
     * The type of the rocketmq message. Setting this parameter means filtering the Topic list based on the specified message type. The value explanation is as follows:
     * 0: Regular message
     * 1: Transaction message
     * 2: Partition order message
     * 3: Global sequential message
     * 4: Delay message.
     */
    messageType?: number;
    /**
     * A Name Regex of Resource.
     */
    nameRegex?: string;
    /**
     * File name where to save data source results.
     */
    outputFile?: string;
    /**
     * The name of the rocketmq topic. This field support fuzzy query.
     */
    topicName?: string;
}
/**
 * A collection of values returned by getTopics.
 */
export interface GetTopicsResult {
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The id of rocketmq instance.
     */
    readonly instanceId: string;
    /**
     * The type of the rocketmq message.
     */
    readonly messageType?: number;
    readonly nameRegex?: string;
    readonly outputFile?: string;
    /**
     * The collection of query.
     */
    readonly rocketmqTopics: outputs.rocketmq.GetTopicsRocketmqTopic[];
    /**
     * The name of the rocketmq topic.
     */
    readonly topicName?: string;
    /**
     * The total count of query.
     */
    readonly totalCount: number;
}
/**
 * Use this data source to query detailed information of rocketmq topics
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const foo = volcengine.rocketmq.getTopics({
 *     instanceId: "rocketmq-cnoeea6b32118fc2",
 * });
 * ```
 */
export declare function getTopicsOutput(args: GetTopicsOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetTopicsResult>;
/**
 * A collection of arguments for invoking getTopics.
 */
export interface GetTopicsOutputArgs {
    /**
     * The id of rocketmq instance.
     */
    instanceId: pulumi.Input<string>;
    /**
     * The type of the rocketmq message. Setting this parameter means filtering the Topic list based on the specified message type. The value explanation is as follows:
     * 0: Regular message
     * 1: Transaction message
     * 2: Partition order message
     * 3: Global sequential message
     * 4: Delay message.
     */
    messageType?: pulumi.Input<number>;
    /**
     * A Name Regex of Resource.
     */
    nameRegex?: pulumi.Input<string>;
    /**
     * File name where to save data source results.
     */
    outputFile?: pulumi.Input<string>;
    /**
     * The name of the rocketmq topic. This field support fuzzy query.
     */
    topicName?: pulumi.Input<string>;
}