Class App.Builder (0.1.0)

public static final class App.Builder extends GeneratedMessage.Builder<App.Builder> implements AppOrBuilder

An app serves as a top-level container for a group of agents, including the root agent and its sub-agents, along with their associated configurations. These agents work together to achieve specific goals within the app's context.

Protobuf type google.cloud.ces.v1.App

Implements

AppOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllGuardrails(Iterable<String> values)

public App.Builder addAllGuardrails(Iterable<String> values)

Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The guardrails to add.

Returns
Type Description
App.Builder

This builder for chaining.

addAllPredefinedVariableDeclarations(Iterable<? extends App.VariableDeclaration> values)

public App.Builder addAllPredefinedVariableDeclarations(Iterable<? extends App.VariableDeclaration> values)

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.ces.v1.App.VariableDeclaration>
Returns
Type Description
App.Builder

addAllVariableDeclarations(Iterable<? extends App.VariableDeclaration> values)

public App.Builder addAllVariableDeclarations(Iterable<? extends App.VariableDeclaration> values)

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.ces.v1.App.VariableDeclaration>
Returns
Type Description
App.Builder

addGuardrails(String value)

public App.Builder addGuardrails(String value)

Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The guardrails to add.

Returns
Type Description
App.Builder

This builder for chaining.

addGuardrailsBytes(ByteString value)

public App.Builder addGuardrailsBytes(ByteString value)

Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the guardrails to add.

Returns
Type Description
App.Builder

This builder for chaining.

addPredefinedVariableDeclarations(App.VariableDeclaration value)

public App.Builder addPredefinedVariableDeclarations(App.VariableDeclaration value)

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value App.VariableDeclaration
Returns
Type Description
App.Builder

addPredefinedVariableDeclarations(App.VariableDeclaration.Builder builderForValue)

public App.Builder addPredefinedVariableDeclarations(App.VariableDeclaration.Builder builderForValue)

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue App.VariableDeclaration.Builder
Returns
Type Description
App.Builder

addPredefinedVariableDeclarations(int index, App.VariableDeclaration value)

public App.Builder addPredefinedVariableDeclarations(int index, App.VariableDeclaration value)

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value App.VariableDeclaration
Returns
Type Description
App.Builder

addPredefinedVariableDeclarations(int index, App.VariableDeclaration.Builder builderForValue)

public App.Builder addPredefinedVariableDeclarations(int index, App.VariableDeclaration.Builder builderForValue)

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue App.VariableDeclaration.Builder
Returns
Type Description
App.Builder

addPredefinedVariableDeclarationsBuilder()

public App.VariableDeclaration.Builder addPredefinedVariableDeclarationsBuilder()

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
App.VariableDeclaration.Builder

addPredefinedVariableDeclarationsBuilder(int index)

public App.VariableDeclaration.Builder addPredefinedVariableDeclarationsBuilder(int index)

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
App.VariableDeclaration.Builder

addVariableDeclarations(App.VariableDeclaration value)

public App.Builder addVariableDeclarations(App.VariableDeclaration value)

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value App.VariableDeclaration
Returns
Type Description
App.Builder

addVariableDeclarations(App.VariableDeclaration.Builder builderForValue)

public App.Builder addVariableDeclarations(App.VariableDeclaration.Builder builderForValue)

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue App.VariableDeclaration.Builder
Returns
Type Description
App.Builder

addVariableDeclarations(int index, App.VariableDeclaration value)

public App.Builder addVariableDeclarations(int index, App.VariableDeclaration value)

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value App.VariableDeclaration
Returns
Type Description
App.Builder

addVariableDeclarations(int index, App.VariableDeclaration.Builder builderForValue)

public App.Builder addVariableDeclarations(int index, App.VariableDeclaration.Builder builderForValue)

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue App.VariableDeclaration.Builder
Returns
Type Description
App.Builder

addVariableDeclarationsBuilder()

public App.VariableDeclaration.Builder addVariableDeclarationsBuilder()

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.VariableDeclaration.Builder

addVariableDeclarationsBuilder(int index)

public App.VariableDeclaration.Builder addVariableDeclarationsBuilder(int index)

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
App.VariableDeclaration.Builder

build()

public App build()
Returns
Type Description
App

buildPartial()

public App buildPartial()
Returns
Type Description
App

clear()

public App.Builder clear()
Returns
Type Description
App.Builder
Overrides

clearAudioProcessingConfig()

public App.Builder clearAudioProcessingConfig()

Optional. Audio processing configuration of the app.

.google.cloud.ces.v1.AudioProcessingConfig audio_processing_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

