AppArgs class

The set of arguments for App. The set of arguments for App.

Constructors

AppArgs({required Input<String> appId, Input<AppAudioProcessingConfig?>? audioProcessingConfig, Input<AppClientCertificateSettings?>? clientCertificateSettings, Input<AppDataStoreSettings?>? dataStoreSettings, Input<AppDefaultChannelProfile?>? defaultChannelProfile, Input<String?>? deletionPolicy, Input<String?>? description, required Input<String> displayName, Input<AppEvaluationMetricsThresholds?>? evaluationMetricsThresholds, Input<String?>? globalInstruction, Input<List<String>?>? guardrails, Input<AppLanguageSettings?>? languageSettings, required Input<String> location, Input<AppLoggingSettings?>? loggingSettings, Input<Map<String, String>?>? metadata, Input<AppModelSettings?>? modelSettings, Input<bool?>? pinned, Input<String?>? project, Input<String?>? rootAgent, Input<AppTimeZoneSettings?>? timeZoneSettings, Input<String?>? toolExecutionMode, Input<List<AppVariableDeclaration>?>? variableDeclarations})
Creates a new AppArgs. appId The ID to use for the app, which will become the final component of audioProcessingConfig Configuration for how the input and output audio should be processed and clientCertificateSettings The default client certificate settings for the app. dataStoreSettings Data store related settings for the app. defaultChannelProfile A ChannelProfile configures the agent's behavior for a specific communication deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description Human-readable description of the app. displayName Display name of the app. evaluationMetricsThresholds Threshold settings for metrics in an Evaluation. globalInstruction Instructions for all the agents in the app. guardrails List of guardrails for the app. languageSettings Language settings of the app. location Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. loggingSettings Settings to describe the logging behaviors for the app. metadata Metadata about the app. This field can be used to store additional modelSettings Model settings contains various configurations for the LLM model. pinned Whether the app is pinned in the app list. project The ID of the project in which the resource belongs. rootAgent The root agent is the entry point of the app. timeZoneSettings TimeZone settings of the app. toolExecutionMode The tool execution mode for the app. variableDeclarations The declarations of the variables.
const
AppArgs.fromMap(Map<String, dynamic> map)
factory

Properties

appId → Input<String>
The ID to use for the app, which will become the final component of the app's resource name. If not provided, a unique ID will be automatically assigned for the app.
final
audioProcessingConfig → Input<AppAudioProcessingConfig?>?
Configuration for how the input and output audio should be processed and delivered. Structure is documented below.
final
clientCertificateSettings → Input<AppClientCertificateSettings?>?
The default client certificate settings for the app. Structure is documented below.
final
dataStoreSettings → Input<AppDataStoreSettings?>?
Data store related settings for the app. Structure is documented below.
final
defaultChannelProfile → Input<AppDefaultChannelProfile?>?
A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. Structure is documented below.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String?>?
Human-readable description of the app.
final
displayName → Input<String>
Display name of the app.
final
evaluationMetricsThresholds → Input<AppEvaluationMetricsThresholds?>?
Threshold settings for metrics in an Evaluation. Structure is documented below.
final
globalInstruction → Input<String?>?
Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.
final
guardrails → Input<List<String>?>?
List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
final
hashCode → int
The hash code for this object.
no setterinherited
languageSettings → Input<AppLanguageSettings?>?
Language settings of the app. Structure is documented below.
final
location → Input<String>
Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
final
loggingSettings → Input<AppLoggingSettings?>?
Settings to describe the logging behaviors for the app. Structure is documented below.
final
metadata → Input<Map<String, String>?>?
Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
final
modelSettings → Input<AppModelSettings?>?
Model settings contains various configurations for the LLM model. Structure is documented below.
final
pinned → Input<bool?>?
Whether the app is pinned in the app list.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
rootAgent → Input<String?>?
The root agent is the entry point of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
timeZoneSettings → Input<AppTimeZoneSettings?>?
TimeZone settings of the app. Structure is documented below.
final
toolExecutionMode → Input<String?>?
The tool execution mode for the app. See the API reference for more details.
final
variableDeclarations → Input<List<AppVariableDeclaration>?>?
The declarations of the variables. Structure is documented below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited