Class App (0.7.0)

  public 
  
 final 
  
 class 
 App 
  
 extends 
  
 GeneratedMessage 
  
 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.v1beta.App

Implements

AppOrBuilder

Static Fields

AUDIO_PROCESSING_CONFIG_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 AUDIO_PROCESSING_CONFIG_FIELD_NUMBER 
 
Field Value
Type
Description
int

CLIENT_CERTIFICATE_SETTINGS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CLIENT_CERTIFICATE_SETTINGS_FIELD_NUMBER 
 
Field Value
Type
Description
int

CREATE_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 CREATE_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

DATA_STORE_SETTINGS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DATA_STORE_SETTINGS_FIELD_NUMBER 
 
Field Value
Type
Description
int

DEFAULT_CHANNEL_PROFILE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DEFAULT_CHANNEL_PROFILE_FIELD_NUMBER 
 
Field Value
Type
Description
int

DEPLOYMENT_COUNT_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DEPLOYMENT_COUNT_FIELD_NUMBER 
 
Field Value
Type
Description
int

DESCRIPTION_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DESCRIPTION_FIELD_NUMBER 
 
Field Value
Type
Description
int

DISPLAY_NAME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 DISPLAY_NAME_FIELD_NUMBER 
 
Field Value
Type
Description
int

ERROR_HANDLING_SETTINGS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ERROR_HANDLING_SETTINGS_FIELD_NUMBER 
 
Field Value
Type
Description
int

ETAG_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ETAG_FIELD_NUMBER 
 
Field Value
Type
Description
int

EVALUATION_METRICS_THRESHOLDS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 EVALUATION_METRICS_THRESHOLDS_FIELD_NUMBER 
 
Field Value
Type
Description
int

EVALUATION_PERSONAS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 EVALUATION_PERSONAS_FIELD_NUMBER 
 
Field Value
Type
Description
int

EVALUATION_SETTINGS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 EVALUATION_SETTINGS_FIELD_NUMBER 
 
Field Value
Type
Description
int

GLOBAL_INSTRUCTION_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 GLOBAL_INSTRUCTION_FIELD_NUMBER 
 
Field Value
Type
Description
int

GUARDRAILS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 GUARDRAILS_FIELD_NUMBER 
 
Field Value
Type
Description
int

LANGUAGE_SETTINGS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 LANGUAGE_SETTINGS_FIELD_NUMBER 
 
Field Value
Type
Description
int

LOCKED_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 LOCKED_FIELD_NUMBER 
 
Field Value
Type
Description
int

LOGGING_SETTINGS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 LOGGING_SETTINGS_FIELD_NUMBER 
 
Field Value
Type
Description
int
  public 
  
 static 
  
 final 
  
 int 
  
 METADATA_FIELD_NUMBER 
 
Field Value
Type
Description
int

MODEL_SETTINGS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 MODEL_SETTINGS_FIELD_NUMBER 
 
Field Value
Type
Description
int

NAME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 NAME_FIELD_NUMBER 
 
Field Value
Type
Description
int

PINNED_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 PINNED_FIELD_NUMBER 
 
Field Value
Type
Description
int

PREDEFINED_VARIABLE_DECLARATIONS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 PREDEFINED_VARIABLE_DECLARATIONS_FIELD_NUMBER 
 
Field Value
Type
Description
int

ROOT_AGENT_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ROOT_AGENT_FIELD_NUMBER 
 
Field Value
Type
Description
int

TIME_ZONE_SETTINGS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 TIME_ZONE_SETTINGS_FIELD_NUMBER 
 
Field Value
Type
Description
int

TOOL_EXECUTION_MODE_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 TOOL_EXECUTION_MODE_FIELD_NUMBER 
 
Field Value
Type
Description
int

UPDATE_TIME_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 UPDATE_TIME_FIELD_NUMBER 
 
Field Value
Type
Description
int

VARIABLE_DECLARATIONS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 VARIABLE_DECLARATIONS_FIELD_NUMBER 
 
Field Value
Type
Description
int

Static Methods

getDefaultInstance()

  public 
  
 static 
  
 App 
  
 getDefaultInstance 
 () 
 