clearClientCertificateSettings()

public App.Builder clearClientCertificateSettings()

Optional. The default client certificate settings for the app.

.google.cloud.ces.v1.ClientCertificateSettings client_certificate_settings = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

clearCreateTime()

public App.Builder clearCreateTime()

Output only. Timestamp when the app was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
App.Builder

clearDataStoreSettings()

public App.Builder clearDataStoreSettings()

Optional. The data store settings for the app.

.google.cloud.ces.v1.DataStoreSettings data_store_settings = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

clearDefaultChannelProfile()

public App.Builder clearDefaultChannelProfile()

Optional. The default channel profile used by the app.

.google.cloud.ces.v1.ChannelProfile default_channel_profile = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

clearDeploymentCount()

public App.Builder clearDeploymentCount()

Output only. Number of deployments in the app.

int32 deployment_count = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
App.Builder

This builder for chaining.

clearDescription()

public App.Builder clearDescription()

Optional. Human-readable description of the app.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

This builder for chaining.

clearDisplayName()

public App.Builder clearDisplayName()

Required. Display name of the app.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
App.Builder

This builder for chaining.

clearEtag()

public App.Builder clearEtag()

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
App.Builder

This builder for chaining.

clearEvaluationMetricsThresholds()

public App.Builder clearEvaluationMetricsThresholds()

Optional. The evaluation thresholds for the app.

.google.cloud.ces.v1.EvaluationMetricsThresholds evaluation_metrics_thresholds = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

clearGlobalInstruction()

public App.Builder clearGlobalInstruction()

Optional. 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.

string global_instruction = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

This builder for chaining.

clearGuardrails()

public App.Builder clearGuardrails()

Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
App.Builder

This builder for chaining.

clearLanguageSettings()

public App.Builder clearLanguageSettings()

Optional. Language settings of the app.

.google.cloud.ces.v1.LanguageSettings language_settings = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

clearLocked()

public App.Builder clearLocked()

Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.

bool locked = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

This builder for chaining.

clearLoggingSettings()

public App.Builder clearLoggingSettings()

Optional. Logging settings of the app.

.google.cloud.ces.v1.LoggingSettings logging_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

clearMetadata()

public App.Builder clearMetadata()
Returns
Type Description
App.Builder

clearModelSettings()

public App.Builder clearModelSettings()

Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.

.google.cloud.ces.v1.ModelSettings model_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

clearName()

public App.Builder clearName()

Identifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
App.Builder

This builder for chaining.

clearPinned()

public App.Builder clearPinned()

Optional. Whether the app is pinned in the app list.

bool pinned = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

This builder for chaining.

clearPredefinedVariableDeclarations()

public App.Builder clearPredefinedVariableDeclarations()

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
App.Builder

clearRootAgent()

public App.Builder clearRootAgent()

Optional. The root agent is the entry point of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

string root_agent = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
App.Builder

This builder for chaining.

clearTimeZoneSettings()

public App.Builder clearTimeZoneSettings()

Optional. TimeZone settings of the app.

.google.cloud.ces.v1.TimeZoneSettings time_zone_settings = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

clearToolExecutionMode()

public App.Builder clearToolExecutionMode()

Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.

.google.cloud.ces.v1.App.ToolExecutionMode tool_execution_mode = 32 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

This builder for chaining.

clearUpdateTime()

public App.Builder clearUpdateTime()

Output only. Timestamp when the app was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
App.Builder

clearVariableDeclarations()

public App.Builder clearVariableDeclarations()

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.Builder

containsMetadata(String key)

public boolean containsMetadata(String key)

Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.

map<string, string> metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getAudioProcessingConfig()

public AudioProcessingConfig getAudioProcessingConfig()

Optional. Audio processing configuration of the app.

.google.cloud.ces.v1.AudioProcessingConfig audio_processing_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudioProcessingConfig

The audioProcessingConfig.

getAudioProcessingConfigBuilder()

public AudioProcessingConfig.Builder getAudioProcessingConfigBuilder()

Optional. Audio processing configuration of the app.

.google.cloud.ces.v1.AudioProcessingConfig audio_processing_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudioProcessingConfig.Builder

getAudioProcessingConfigOrBuilder()

public AudioProcessingConfigOrBuilder getAudioProcessingConfigOrBuilder()

Optional. Audio processing configuration of the app.

.google.cloud.ces.v1.AudioProcessingConfig audio_processing_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudioProcessingConfigOrBuilder

getClientCertificateSettings()

public ClientCertificateSettings getClientCertificateSettings()

