Interface AppOrBuilder (0.1.0)

public interface AppOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetadata(String key)

public abstract 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 abstract 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.

getAudioProcessingConfigOrBuilder()

public abstract 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 abstract 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.

getClientCertificateSettingsOrBuilder()

public abstract 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 abstract 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.

getCreateTimeOrBuilder()

public abstract 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 abstract 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.

getDataStoreSettingsOrBuilder()

public abstract 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 abstract 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.

getDefaultChannelProfileOrBuilder()

public abstract 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

getDeploymentCount()

public abstract 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 abstract 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 abstract 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.

getDisplayName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getEvaluationMetricsThresholdsOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the guardrails.

getLanguageSettings()

public abstract 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.

getLanguageSettingsOrBuilder()

public abstract 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 abstract 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 abstract 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.

getLoggingSettingsOrBuilder()

public abstract 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 abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getModelSettingsOrBuilder()

public abstract 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

getName()

public abstract 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 abstract 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 abstract 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 abstract 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

getPredefinedVariableDeclarationsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getTimeZoneSettingsOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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.

getUpdateTimeOrBuilder()

public abstract 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 abstract 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

getVariableDeclarationsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.