@cdktf/provider-google
Version:
Prebuilt google Provider for Terraform CDK (cdktf)
219 lines (218 loc) • 11.5 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface DialogflowEntityTypeConfig extends cdktf.TerraformMetaArguments {
/**
* The name of this entity type to be displayed on the console.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type#display_name DialogflowEntityType#display_name}
*/
readonly displayName: string;
/**
* Enables fuzzy entity extraction during classification.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type#enable_fuzzy_extraction DialogflowEntityType#enable_fuzzy_extraction}
*/
readonly enableFuzzyExtraction?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type#id DialogflowEntityType#id}
*
* Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
* If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
*/
readonly id?: string;
/**
* Indicates the kind of entity type.
* * KIND_MAP: Map entity types allow mapping of a group of synonyms to a reference value.
* * KIND_LIST: List entity types contain a set of entries that do not map to reference values. However, list entity
* types can contain references to other entity types (with or without aliases).
* * KIND_REGEXP: Regexp entity types allow to specify regular expressions in entries values. Possible values: ["KIND_MAP", "KIND_LIST", "KIND_REGEXP"]
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type#kind DialogflowEntityType#kind}
*/
readonly kind: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type#project DialogflowEntityType#project}
*/
readonly project?: string;
/**
* entities block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type#entities DialogflowEntityType#entities}
*/
readonly entities?: DialogflowEntityTypeEntities[] | cdktf.IResolvable;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type#timeouts DialogflowEntityType#timeouts}
*/
readonly timeouts?: DialogflowEntityTypeTimeouts;
}
export interface DialogflowEntityTypeEntities {
/**
* A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym
* could be green onions.
* For KIND_LIST entity types:
* * This collection must contain exactly one synonym equal to value.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type#synonyms DialogflowEntityType#synonyms}
*/
readonly synonyms: string[];
/**
* The primary value associated with this entity entry. For example, if the entity type is vegetable, the value
* could be scallions.
* For KIND_MAP entity types:
* * A reference value to be used in place of synonyms.
* For KIND_LIST entity types:
* * A string that can contain references to other entity types (with or without aliases).
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type#value DialogflowEntityType#value}
*/
readonly value: string;
}
export declare function dialogflowEntityTypeEntitiesToTerraform(struct?: DialogflowEntityTypeEntities | cdktf.IResolvable): any;
export declare function dialogflowEntityTypeEntitiesToHclTerraform(struct?: DialogflowEntityTypeEntities | cdktf.IResolvable): any;
export declare class DialogflowEntityTypeEntitiesOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param complexObjectIndex the index of this item in the list
* @param complexObjectIsFromSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean);
get internalValue(): DialogflowEntityTypeEntities | cdktf.IResolvable | undefined;
set internalValue(value: DialogflowEntityTypeEntities | cdktf.IResolvable | undefined);
private _synonyms?;
get synonyms(): string[];
set synonyms(value: string[]);
get synonymsInput(): string[] | undefined;
private _value?;
get value(): string;
set value(value: string);
get valueInput(): string | undefined;
}
export declare class DialogflowEntityTypeEntitiesList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
internalValue?: DialogflowEntityTypeEntities[] | cdktf.IResolvable;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param wrapsSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean);
/**
* @param index the index of the item to return
*/
get(index: number): DialogflowEntityTypeEntitiesOutputReference;
}
export interface DialogflowEntityTypeTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type#create DialogflowEntityType#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type#delete DialogflowEntityType#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type#update DialogflowEntityType#update}
*/
readonly update?: string;
}
export declare function dialogflowEntityTypeTimeoutsToTerraform(struct?: DialogflowEntityTypeTimeouts | cdktf.IResolvable): any;
export declare function dialogflowEntityTypeTimeoutsToHclTerraform(struct?: DialogflowEntityTypeTimeouts | cdktf.IResolvable): any;
export declare class DialogflowEntityTypeTimeoutsOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
get internalValue(): DialogflowEntityTypeTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: DialogflowEntityTypeTimeouts | cdktf.IResolvable | undefined);
private _create?;
get create(): string;
set create(value: string);
resetCreate(): void;
get createInput(): string | undefined;
private _delete?;
get delete(): string;
set delete(value: string);
resetDelete(): void;
get deleteInput(): string | undefined;
private _update?;
get update(): string;
set update(value: string);
resetUpdate(): void;
get updateInput(): string | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type google_dialogflow_entity_type}
*/
export declare class DialogflowEntityType extends cdktf.TerraformResource {
static readonly tfResourceType = "google_dialogflow_entity_type";
/**
* Generates CDKTF code for importing a DialogflowEntityType resource upon running "cdktf plan <stack-name>"
* @param scope The scope in which to define this construct
* @param importToId The construct id used in the generated config for the DialogflowEntityType to import
* @param importFromId The id of the existing DialogflowEntityType that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the DialogflowEntityType to import is found
*/
static generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: cdktf.TerraformProvider): cdktf.ImportableResource;
/**
* Create a new {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dialogflow_entity_type google_dialogflow_entity_type} Resource
*
* @param scope The scope in which to define this construct
* @param id The scoped construct ID. Must be unique amongst siblings in the same scope
* @param options DialogflowEntityTypeConfig
*/
constructor(scope: Construct, id: string, config: DialogflowEntityTypeConfig);
private _displayName?;
get displayName(): string;
set displayName(value: string);
get displayNameInput(): string | undefined;
private _enableFuzzyExtraction?;
get enableFuzzyExtraction(): boolean | cdktf.IResolvable;
set enableFuzzyExtraction(value: boolean | cdktf.IResolvable);
resetEnableFuzzyExtraction(): void;
get enableFuzzyExtractionInput(): boolean | cdktf.IResolvable | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _kind?;
get kind(): string;
set kind(value: string);
get kindInput(): string | undefined;
get name(): string;
private _project?;
get project(): string;
set project(value: string);
resetProject(): void;
get projectInput(): string | undefined;
private _entities;
get entities(): DialogflowEntityTypeEntitiesList;
putEntities(value: DialogflowEntityTypeEntities[] | cdktf.IResolvable): void;
resetEntities(): void;
get entitiesInput(): cdktf.IResolvable | DialogflowEntityTypeEntities[] | undefined;
private _timeouts;
get timeouts(): DialogflowEntityTypeTimeoutsOutputReference;
putTimeouts(value: DialogflowEntityTypeTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | DialogflowEntityTypeTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}