Returns
Type
Description
App

getDescriptor()

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

newBuilder()

  public 
  
 static 
  
 App 
 . 
 Builder 
  
 newBuilder 
 () 
 
Returns
Type
Description

newBuilder(App prototype)

  public 
  
 static 
  
 App 
 . 
 Builder 
  
 newBuilder 
 ( 
 App 
  
 prototype 
 ) 
 
Parameter
Name
Description
prototype
App
Returns
Type
Description

parseDelimitedFrom(InputStream input)

  public 
  
 static 
  
 App 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
App
Exceptions
Type
Description

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 App 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
App
Exceptions
Type
Description

parseFrom(byte[] data)

  public 
  
 static 
  
 App 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 ) 
 
Parameter
Name
Description
data
byte []
Returns
Type
Description
App
Exceptions
Type
Description

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 App 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
byte []
extensionRegistry
Returns
Type
Description
App
Exceptions
Type
Description

parseFrom(ByteString data)

  public 
  
 static 
  
 App 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
App
Exceptions
Type
Description

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 App 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
App
Exceptions
Type
Description

parseFrom(CodedInputStream input)

  public 
  
 static 
  
 App 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 ) 
 
Parameter
Name
Description
Returns
Type
Description
App
Exceptions
Type
Description

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 App 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
extensionRegistry
Returns
Type
Description
App
Exceptions
Type
Description

parseFrom(InputStream input)

  public 
  
 static 
  
 App 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name
Description
input
Returns
Type
Description
App
Exceptions
Type
Description

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 App 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
input
extensionRegistry
Returns
Type
Description
App
Exceptions
Type
Description

parseFrom(ByteBuffer data)

  public 
  
 static 
  
 App 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 ) 
 
Parameter
Name
Description
data
Returns
Type
Description
App
Exceptions
Type
Description

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 App 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name
Description
data
extensionRegistry
Returns
Type
Description
App
Exceptions
Type
Description

parser()

  public 
  
 static 
  
 Parser<App> 
  
 parser 
 () 
 
Returns
Type
Description
Parser < App >

Methods

  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
Returns
Type
Description

equals(Object obj)

  public 
  
 boolean 
  
 equals 
 ( 
 Object 
  
 obj 
 ) 
 
Parameter
Name
Description
obj
Returns
Type
Description
Overrides

getAudioProcessingConfig()

  public 
  
 AudioProcessingConfig 
  
 getAudioProcessingConfig 
 () 
 

Optional. Audio processing configuration of the app.

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

Returns
Type
Description

The audioProcessingConfig.

getAudioProcessingConfigOrBuilder()

  public 
  
 AudioProcessingConfigOrBuilder 
  
 getAudioProcessingConfigOrBuilder 
 () 
 

Optional. Audio processing configuration of the app.

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

Returns
Type
Description

getClientCertificateSettings()

  public 
  
 ClientCertificateSettings 
  
 getClientCertificateSettings 
 () 
 

Optional. The default client certificate settings for the app.

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

Returns
Type
Description

The clientCertificateSettings.

getClientCertificateSettingsOrBuilder()

  public 
  
 ClientCertificateSettingsOrBuilder 
  
 getClientCertificateSettingsOrBuilder 
 () 
 

Optional. The default client certificate settings for the app.

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

Returns
Type
Description

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

The createTime.

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

getDataStoreSettings()

  public 
  
 DataStoreSettings 
  
 getDataStoreSettings 
 () 
 

Optional. The data store settings for the app.

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

Returns
Type
Description

The dataStoreSettings.

getDataStoreSettingsOrBuilder()

  public 
  
 DataStoreSettingsOrBuilder 
  
 getDataStoreSettingsOrBuilder 
 () 
 

Optional. The data store settings for the app.

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

Returns
Type
Description

getDefaultChannelProfile()

  public 
  
 ChannelProfile 
  
 getDefaultChannelProfile 
 () 
 

Optional. The default channel profile used by the app.

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

Returns
Type
Description

The defaultChannelProfile.

