|
| 1 | +/* |
| 2 | + * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except |
| 3 | + * in compliance with the License. You may obtain a copy of the License at |
| 4 | + * |
| 5 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 6 | + * |
| 7 | + * Unless required by applicable law or agreed to in writing, software distributed under the License |
| 8 | + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express |
| 9 | + * or implied. See the License for the specific language governing permissions and limitations under |
| 10 | + * the License. |
| 11 | + */ |
| 12 | +/* |
| 13 | + * This code was generated by https://github.com/googleapis/google-api-java-client-services/ |
| 14 | + * Modify at your own risk. |
| 15 | + */ |
| 16 | + |
| 17 | +package com.google.api.services.aiplatform.v1.model; |
| 18 | + |
| 19 | +/** |
| 20 | + * A Vertex agent contains instructions and configurations for the LLM to execute a certain task. |
| 21 | + * |
| 22 | + * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is |
| 23 | + * transmitted over HTTP when working with the Agent Platform API. For a detailed explanation see: |
| 24 | + * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a> |
| 25 | + * </p> |
| 26 | + * |
| 27 | + * @author Google, Inc. |
| 28 | + */ |
| 29 | +@SuppressWarnings("javadoc") |
| 30 | +public final class GoogleCloudAiplatformV1Agent extends com.google.api.client.json.GenericJson { |
| 31 | + |
| 32 | + /** |
| 33 | + * Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026` |
| 34 | + * The value may be {@code null}. |
| 35 | + */ |
| 36 | + @com.google.api.client.util.Key("base_agent") |
| 37 | + private java.lang.String baseAgent; |
| 38 | + |
| 39 | + /** |
| 40 | + * Optional. The base environment configuration for the agent. Valid types: * A string value for |
| 41 | + * the environment ID, or `remote` for the default. * A struct value for the `environment_config`. |
| 42 | + * The value may be {@code null}. |
| 43 | + */ |
| 44 | + @com.google.api.client.util.Key("base_environment") |
| 45 | + private java.lang.Object baseEnvironment; |
| 46 | + |
| 47 | + /** |
| 48 | + * Output only. The time the agent was created. |
| 49 | + * The value may be {@code null}. |
| 50 | + */ |
| 51 | + @com.google.api.client.util.Key |
| 52 | + private String created; |
| 53 | + |
| 54 | + /** |
| 55 | + * Optional. The description of the agent. |
| 56 | + * The value may be {@code null}. |
| 57 | + */ |
| 58 | + @com.google.api.client.util.Key |
| 59 | + private java.lang.String description; |
| 60 | + |
| 61 | + /** |
| 62 | + * Immutable. The user-specified ID for the agent. This ID becomes the final component of the |
| 63 | + * agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can |
| 64 | + * be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. |
| 65 | + * The value may be {@code null}. |
| 66 | + */ |
| 67 | + @com.google.api.client.util.Key |
| 68 | + private java.lang.String id; |
| 69 | + |
| 70 | + /** |
| 71 | + * Optional. The metadata for the agent. |
| 72 | + * The value may be {@code null}. |
| 73 | + */ |
| 74 | + @com.google.api.client.util.Key |
| 75 | + private java.util.Map<String, java.lang.String> metadata; |
| 76 | + |
| 77 | + /** |
| 78 | + * Identifier. The resource name of the agent. Format: |
| 79 | + * `projects/{project}/locations/{location}/agents/{agent}`. |
| 80 | + * The value may be {@code null}. |
| 81 | + */ |
| 82 | + @com.google.api.client.util.Key |
| 83 | + private java.lang.String name; |
| 84 | + |
| 85 | + /** |
| 86 | + * Output only. The object type of the resource. For agents, the value is `agent`. |
| 87 | + * The value may be {@code null}. |
| 88 | + */ |
| 89 | + @com.google.api.client.util.Key("object") |
| 90 | + private java.lang.String object__; |
| 91 | + |
| 92 | + /** |
| 93 | + * Optional. The instructions for the agent to follow. These instructions are passed to the LLM as |
| 94 | + * a system instruction. |
| 95 | + * The value may be {@code null}. |
| 96 | + */ |
| 97 | + @com.google.api.client.util.Key("system_instruction") |
| 98 | + private java.lang.String systemInstruction; |
| 99 | + |
| 100 | + /** |
| 101 | + * Optional. The tools available to the agent. |
| 102 | + * The value may be {@code null}. |
| 103 | + */ |
| 104 | + @com.google.api.client.util.Key |
| 105 | + private java.util.List<GoogleCloudAiplatformV1AgentTool> tools; |
| 106 | + |
| 107 | + /** |
| 108 | + * Output only. The time the agent was last updated. |
| 109 | + * The value may be {@code null}. |
| 110 | + */ |
| 111 | + @com.google.api.client.util.Key |
| 112 | + private String updated; |
| 113 | + |
| 114 | + /** |
| 115 | + * Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026` |
| 116 | + * @return value or {@code null} for none |
| 117 | + */ |
| 118 | + public java.lang.String getBaseAgent() { |
| 119 | + return baseAgent; |
| 120 | + } |
| 121 | + |
| 122 | + /** |
| 123 | + * Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026` |
| 124 | + * @param baseAgent baseAgent or {@code null} for none |
| 125 | + */ |
| 126 | + public GoogleCloudAiplatformV1Agent setBaseAgent(java.lang.String baseAgent) { |
| 127 | + this.baseAgent = baseAgent; |
| 128 | + return this; |
| 129 | + } |
| 130 | + |
| 131 | + /** |
| 132 | + * Optional. The base environment configuration for the agent. Valid types: * A string value for |
| 133 | + * the environment ID, or `remote` for the default. * A struct value for the `environment_config`. |
| 134 | + * @return value or {@code null} for none |
| 135 | + */ |
| 136 | + public java.lang.Object getBaseEnvironment() { |
| 137 | + return baseEnvironment; |
| 138 | + } |
| 139 | + |
| 140 | + /** |
| 141 | + * Optional. The base environment configuration for the agent. Valid types: * A string value for |
| 142 | + * the environment ID, or `remote` for the default. * A struct value for the `environment_config`. |
| 143 | + * @param baseEnvironment baseEnvironment or {@code null} for none |
| 144 | + */ |
| 145 | + public GoogleCloudAiplatformV1Agent setBaseEnvironment(java.lang.Object baseEnvironment) { |
| 146 | + this.baseEnvironment = baseEnvironment; |
| 147 | + return this; |
| 148 | + } |
| 149 | + |
| 150 | + /** |
| 151 | + * Output only. The time the agent was created. |
| 152 | + * @return value or {@code null} for none |
| 153 | + */ |
| 154 | + public String getCreated() { |
| 155 | + return created; |
| 156 | + } |
| 157 | + |
| 158 | + /** |
| 159 | + * Output only. The time the agent was created. |
| 160 | + * @param created created or {@code null} for none |
| 161 | + */ |
| 162 | + public GoogleCloudAiplatformV1Agent setCreated(String created) { |
| 163 | + this.created = created; |
| 164 | + return this; |
| 165 | + } |
| 166 | + |
| 167 | + /** |
| 168 | + * Optional. The description of the agent. |
| 169 | + * @return value or {@code null} for none |
| 170 | + */ |
| 171 | + public java.lang.String getDescription() { |
| 172 | + return description; |
| 173 | + } |
| 174 | + |
| 175 | + /** |
| 176 | + * Optional. The description of the agent. |
| 177 | + * @param description description or {@code null} for none |
| 178 | + */ |
| 179 | + public GoogleCloudAiplatformV1Agent setDescription(java.lang.String description) { |
| 180 | + this.description = description; |
| 181 | + return this; |
| 182 | + } |
| 183 | + |
| 184 | + /** |
| 185 | + * Immutable. The user-specified ID for the agent. This ID becomes the final component of the |
| 186 | + * agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can |
| 187 | + * be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. |
| 188 | + * @return value or {@code null} for none |
| 189 | + */ |
| 190 | + public java.lang.String getId() { |
| 191 | + return id; |
| 192 | + } |
| 193 | + |
| 194 | + /** |
| 195 | + * Immutable. The user-specified ID for the agent. This ID becomes the final component of the |
| 196 | + * agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can |
| 197 | + * be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. |
| 198 | + * @param id id or {@code null} for none |
| 199 | + */ |
| 200 | + public GoogleCloudAiplatformV1Agent setId(java.lang.String id) { |
| 201 | + this.id = id; |
| 202 | + return this; |
| 203 | + } |
| 204 | + |
| 205 | + /** |
| 206 | + * Optional. The metadata for the agent. |
| 207 | + * @return value or {@code null} for none |
| 208 | + */ |
| 209 | + public java.util.Map<String, java.lang.String> getMetadata() { |
| 210 | + return metadata; |
| 211 | + } |
| 212 | + |
| 213 | + /** |
| 214 | + * Optional. The metadata for the agent. |
| 215 | + * @param metadata metadata or {@code null} for none |
| 216 | + */ |
| 217 | + public GoogleCloudAiplatformV1Agent setMetadata(java.util.Map<String, java.lang.String> metadata) { |
| 218 | + this.metadata = metadata; |
| 219 | + return this; |
| 220 | + } |
| 221 | + |
| 222 | + /** |
| 223 | + * Identifier. The resource name of the agent. Format: |
| 224 | + * `projects/{project}/locations/{location}/agents/{agent}`. |
| 225 | + * @return value or {@code null} for none |
| 226 | + */ |
| 227 | + public java.lang.String getName() { |
| 228 | + return name; |
| 229 | + } |
| 230 | + |
| 231 | + /** |
| 232 | + * Identifier. The resource name of the agent. Format: |
| 233 | + * `projects/{project}/locations/{location}/agents/{agent}`. |
| 234 | + * @param name name or {@code null} for none |
| 235 | + */ |
| 236 | + public GoogleCloudAiplatformV1Agent setName(java.lang.String name) { |
| 237 | + this.name = name; |
| 238 | + return this; |
| 239 | + } |
| 240 | + |
| 241 | + /** |
| 242 | + * Output only. The object type of the resource. For agents, the value is `agent`. |
| 243 | + * @return value or {@code null} for none |
| 244 | + */ |
| 245 | + public java.lang.String getObject() { |
| 246 | + return object__; |
| 247 | + } |
| 248 | + |
| 249 | + /** |
| 250 | + * Output only. The object type of the resource. For agents, the value is `agent`. |
| 251 | + * @param object__ object__ or {@code null} for none |
| 252 | + */ |
| 253 | + public GoogleCloudAiplatformV1Agent setObject(java.lang.String object__) { |
| 254 | + this.object__ = object__; |
| 255 | + return this; |
| 256 | + } |
| 257 | + |
| 258 | + /** |
| 259 | + * Optional. The instructions for the agent to follow. These instructions are passed to the LLM as |
| 260 | + * a system instruction. |
| 261 | + * @return value or {@code null} for none |
| 262 | + */ |
| 263 | + public java.lang.String getSystemInstruction() { |
| 264 | + return systemInstruction; |
| 265 | + } |
| 266 | + |
| 267 | + /** |
| 268 | + * Optional. The instructions for the agent to follow. These instructions are passed to the LLM as |
| 269 | + * a system instruction. |
| 270 | + * @param systemInstruction systemInstruction or {@code null} for none |
| 271 | + */ |
| 272 | + public GoogleCloudAiplatformV1Agent setSystemInstruction(java.lang.String systemInstruction) { |
| 273 | + this.systemInstruction = systemInstruction; |
| 274 | + return this; |
| 275 | + } |
| 276 | + |
| 277 | + /** |
| 278 | + * Optional. The tools available to the agent. |
| 279 | + * @return value or {@code null} for none |
| 280 | + */ |
| 281 | + public java.util.List<GoogleCloudAiplatformV1AgentTool> getTools() { |
| 282 | + return tools; |
| 283 | + } |
| 284 | + |
| 285 | + /** |
| 286 | + * Optional. The tools available to the agent. |
| 287 | + * @param tools tools or {@code null} for none |
| 288 | + */ |
| 289 | + public GoogleCloudAiplatformV1Agent setTools(java.util.List<GoogleCloudAiplatformV1AgentTool> tools) { |
| 290 | + this.tools = tools; |
| 291 | + return this; |
| 292 | + } |
| 293 | + |
| 294 | + /** |
| 295 | + * Output only. The time the agent was last updated. |
| 296 | + * @return value or {@code null} for none |
| 297 | + */ |
| 298 | + public String getUpdated() { |
| 299 | + return updated; |
| 300 | + } |
| 301 | + |
| 302 | + /** |
| 303 | + * Output only. The time the agent was last updated. |
| 304 | + * @param updated updated or {@code null} for none |
| 305 | + */ |
| 306 | + public GoogleCloudAiplatformV1Agent setUpdated(String updated) { |
| 307 | + this.updated = updated; |
| 308 | + return this; |
| 309 | + } |
| 310 | + |
| 311 | + @Override |
| 312 | + public GoogleCloudAiplatformV1Agent set(String fieldName, Object value) { |
| 313 | + return (GoogleCloudAiplatformV1Agent) super.set(fieldName, value); |
| 314 | + } |
| 315 | + |
| 316 | + @Override |
| 317 | + public GoogleCloudAiplatformV1Agent clone() { |
| 318 | + return (GoogleCloudAiplatformV1Agent) super.clone(); |
| 319 | + } |
| 320 | + |
| 321 | +} |
0 commit comments