|
| 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.connectors.v2.model; |
| 18 | + |
| 19 | +/** |
| 20 | + * ToolAnnotations holds annotations for a tool. |
| 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 Connectors 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 ToolAnnotations extends com.google.api.client.json.GenericJson { |
| 31 | + |
| 32 | + /** |
| 33 | + * If true, the tool may perform destructive updates to its environment. If false, the tool |
| 34 | + * performs only additive updates. (This property is meaningful only when `read_only_hint == |
| 35 | + * false`) |
| 36 | + * The value may be {@code null}. |
| 37 | + */ |
| 38 | + @com.google.api.client.util.Key |
| 39 | + private java.lang.Boolean destructiveHint; |
| 40 | + |
| 41 | + /** |
| 42 | + * If true, calling the tool repeatedly with the same arguments will have no additional effect on |
| 43 | + * the environment. (This property is meaningful only when `read_only_hint == false`) |
| 44 | + * The value may be {@code null}. |
| 45 | + */ |
| 46 | + @com.google.api.client.util.Key |
| 47 | + private java.lang.Boolean idempotentHint; |
| 48 | + |
| 49 | + /** |
| 50 | + * If true, this tool may interact with an "open world" of external entities. If false, the tool's |
| 51 | + * domain of interaction is closed. For example, the world of a web search tool is open, whereas |
| 52 | + * that of a memory tool is not. |
| 53 | + * The value may be {@code null}. |
| 54 | + */ |
| 55 | + @com.google.api.client.util.Key |
| 56 | + private java.lang.Boolean openWorldHint; |
| 57 | + |
| 58 | + /** |
| 59 | + * If true, the tool does not modify its environment. |
| 60 | + * The value may be {@code null}. |
| 61 | + */ |
| 62 | + @com.google.api.client.util.Key |
| 63 | + private java.lang.Boolean readOnlyHint; |
| 64 | + |
| 65 | + /** |
| 66 | + * A human-readable title for the tool. |
| 67 | + * The value may be {@code null}. |
| 68 | + */ |
| 69 | + @com.google.api.client.util.Key |
| 70 | + private java.lang.String title; |
| 71 | + |
| 72 | + /** |
| 73 | + * If true, the tool may perform destructive updates to its environment. If false, the tool |
| 74 | + * performs only additive updates. (This property is meaningful only when `read_only_hint == |
| 75 | + * false`) |
| 76 | + * @return value or {@code null} for none |
| 77 | + */ |
| 78 | + public java.lang.Boolean getDestructiveHint() { |
| 79 | + return destructiveHint; |
| 80 | + } |
| 81 | + |
| 82 | + /** |
| 83 | + * If true, the tool may perform destructive updates to its environment. If false, the tool |
| 84 | + * performs only additive updates. (This property is meaningful only when `read_only_hint == |
| 85 | + * false`) |
| 86 | + * @param destructiveHint destructiveHint or {@code null} for none |
| 87 | + */ |
| 88 | + public ToolAnnotations setDestructiveHint(java.lang.Boolean destructiveHint) { |
| 89 | + this.destructiveHint = destructiveHint; |
| 90 | + return this; |
| 91 | + } |
| 92 | + |
| 93 | + /** |
| 94 | + * If true, calling the tool repeatedly with the same arguments will have no additional effect on |
| 95 | + * the environment. (This property is meaningful only when `read_only_hint == false`) |
| 96 | + * @return value or {@code null} for none |
| 97 | + */ |
| 98 | + public java.lang.Boolean getIdempotentHint() { |
| 99 | + return idempotentHint; |
| 100 | + } |
| 101 | + |
| 102 | + /** |
| 103 | + * If true, calling the tool repeatedly with the same arguments will have no additional effect on |
| 104 | + * the environment. (This property is meaningful only when `read_only_hint == false`) |
| 105 | + * @param idempotentHint idempotentHint or {@code null} for none |
| 106 | + */ |
| 107 | + public ToolAnnotations setIdempotentHint(java.lang.Boolean idempotentHint) { |
| 108 | + this.idempotentHint = idempotentHint; |
| 109 | + return this; |
| 110 | + } |
| 111 | + |
| 112 | + /** |
| 113 | + * If true, this tool may interact with an "open world" of external entities. If false, the tool's |
| 114 | + * domain of interaction is closed. For example, the world of a web search tool is open, whereas |
| 115 | + * that of a memory tool is not. |
| 116 | + * @return value or {@code null} for none |
| 117 | + */ |
| 118 | + public java.lang.Boolean getOpenWorldHint() { |
| 119 | + return openWorldHint; |
| 120 | + } |
| 121 | + |
| 122 | + /** |
| 123 | + * If true, this tool may interact with an "open world" of external entities. If false, the tool's |
| 124 | + * domain of interaction is closed. For example, the world of a web search tool is open, whereas |
| 125 | + * that of a memory tool is not. |
| 126 | + * @param openWorldHint openWorldHint or {@code null} for none |
| 127 | + */ |
| 128 | + public ToolAnnotations setOpenWorldHint(java.lang.Boolean openWorldHint) { |
| 129 | + this.openWorldHint = openWorldHint; |
| 130 | + return this; |
| 131 | + } |
| 132 | + |
| 133 | + /** |
| 134 | + * If true, the tool does not modify its environment. |
| 135 | + * @return value or {@code null} for none |
| 136 | + */ |
| 137 | + public java.lang.Boolean getReadOnlyHint() { |
| 138 | + return readOnlyHint; |
| 139 | + } |
| 140 | + |
| 141 | + /** |
| 142 | + * If true, the tool does not modify its environment. |
| 143 | + * @param readOnlyHint readOnlyHint or {@code null} for none |
| 144 | + */ |
| 145 | + public ToolAnnotations setReadOnlyHint(java.lang.Boolean readOnlyHint) { |
| 146 | + this.readOnlyHint = readOnlyHint; |
| 147 | + return this; |
| 148 | + } |
| 149 | + |
| 150 | + /** |
| 151 | + * A human-readable title for the tool. |
| 152 | + * @return value or {@code null} for none |
| 153 | + */ |
| 154 | + public java.lang.String getTitle() { |
| 155 | + return title; |
| 156 | + } |
| 157 | + |
| 158 | + /** |
| 159 | + * A human-readable title for the tool. |
| 160 | + * @param title title or {@code null} for none |
| 161 | + */ |
| 162 | + public ToolAnnotations setTitle(java.lang.String title) { |
| 163 | + this.title = title; |
| 164 | + return this; |
| 165 | + } |
| 166 | + |
| 167 | + @Override |
| 168 | + public ToolAnnotations set(String fieldName, Object value) { |
| 169 | + return (ToolAnnotations) super.set(fieldName, value); |
| 170 | + } |
| 171 | + |
| 172 | + @Override |
| 173 | + public ToolAnnotations clone() { |
| 174 | + return (ToolAnnotations) super.clone(); |
| 175 | + } |
| 176 | + |
| 177 | +} |
0 commit comments