getDefaultChannelProfileOrBuilder()

  public 
  
 ChannelProfileOrBuilder 
  
 getDefaultChannelProfileOrBuilder 
 () 
 

Optional. The default channel profile used by the app.

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

Returns
Type
Description

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

The description.

getDescriptionBytes()

  public 
  
 ByteString 
  
 getDescriptionBytes 
 () 
 

Optional. Human-readable description of the app.

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

Returns
Type
Description

The bytes for description.

getDisplayName()

  public 
  
 String 
  
 getDisplayName 
 () 
 

Required. Display name of the app.

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

Returns
Type
Description

The displayName.

getDisplayNameBytes()

  public 
  
 ByteString 
  
 getDisplayNameBytes 
 () 
 

Required. Display name of the app.

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

Returns
Type
Description

The bytes for displayName.

getErrorHandlingSettings()

  public 
  
 ErrorHandlingSettings 
  
 getErrorHandlingSettings 
 () 
 

Optional. Error handling settings of the app.

.google.cloud.ces.v1beta.ErrorHandlingSettings error_handling_settings = 34 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The errorHandlingSettings.

getErrorHandlingSettingsOrBuilder()

  public 
  
 ErrorHandlingSettingsOrBuilder 
  
 getErrorHandlingSettingsOrBuilder 
 () 
 

Optional. Error handling settings of the app.

.google.cloud.ces.v1beta.ErrorHandlingSettings error_handling_settings = 34 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

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

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

The bytes for etag.

getEvaluationMetricsThresholds()

  public 
  
 EvaluationMetricsThresholds 
  
 getEvaluationMetricsThresholds 
 () 
 

Optional. The evaluation thresholds for the app.

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

Returns
Type
Description

The evaluationMetricsThresholds.

getEvaluationMetricsThresholdsOrBuilder()

  public 
  
 EvaluationMetricsThresholdsOrBuilder 
  
 getEvaluationMetricsThresholdsOrBuilder 
 () 
 

Optional. The evaluation thresholds for the app.

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

Returns
Type
Description

getEvaluationPersonas(int index)

  public 
  
 EvaluationPersona 
  
 getEvaluationPersonas 
 ( 
 int 
  
 index 
 ) 
 

Optional. The evaluation personas for the app. This field is used to define the personas that can be used for evaluation. Maximum of 30 personas can be defined.

repeated .google.cloud.ces.v1beta.EvaluationPersona evaluation_personas = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getEvaluationPersonasCount()

  public 
  
 int 
  
 getEvaluationPersonasCount 
 () 
 

Optional. The evaluation personas for the app. This field is used to define the personas that can be used for evaluation. Maximum of 30 personas can be defined.

repeated .google.cloud.ces.v1beta.EvaluationPersona evaluation_personas = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
int

getEvaluationPersonasList()

  public 
  
 List<EvaluationPersona> 
  
 getEvaluationPersonasList 
 () 
 

Optional. The evaluation personas for the app. This field is used to define the personas that can be used for evaluation. Maximum of 30 personas can be defined.

repeated .google.cloud.ces.v1beta.EvaluationPersona evaluation_personas = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getEvaluationPersonasOrBuilder(int index)

  public 
  
 EvaluationPersonaOrBuilder 
  
 getEvaluationPersonasOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

Optional. The evaluation personas for the app. This field is used to define the personas that can be used for evaluation. Maximum of 30 personas can be defined.

repeated .google.cloud.ces.v1beta.EvaluationPersona evaluation_personas = 30 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
index
int
Returns
Type
Description

getEvaluationPersonasOrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 EvaluationPersonaOrBuilder 
>  
 getEvaluationPersonasOrBuilderList 
 () 
 

Optional. The evaluation personas for the app. This field is used to define the personas that can be used for evaluation. Maximum of 30 personas can be defined.

repeated .google.cloud.ces.v1beta.EvaluationPersona evaluation_personas = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
List < ? extends com.google.cloud.ces.v1beta.EvaluationPersonaOrBuilder >

getEvaluationSettings()

  public 
  
 EvaluationSettings 
  
 getEvaluationSettings 
 () 
 