Optional. The default client certificate settings for the app.

.google.cloud.ces.v1.ClientCertificateSettings client_certificate_settings = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientCertificateSettings

The clientCertificateSettings.

getClientCertificateSettingsBuilder()

public ClientCertificateSettings.Builder getClientCertificateSettingsBuilder()

Optional. The default client certificate settings for the app.

.google.cloud.ces.v1.ClientCertificateSettings client_certificate_settings = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientCertificateSettings.Builder

getClientCertificateSettingsOrBuilder()

public ClientCertificateSettingsOrBuilder getClientCertificateSettingsOrBuilder()

Optional. The default client certificate settings for the app.

.google.cloud.ces.v1.ClientCertificateSettings client_certificate_settings = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ClientCertificateSettingsOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when the app was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when the app was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when the app was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDataStoreSettings()

public DataStoreSettings getDataStoreSettings()

Optional. The data store settings for the app.

.google.cloud.ces.v1.DataStoreSettings data_store_settings = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataStoreSettings

The dataStoreSettings.

getDataStoreSettingsBuilder()

public DataStoreSettings.Builder getDataStoreSettingsBuilder()

Optional. The data store settings for the app.

.google.cloud.ces.v1.DataStoreSettings data_store_settings = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataStoreSettings.Builder

getDataStoreSettingsOrBuilder()

public DataStoreSettingsOrBuilder getDataStoreSettingsOrBuilder()

Optional. The data store settings for the app.

.google.cloud.ces.v1.DataStoreSettings data_store_settings = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataStoreSettingsOrBuilder

getDefaultChannelProfile()

public ChannelProfile getDefaultChannelProfile()

Optional. The default channel profile used by the app.

.google.cloud.ces.v1.ChannelProfile default_channel_profile = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ChannelProfile

The defaultChannelProfile.

getDefaultChannelProfileBuilder()

public ChannelProfile.Builder getDefaultChannelProfileBuilder()

Optional. The default channel profile used by the app.

.google.cloud.ces.v1.ChannelProfile default_channel_profile = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ChannelProfile.Builder

getDefaultChannelProfileOrBuilder()

public ChannelProfileOrBuilder getDefaultChannelProfileOrBuilder()

Optional. The default channel profile used by the app.

.google.cloud.ces.v1.ChannelProfile default_channel_profile = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ChannelProfileOrBuilder

getDefaultInstanceForType()

public App getDefaultInstanceForType()
Returns
Type Description
App

getDeploymentCount()

public int getDeploymentCount()

Output only. Number of deployments in the app.

int32 deployment_count = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The deploymentCount.

getDescription()

public String getDescription()

Optional. Human-readable description of the app.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Human-readable description of the app.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Required. Display name of the app.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Display name of the app.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for etag.

getEvaluationMetricsThresholds()

public EvaluationMetricsThresholds getEvaluationMetricsThresholds()

Optional. The evaluation thresholds for the app.

.google.cloud.ces.v1.EvaluationMetricsThresholds evaluation_metrics_thresholds = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EvaluationMetricsThresholds

The evaluationMetricsThresholds.

getEvaluationMetricsThresholdsBuilder()

public EvaluationMetricsThresholds.Builder getEvaluationMetricsThresholdsBuilder()

Optional. The evaluation thresholds for the app.

.google.cloud.ces.v1.EvaluationMetricsThresholds evaluation_metrics_thresholds = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EvaluationMetricsThresholds.Builder

getEvaluationMetricsThresholdsOrBuilder()

public EvaluationMetricsThresholdsOrBuilder getEvaluationMetricsThresholdsOrBuilder()

Optional. The evaluation thresholds for the app.

.google.cloud.ces.v1.EvaluationMetricsThresholds evaluation_metrics_thresholds = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EvaluationMetricsThresholdsOrBuilder

getGlobalInstruction()

public String getGlobalInstruction()

Optional. 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.

string global_instruction = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The globalInstruction.

getGlobalInstructionBytes()

public ByteString getGlobalInstructionBytes()

Optional. 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.

string global_instruction = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for globalInstruction.

getGuardrails(int index)

public String getGuardrails(int index)

Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The guardrails at the given index.

getGuardrailsBytes(int index)

public ByteString getGuardrailsBytes(int index)

Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the guardrails at the given index.

getGuardrailsCount()

public int getGuardrailsCount()

Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of guardrails.

getGuardrailsList()

public ProtocolStringList getGuardrailsList()

Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the guardrails.

getLanguageSettings()

public LanguageSettings getLanguageSettings()

