@pulumi/gcp/diagflow/fulfillment.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * By default, your agent responds to a matched intent with a static response. If you're using one of the integration options, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday.
 *
 * To get more information about Fulfillment, see:
 *
 * * [API documentation](https://cloud.google.com/dialogflow/es/docs/reference/rest/v2/projects.agent/getFulfillment)
 * * How-to Guides
 *     * [Official Documentation](https://cloud.google.com/dialogflow/es/docs/fulfillment-overview)
 *
 * ## Example Usage
 *
 * ### Dialogflow Fulfillment Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const basicAgent = new gcp.diagflow.Agent("basic_agent", {
 *     displayName: "example_agent",
 *     defaultLanguageCode: "en",
 *     timeZone: "America/New_York",
 * });
 * const basicFulfillment = new gcp.diagflow.Fulfillment("basic_fulfillment", {
 *     displayName: "basic-fulfillment",
 *     enabled: true,
 *     genericWebService: {
 *         uri: "https://google.com",
 *         username: "admin",
 *         password: "password",
 *         requestHeaders: {
 *             name: "wrench",
 *         },
 *     },
 * }, {
 *     dependsOn: [basicAgent],
 * });
 * ```
 *
 * ## Import
 *
 * Fulfillment can be imported using any of these accepted formats:
 *
 * * `{{name}}`
 *
 * When using the `pulumi import` command, Fulfillment can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:diagflow/fulfillment:Fulfillment default {{name}}
 * ```
 */
export declare class Fulfillment extends pulumi.CustomResource {
    /**
     * Get an existing Fulfillment resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FulfillmentState, opts?: pulumi.CustomResourceOptions): Fulfillment;
    /**
     * Returns true if the given object is an instance of Fulfillment.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Fulfillment;
    /**
     * The human-readable name of the fulfillment, unique within the agent.
     */
    readonly displayName: pulumi.Output<string>;
    /**
     * Whether fulfillment is enabled.
     */
    readonly enabled: pulumi.Output<boolean | undefined>;
    /**
     * The field defines whether the fulfillment is enabled for certain features.
     * Structure is documented below.
     */
    readonly features: pulumi.Output<outputs.diagflow.FulfillmentFeature[] | undefined>;
    /**
     * Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers.
     * Structure is documented below.
     */
    readonly genericWebService: pulumi.Output<outputs.diagflow.FulfillmentGenericWebService | undefined>;
    /**
     * The unique identifier of the fulfillment.
     * Format: projects/<Project ID>/agent/fulfillment - projects/<Project ID>/locations/<Location ID>/agent/fulfillment
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * Create a Fulfillment resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: FulfillmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Fulfillment resources.
 */
export interface FulfillmentState {
    /**
     * The human-readable name of the fulfillment, unique within the agent.
     */
    displayName?: pulumi.Input<string>;
    /**
     * Whether fulfillment is enabled.
     */
    enabled?: pulumi.Input<boolean>;
    /**
     * The field defines whether the fulfillment is enabled for certain features.
     * Structure is documented below.
     */
    features?: pulumi.Input<pulumi.Input<inputs.diagflow.FulfillmentFeature>[]>;
    /**
     * Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers.
     * Structure is documented below.
     */
    genericWebService?: pulumi.Input<inputs.diagflow.FulfillmentGenericWebService>;
    /**
     * The unique identifier of the fulfillment.
     * Format: projects/<Project ID>/agent/fulfillment - projects/<Project ID>/locations/<Location ID>/agent/fulfillment
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Fulfillment resource.
 */
export interface FulfillmentArgs {
    /**
     * The human-readable name of the fulfillment, unique within the agent.
     */
    displayName: pulumi.Input<string>;
    /**
     * Whether fulfillment is enabled.
     */
    enabled?: pulumi.Input<boolean>;
    /**
     * The field defines whether the fulfillment is enabled for certain features.
     * Structure is documented below.
     */
    features?: pulumi.Input<pulumi.Input<inputs.diagflow.FulfillmentFeature>[]>;
    /**
     * Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers.
     * Structure is documented below.
     */
    genericWebService?: pulumi.Input<inputs.diagflow.FulfillmentGenericWebService>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
}