Optional. The evaluation settings for the app.

.google.cloud.ces.v1beta.EvaluationSettings evaluation_settings = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The evaluationSettings.

getEvaluationSettingsOrBuilder()

  public 
  
 EvaluationSettingsOrBuilder 
  
 getEvaluationSettingsOrBuilder 
 () 
 

Optional. The evaluation settings for the app.

.google.cloud.ces.v1beta.EvaluationSettings evaluation_settings = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

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

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

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

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

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

A list containing the guardrails.

getLanguageSettings()

  public 
  
 LanguageSettings 
  
 getLanguageSettings 
 () 
 

Optional. Language settings of the app.

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

Returns
Type
Description

The languageSettings.

getLanguageSettingsOrBuilder()

  public 
  
 LanguageSettingsOrBuilder 
  
 getLanguageSettingsOrBuilder 
 () 
 

Optional. Language settings of the app.

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

Returns
Type
Description

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

The locked.

getLoggingSettings()

  public 
  
 LoggingSettings 
  
 getLoggingSettings 
 () 
 

Optional. Logging settings of the app.

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

Returns
Type
Description

The loggingSettings.

getLoggingSettingsOrBuilder()

  public 
  
 LoggingSettingsOrBuilder 
  
 getLoggingSettingsOrBuilder 
 () 
 

Optional. Logging settings of the app.

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

Returns
Type
Description
  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
defaultValue
Returns
Type
Description

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
Returns
Type
Description

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.v1beta.ModelSettings model_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

The modelSettings.

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.v1beta.ModelSettings model_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

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

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

The bytes for name.

getParserForType()

  public 
  
 Parser<App> 
  
 getParserForType 
 () 
 
Returns
Type
Description
Parser < App >
Overrides

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

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.v1beta.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name
Description
index
int
Returns
Type
Description

getPredefinedVariableDeclarationsCount()

  public 
  
 int 
  
 getPredefinedVariableDeclarationsCount 
 () 
 

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

repeated .google.cloud.ces.v1beta.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.v1beta.App.VariableDeclaration predefined_variable_declarations = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description

getPredefinedVariableDeclarationsOrBuilder(int index)

  public 
  
 App 
 . 
 VariableDeclarationOrBuilder 
  
 getPredefinedVariableDeclarationsOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

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

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

Parameter
Name
Description
index
int
Returns
Type
Description

getPredefinedVariableDeclarationsOrBuilderList()

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

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

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

Returns
Type
Description
List < ? extends com.google.cloud.ces.v1beta.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

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

The bytes for rootAgent.

getSerializedSize()

  public 
  
 int 
  
 getSerializedSize 
 () 
 
Returns
Type
Description
int
Overrides

getTimeZoneSettings()

  public 
  
 TimeZoneSettings 
  
 getTimeZoneSettings 
 () 
 

Optional. TimeZone settings of the app.

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

Returns
Type
Description

The timeZoneSettings.

getTimeZoneSettingsOrBuilder()

  public 
  
 TimeZoneSettingsOrBuilder 
  
 getTimeZoneSettingsOrBuilder 
 () 
 

Optional. TimeZone settings of the app.

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

Returns
Type
Description

getToolExecutionMode()

  public 
  
 App 
 . 
 ToolExecutionMode 
  
 getToolExecutionMode 
 () 
 

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

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

Returns
Type
Description

The toolExecutionMode.

getToolExecutionModeValue()

  public 
  
 int 
  
 getToolExecutionModeValue 
 () 
 

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

.google.cloud.ces.v1beta.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

The updateTime.

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

getVariableDeclarations(int index)

  public 
  
 App 
 . 
 VariableDeclaration 
  
 getVariableDeclarations 
 ( 
 int 
  
 index 
 ) 
 

Optional. The declarations of the variables.

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

Parameter
Name
Description
index
int
Returns
Type
Description

getVariableDeclarationsCount()

  public 
  
 int 
  
 getVariableDeclarationsCount 
 () 
 

Optional. The declarations of the variables.

repeated .google.cloud.ces.v1beta.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.v1beta.App.VariableDeclaration variable_declarations = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