Optional. Language settings of the app.

.google.cloud.ces.v1.LanguageSettings language_settings = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LanguageSettings

The languageSettings.

getLanguageSettingsBuilder()

public LanguageSettings.Builder getLanguageSettingsBuilder()

Optional. Language settings of the app.

.google.cloud.ces.v1.LanguageSettings language_settings = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LanguageSettings.Builder

getLanguageSettingsOrBuilder()

public LanguageSettingsOrBuilder getLanguageSettingsOrBuilder()

Optional. Language settings of the app.

.google.cloud.ces.v1.LanguageSettings language_settings = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LanguageSettingsOrBuilder

getLocked()

public boolean getLocked()

Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.

bool locked = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The locked.

getLoggingSettings()

public LoggingSettings getLoggingSettings()

Optional. Logging settings of the app.

.google.cloud.ces.v1.LoggingSettings logging_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LoggingSettings

The loggingSettings.

getLoggingSettingsBuilder()

public LoggingSettings.Builder getLoggingSettingsBuilder()

Optional. Logging settings of the app.

.google.cloud.ces.v1.LoggingSettings logging_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LoggingSettings.Builder

getLoggingSettingsOrBuilder()

public LoggingSettingsOrBuilder getLoggingSettingsOrBuilder()

Optional. Logging settings of the app.

.google.cloud.ces.v1.LoggingSettings logging_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LoggingSettingsOrBuilder

getMetadata() (deprecated)

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

public int getMetadataCount()

Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.

map<string, string> metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getMetadataMap()

public Map<String,String> getMetadataMap()

Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.

map<string, string> metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public String getMetadataOrDefault(String key, String defaultValue)

Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.

map<string, string> metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getMetadataOrThrow(String key)

public String getMetadataOrThrow(String key)

Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.

map<string, string> metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getModelSettings()

public ModelSettings getModelSettings()

Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.

.google.cloud.ces.v1.ModelSettings model_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ModelSettings

The modelSettings.

getModelSettingsBuilder()

public ModelSettings.Builder getModelSettingsBuilder()

Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.

.google.cloud.ces.v1.ModelSettings model_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ModelSettings.Builder

getModelSettingsOrBuilder()

public ModelSettingsOrBuilder getModelSettingsOrBuilder()

Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.

.google.cloud.ces.v1.ModelSettings model_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ModelSettingsOrBuilder

getMutableMetadata() (deprecated)

public Map<String,String> getMutableMetadata()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Identifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPinned()

public boolean getPinned()

Optional. Whether the app is pinned in the app list.

bool pinned = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The pinned.

getPredefinedVariableDeclarations(int index)

public App.VariableDeclaration getPredefinedVariableDeclarations(int index)

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
App.VariableDeclaration

getPredefinedVariableDeclarationsBuilder(int index)

public App.VariableDeclaration.Builder getPredefinedVariableDeclarationsBuilder(int index)

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
App.VariableDeclaration.Builder

getPredefinedVariableDeclarationsBuilderList()

public List<App.VariableDeclaration.Builder> getPredefinedVariableDeclarationsBuilderList()

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getPredefinedVariableDeclarationsCount()

public int getPredefinedVariableDeclarationsCount()

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getPredefinedVariableDeclarationsList()

public List<App.VariableDeclaration> getPredefinedVariableDeclarationsList()

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<VariableDeclaration>

getPredefinedVariableDeclarationsOrBuilder(int index)

public App.VariableDeclarationOrBuilder getPredefinedVariableDeclarationsOrBuilder(int index)

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
App.VariableDeclarationOrBuilder

getPredefinedVariableDeclarationsOrBuilderList()

public List<? extends App.VariableDeclarationOrBuilder> getPredefinedVariableDeclarationsOrBuilderList()

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.ces.v1.App.VariableDeclarationOrBuilder>

getRootAgent()

public String getRootAgent()

Optional. The root agent is the entry point of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

string root_agent = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The rootAgent.

getRootAgentBytes()

public ByteString getRootAgentBytes()

Optional. The root agent is the entry point of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

string root_agent = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for rootAgent.

getTimeZoneSettings()

public TimeZoneSettings getTimeZoneSettings()

Optional. TimeZone settings of the app.

.google.cloud.ces.v1.TimeZoneSettings time_zone_settings = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimeZoneSettings

The timeZoneSettings.

getTimeZoneSettingsBuilder()

public TimeZoneSettings.Builder getTimeZoneSettingsBuilder()

Optional. TimeZone settings of the app.

.google.cloud.ces.v1.TimeZoneSettings time_zone_settings = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimeZoneSettings.Builder

getTimeZoneSettingsOrBuilder()

public TimeZoneSettingsOrBuilder getTimeZoneSettingsOrBuilder()

Optional. TimeZone settings of the app.

.google.cloud.ces.v1.TimeZoneSettings time_zone_settings = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimeZoneSettingsOrBuilder

getToolExecutionMode()

public App.ToolExecutionMode getToolExecutionMode()

Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.

.google.cloud.ces.v1.App.ToolExecutionMode tool_execution_mode = 32 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
App.ToolExecutionMode

The toolExecutionMode.

getToolExecutionModeValue()

public int getToolExecutionModeValue()

Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.

.google.cloud.ces.v1.App.ToolExecutionMode tool_execution_mode = 32 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for toolExecutionMode.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when the app was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when the app was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when the app was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getVariableDeclarations(int index)

public App.VariableDeclaration getVariableDeclarations(int index)

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
App.VariableDeclaration

getVariableDeclarationsBuilder(int index)

public App.VariableDeclaration.Builder getVariableDeclarationsBuilder(int index)

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
App.VariableDeclaration.Builder

getVariableDeclarationsBuilderList()

public List<App.VariableDeclaration.Builder> getVariableDeclarationsBuilderList()

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getVariableDeclarationsCount()

public int getVariableDeclarationsCount()

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getVariableDeclarationsList()

public List<App.VariableDeclaration> getVariableDeclarationsList()

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<VariableDeclaration>

getVariableDeclarationsOrBuilder(int index)

public App.VariableDeclarationOrBuilder getVariableDeclarationsOrBuilder(int index)

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
App.VariableDeclarationOrBuilder

getVariableDeclarationsOrBuilderList()

public List<? extends App.VariableDeclarationOrBuilder> getVariableDeclarationsOrBuilderList()

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.ces.v1.App.VariableDeclarationOrBuilder>

hasAudioProcessingConfig()

public boolean hasAudioProcessingConfig()

Optional. Audio processing configuration of the app.

.google.cloud.ces.v1.AudioProcessingConfig audio_processing_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the audioProcessingConfig field is set.

hasClientCertificateSettings()

public boolean hasClientCertificateSettings()

Optional. The default client certificate settings for the app.

.google.cloud.ces.v1.ClientCertificateSettings client_certificate_settings = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the clientCertificateSettings field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when the app was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDataStoreSettings()

public boolean hasDataStoreSettings()

Optional. The data store settings for the app.

.google.cloud.ces.v1.DataStoreSettings data_store_settings = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataStoreSettings field is set.

hasDefaultChannelProfile()

public boolean hasDefaultChannelProfile()

Optional. The default channel profile used by the app.

.google.cloud.ces.v1.ChannelProfile default_channel_profile = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the defaultChannelProfile field is set.

hasEvaluationMetricsThresholds()

public boolean hasEvaluationMetricsThresholds()

Optional. The evaluation thresholds for the app.

.google.cloud.ces.v1.EvaluationMetricsThresholds evaluation_metrics_thresholds = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the evaluationMetricsThresholds field is set.

hasLanguageSettings()

public boolean hasLanguageSettings()

Optional. Language settings of the app.

.google.cloud.ces.v1.LanguageSettings language_settings = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the languageSettings field is set.

hasLoggingSettings()

public boolean hasLoggingSettings()

Optional. Logging settings of the app.

.google.cloud.ces.v1.LoggingSettings logging_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the loggingSettings field is set.

hasModelSettings()

public boolean hasModelSettings()

Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.

.google.cloud.ces.v1.ModelSettings model_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the modelSettings field is set.

hasTimeZoneSettings()

public boolean hasTimeZoneSettings()

Optional. TimeZone settings of the app.

.google.cloud.ces.v1.TimeZoneSettings time_zone_settings = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the timeZoneSettings field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when the app was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAudioProcessingConfig(AudioProcessingConfig value)

public App.Builder mergeAudioProcessingConfig(AudioProcessingConfig value)

Optional. Audio processing configuration of the app.

.google.cloud.ces.v1.AudioProcessingConfig audio_processing_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AudioProcessingConfig
Returns
Type Description
App.Builder

mergeClientCertificateSettings(ClientCertificateSettings value)

public App.Builder mergeClientCertificateSettings(ClientCertificateSettings value)

Optional. The default client certificate settings for the app.

.google.cloud.ces.v1.ClientCertificateSettings client_certificate_settings = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ClientCertificateSettings
Returns
Type Description
App.Builder

mergeCreateTime(Timestamp value)

public App.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when the app was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
App.Builder

mergeDataStoreSettings(DataStoreSettings value)

public App.Builder mergeDataStoreSettings(DataStoreSettings value)

Optional. The data store settings for the app.

.google.cloud.ces.v1.DataStoreSettings data_store_settings = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataStoreSettings
Returns
Type Description
App.Builder

mergeDefaultChannelProfile(ChannelProfile value)

public App.Builder mergeDefaultChannelProfile(ChannelProfile value)

Optional. The default channel profile used by the app.

.google.cloud.ces.v1.ChannelProfile default_channel_profile = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ChannelProfile
Returns
Type Description
App.Builder

mergeEvaluationMetricsThresholds(EvaluationMetricsThresholds value)

public App.Builder mergeEvaluationMetricsThresholds(EvaluationMetricsThresholds value)

Optional. The evaluation thresholds for the app.

.google.cloud.ces.v1.EvaluationMetricsThresholds evaluation_metrics_thresholds = 24 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EvaluationMetricsThresholds
Returns
Type Description
App.Builder

mergeFrom(App other)

public App.Builder mergeFrom(App other)
Parameter
Name Description
other App
Returns
Type Description
App.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public App.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
App.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public App.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
App.Builder
Overrides

mergeLanguageSettings(LanguageSettings value)

public App.Builder mergeLanguageSettings(LanguageSettings value)

Optional. Language settings of the app.

.google.cloud.ces.v1.LanguageSettings language_settings = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LanguageSettings
Returns
Type Description
App.Builder

mergeLoggingSettings(LoggingSettings value)

public App.Builder mergeLoggingSettings(LoggingSettings value)

Optional. Logging settings of the app.

.google.cloud.ces.v1.LoggingSettings logging_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LoggingSettings
Returns
Type Description
App.Builder

mergeModelSettings(ModelSettings value)

public App.Builder mergeModelSettings(ModelSettings value)

Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.

.google.cloud.ces.v1.ModelSettings model_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ModelSettings
Returns
Type Description
App.Builder

mergeTimeZoneSettings(TimeZoneSettings value)

public App.Builder mergeTimeZoneSettings(TimeZoneSettings value)

Optional. TimeZone settings of the app.

.google.cloud.ces.v1.TimeZoneSettings time_zone_settings = 27 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value TimeZoneSettings
Returns
Type Description
App.Builder

mergeUpdateTime(Timestamp value)

public App.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when the app was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
App.Builder

putAllMetadata(Map<String,String> values)

public App.Builder putAllMetadata(Map<String,String> values)

Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.

map<string, string> metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
App.Builder

putMetadata(String key, String value)

public App.Builder putMetadata(String key, String value)

Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.

map<string, string> metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
App.Builder

removeMetadata(String key)

public App.Builder removeMetadata(String key)

Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.

map<string, string> metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
App.Builder

removePredefinedVariableDeclarations(int index)

public App.Builder removePredefinedVariableDeclarations(int index)

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
App.Builder

removeVariableDeclarations(int index)

public App.Builder removeVariableDeclarations(int index)

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
App.Builder

setAudioProcessingConfig(AudioProcessingConfig value)

public App.Builder setAudioProcessingConfig(AudioProcessingConfig value)

Optional. Audio processing configuration of the app.

.google.cloud.ces.v1.AudioProcessingConfig audio_processing_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AudioProcessingConfig
Returns
Type Description
App.Builder

setAudioProcessingConfig(AudioProcessingConfig.Builder builderForValue)

public App.Builder setAudioProcessingConfig(AudioProcessingConfig.Builder builderForValue)

Optional. Audio processing configuration of the app.

.google.cloud.ces.v1.AudioProcessingConfig audio_processing_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue AudioProcessingConfig.Builder
Returns
Type Description
App.Builder

setClientCertificateSettings(ClientCertificateSettings value)

public App.Builder setClientCertificateSettings(ClientCertificateSettings value)

Optional. The default client certificate settings for the app.

.google.cloud.ces.v1.ClientCertificateSettings client_certificate_settings = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ClientCertificateSettings
Returns
Type Description
App.Builder

setClientCertificateSettings(ClientCertificateSettings.Builder builderForValue)

public App.Builder setClientCertificateSettings(ClientCertificateSettings.Builder builderForValue)

Optional. The default client certificate settings for the app.

.google.cloud.ces.v1.ClientCertificateSettings client_certificate_settings = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ClientCertificateSettings.Builder
Returns
Type Description
App.Builder

setCreateTime(Timestamp value)

public App.Builder setCreateTime(Timestamp value)

Output only. Timestamp when the app was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
App.Builder

setCreateTime(Timestamp.Builder builderForValue)

public App.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the app was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
App.Builder

setDataStoreSettings(DataStoreSettings value)

public App.Builder setDataStoreSettings(DataStoreSettings value)

Optional. The data store settings for the app.

.google.cloud.ces.v1.DataStoreSettings data_store_settings = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DataStoreSettings
Returns
Type Description
App.Builder

setDataStoreSettings(DataStoreSettings.Builder builderForValue)

public App.Builder setDataStoreSettings(DataStoreSettings.Builder builderForValue)

Optional. The data store settings for the app.

.google.cloud.ces.v1.DataStoreSettings data_store_settings = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DataStoreSettings.Builder
Returns
Type Description
App.Builder

setDefaultChannelProfile(ChannelProfile value)

public App.Builder setDefaultChannelProfile(ChannelProfile value)

Optional. The default channel profile used by the app.

.google.cloud.ces.v1.ChannelProfile default_channel_profile = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ChannelProfile
Returns
Type Description
App.Builder

setDefaultChannelProfile(ChannelProfile.Builder builderForValue)

public App.Builder setDefaultChannelProfile(ChannelProfile.Builder builderForValue)

Optional. The default channel profile used by the app.

.google.cloud.ces.v1.ChannelProfile default_channel_profile = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ChannelProfile.Builder
Returns
Type Description
App.Builder

setDeploymentCount(int value)

public App.Builder setDeploymentCount(int value)

Output only. Number of deployments in the app.

int32 deployment_count = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The deploymentCount to set.

Returns
Type Description
App.Builder

This builder for chaining.

setDescription(String value)

public App.Builder setDescription(String value)

Optional. Human-readable description of the app.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
App.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public App.Builder setDescriptionBytes(ByteString value)

Optional. Human-readable description of the app.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
App.Builder

This builder for chaining.

setDisplayName(String value)

public App.Builder setDisplayName(String value)

Required. Display name of the app.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
App.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public App.Builder setDisplayNameBytes(ByteString value)

Required. Display name of the app.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
App.Builder

This builder for chaining.

setEtag(String value)

public App.Builder setEtag(String value)

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
App.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public App.Builder setEtagBytes(ByteString value)

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

string etag = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
App.Builder

This builder for chaining.

setEvaluationMetricsThresholds(EvaluationMetricsThresholds value)

public App.Builder setEvaluationMetricsThresholds(EvaluationMetricsThresholds value)

Optional. The evaluation thresholds for the app.

.google.cloud.ces.v1.EvaluationMetricsThresholds evaluation_metrics_thresholds = 24 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EvaluationMetricsThresholds
Returns
Type Description
App.Builder

setEvaluationMetricsThresholds(EvaluationMetricsThresholds.Builder builderForValue)

public App.Builder setEvaluationMetricsThresholds(EvaluationMetricsThresholds.Builder builderForValue)

Optional. The evaluation thresholds for the app.

.google.cloud.ces.v1.EvaluationMetricsThresholds evaluation_metrics_thresholds = 24 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue EvaluationMetricsThresholds.Builder
Returns
Type Description
App.Builder

setGlobalInstruction(String value)

public App.Builder setGlobalInstruction(String value)

Optional. 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.

string global_instruction = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The globalInstruction to set.

Returns
Type Description
App.Builder

This builder for chaining.

setGlobalInstructionBytes(ByteString value)

public App.Builder setGlobalInstructionBytes(ByteString value)

Optional. 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.

string global_instruction = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for globalInstruction to set.

Returns
Type Description
App.Builder

This builder for chaining.

setGuardrails(int index, String value)

public App.Builder setGuardrails(int index, String value)

Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

repeated string guardrails = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The guardrails to set.

Returns
Type Description
App.Builder

This builder for chaining.

setLanguageSettings(LanguageSettings value)

public App.Builder setLanguageSettings(LanguageSettings value)

Optional. Language settings of the app.

.google.cloud.ces.v1.LanguageSettings language_settings = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LanguageSettings
Returns
Type Description
App.Builder

setLanguageSettings(LanguageSettings.Builder builderForValue)

public App.Builder setLanguageSettings(LanguageSettings.Builder builderForValue)

Optional. Language settings of the app.

.google.cloud.ces.v1.LanguageSettings language_settings = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue LanguageSettings.Builder
Returns
Type Description
App.Builder

setLocked(boolean value)

public App.Builder setLocked(boolean value)

Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.

bool locked = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The locked to set.

Returns
Type Description
App.Builder

This builder for chaining.

setLoggingSettings(LoggingSettings value)

public App.Builder setLoggingSettings(LoggingSettings value)

Optional. Logging settings of the app.

.google.cloud.ces.v1.LoggingSettings logging_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LoggingSettings
Returns
Type Description
App.Builder

setLoggingSettings(LoggingSettings.Builder builderForValue)

public App.Builder setLoggingSettings(LoggingSettings.Builder builderForValue)

Optional. Logging settings of the app.

.google.cloud.ces.v1.LoggingSettings logging_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue LoggingSettings.Builder
Returns
Type Description
App.Builder

setModelSettings(ModelSettings value)

public App.Builder setModelSettings(ModelSettings value)

Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.

.google.cloud.ces.v1.ModelSettings model_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ModelSettings
Returns
Type Description
App.Builder

setModelSettings(ModelSettings.Builder builderForValue)

public App.Builder setModelSettings(ModelSettings.Builder builderForValue)

Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.

.google.cloud.ces.v1.ModelSettings model_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ModelSettings.Builder
Returns
Type Description
App.Builder

setName(String value)

public App.Builder setName(String value)

Identifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
App.Builder

This builder for chaining.

setNameBytes(ByteString value)

public App.Builder setNameBytes(ByteString value)

Identifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
App.Builder

This builder for chaining.

setPinned(boolean value)

public App.Builder setPinned(boolean value)

Optional. Whether the app is pinned in the app list.

bool pinned = 31 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The pinned to set.

Returns
Type Description
App.Builder

This builder for chaining.

setPredefinedVariableDeclarations(int index, App.VariableDeclaration value)

public App.Builder setPredefinedVariableDeclarations(int index, App.VariableDeclaration value)

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value App.VariableDeclaration
Returns
Type Description
App.Builder

setPredefinedVariableDeclarations(int index, App.VariableDeclaration.Builder builderForValue)

public App.Builder setPredefinedVariableDeclarations(int index, App.VariableDeclaration.Builder builderForValue)

Output only. The declarations of predefined variables for the app.

repeated .google.cloud.ces.v1.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue App.VariableDeclaration.Builder
Returns
Type Description
App.Builder

setRootAgent(String value)

public App.Builder setRootAgent(String value)

Optional. The root agent is the entry point of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

string root_agent = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The rootAgent to set.

Returns
Type Description
App.Builder

This builder for chaining.

setRootAgentBytes(ByteString value)

public App.Builder setRootAgentBytes(ByteString value)

Optional. The root agent is the entry point of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

string root_agent = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for rootAgent to set.

Returns
Type Description
App.Builder

This builder for chaining.

setTimeZoneSettings(TimeZoneSettings value)

public App.Builder setTimeZoneSettings(TimeZoneSettings value)

Optional. TimeZone settings of the app.

.google.cloud.ces.v1.TimeZoneSettings time_zone_settings = 27 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value TimeZoneSettings
Returns
Type Description
App.Builder

setTimeZoneSettings(TimeZoneSettings.Builder builderForValue)

public App.Builder setTimeZoneSettings(TimeZoneSettings.Builder builderForValue)

Optional. TimeZone settings of the app.

.google.cloud.ces.v1.TimeZoneSettings time_zone_settings = 27 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue TimeZoneSettings.Builder
Returns
Type Description
App.Builder

setToolExecutionMode(App.ToolExecutionMode value)

public App.Builder setToolExecutionMode(App.ToolExecutionMode value)

Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.

.google.cloud.ces.v1.App.ToolExecutionMode tool_execution_mode = 32 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value App.ToolExecutionMode

The toolExecutionMode to set.

Returns
Type Description
App.Builder

This builder for chaining.

setToolExecutionModeValue(int value)

public App.Builder setToolExecutionModeValue(int value)

Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.

.google.cloud.ces.v1.App.ToolExecutionMode tool_execution_mode = 32 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for toolExecutionMode to set.

Returns
Type Description
App.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public App.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when the app was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
App.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public App.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when the app was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
App.Builder

setVariableDeclarations(int index, App.VariableDeclaration value)

public App.Builder setVariableDeclarations(int index, App.VariableDeclaration value)

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value App.VariableDeclaration
Returns
Type Description
App.Builder

setVariableDeclarations(int index, App.VariableDeclaration.Builder builderForValue)

public App.Builder setVariableDeclarations(int index, App.VariableDeclaration.Builder builderForValue)

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue App.VariableDeclaration.Builder
Returns
Type Description
App.Builder