getVariableDeclarationsOrBuilder(int index)

  public 
  
 App 
 . 
 VariableDeclarationOrBuilder 
  
 getVariableDeclarationsOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

Optional. The declarations of the variables.

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

Parameter
Name
Description
index
int
Returns
Type
Description

getVariableDeclarationsOrBuilderList()

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

Optional. The declarations of the variables.

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

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

hasAudioProcessingConfig()

  public 
  
 boolean 
  
 hasAudioProcessingConfig 
 () 
 

Optional. Audio processing configuration of the app.

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

Returns
Type
Description

Whether the audioProcessingConfig field is set.

hasClientCertificateSettings()

  public 
  
 boolean 
  
 hasClientCertificateSettings 
 () 
 

Optional. The default client certificate settings for the app.

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

Returns
Type
Description

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

Whether the createTime field is set.

hasDataStoreSettings()

  public 
  
 boolean 
  
 hasDataStoreSettings 
 () 
 

Optional. The data store settings for the app.

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

Returns
Type
Description

Whether the dataStoreSettings field is set.

hasDefaultChannelProfile()

  public 
  
 boolean 
  
 hasDefaultChannelProfile 
 () 
 

Optional. The default channel profile used by the app.

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

Returns
Type
Description

Whether the defaultChannelProfile field is set.

hasErrorHandlingSettings()

  public 
  
 boolean 
  
 hasErrorHandlingSettings 
 () 
 

Optional. Error handling settings of the app.

.google.cloud.ces.v1beta.ErrorHandlingSettings error_handling_settings = 34 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

Whether the errorHandlingSettings field is set.

hasEvaluationMetricsThresholds()

  public 
  
 boolean 
  
 hasEvaluationMetricsThresholds 
 () 
 

Optional. The evaluation thresholds for the app.

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

Returns
Type
Description

Whether the evaluationMetricsThresholds field is set.

hasEvaluationSettings()

  public 
  
 boolean 
  
 hasEvaluationSettings 
 () 
 

Optional. The evaluation settings for the app.

.google.cloud.ces.v1beta.EvaluationSettings evaluation_settings = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

Whether the evaluationSettings field is set.

hasLanguageSettings()

  public 
  
 boolean 
  
 hasLanguageSettings 
 () 
 

Optional. Language settings of the app.

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

Returns
Type
Description

Whether the languageSettings field is set.

hasLoggingSettings()

  public 
  
 boolean 
  
 hasLoggingSettings 
 () 
 

Optional. Logging settings of the app.

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

Returns
Type
Description

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.v1beta.ModelSettings model_settings = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

Whether the modelSettings field is set.

hasTimeZoneSettings()

  public 
  
 boolean 
  
 hasTimeZoneSettings 
 () 
 

Optional. TimeZone settings of the app.

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

Returns
Type
Description

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

Whether the updateTime field is set.

hashCode()

  public 
  
 int 
  
 hashCode 
 () 
 
Returns
Type
Description
int
Overrides

internalGetFieldAccessorTable()

  protected 
  
 GeneratedMessage 
 . 
 FieldAccessorTable 
  
 internalGetFieldAccessorTable 
 () 
 
Returns
Type
Description
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.internalGetMapFieldReflection(int)

isInitialized()

  public 
  
 final 
  
 boolean 
  
 isInitialized 
 () 
 
Returns
Type
Description
Overrides

newBuilderForType()

  public 
  
 App 
 . 
 Builder 
  
 newBuilderForType 
 () 
 
Returns
Type
Description

newBuilderForType(AbstractMessage.BuilderParent parent)

  protected 
  
 App 
 . 
 Builder 
  
 newBuilderForType 
 ( 
 AbstractMessage 
 . 
 BuilderParent 
  
 parent 
 ) 
 
Parameter
Name
Description
parent
Returns
Type
Description
Overrides

toBuilder()

  public 
  
 App 
 . 
 Builder 
  
 toBuilder 
 () 
 
Returns
Type
Description

writeTo(CodedOutputStream output)

  public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 ) 
 
Parameter
Name
Description
Overrides
Exceptions
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: