|
| 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.contactcenterinsights.v1.model; |
| 18 | + |
| 19 | +/** |
| 20 | + * The CCAI Insights project wide analysis rule. This rule will be applied to all conversations that |
| 21 | + * match the filter defined in the rule. For a conversation matches the filter, the annotators |
| 22 | + * specified in the rule will be run. If a conversation matches multiple rules, a union of all the |
| 23 | + * annotators will be run. One project can have multiple analysis rules. |
| 24 | + * |
| 25 | + * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is |
| 26 | + * transmitted over HTTP when working with the Contact Center AI Insights API. For a detailed |
| 27 | + * explanation see: |
| 28 | + * <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> |
| 29 | + * </p> |
| 30 | + * |
| 31 | + * @author Google, Inc. |
| 32 | + */ |
| 33 | +@SuppressWarnings("javadoc") |
| 34 | +public final class GoogleCloudContactcenterinsightsV1AnalysisRule extends com.google.api.client.json.GenericJson { |
| 35 | + |
| 36 | + /** |
| 37 | + * If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a |
| 38 | + * draft. |
| 39 | + * The value may be {@code null}. |
| 40 | + */ |
| 41 | + @com.google.api.client.util.Key |
| 42 | + private java.lang.Boolean active; |
| 43 | + |
| 44 | + /** |
| 45 | + * Percentage of conversations that we should apply this analysis setting automatically, between |
| 46 | + * [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The |
| 47 | + * original runtime_percentage & upload percentage will be replaced by defining filters on the |
| 48 | + * conversation. |
| 49 | + * The value may be {@code null}. |
| 50 | + */ |
| 51 | + @com.google.api.client.util.Key |
| 52 | + private java.lang.Double analysisPercentage; |
| 53 | + |
| 54 | + /** |
| 55 | + * Selector of annotators to run and the phrase matchers to use for conversations that matches the |
| 56 | + * conversation_filter. If not specified, NO annotators will be run. |
| 57 | + * The value may be {@code null}. |
| 58 | + */ |
| 59 | + @com.google.api.client.util.Key |
| 60 | + private GoogleCloudContactcenterinsightsV1AnnotatorSelector annotatorSelector; |
| 61 | + |
| 62 | + /** |
| 63 | + * Filter for the conversations that should apply this analysis rule. An empty filter means this |
| 64 | + * analysis rule applies to all conversations. Refer to https://cloud.google.com/contact- |
| 65 | + * center/insights/docs/filtering for details. |
| 66 | + * The value may be {@code null}. |
| 67 | + */ |
| 68 | + @com.google.api.client.util.Key |
| 69 | + private java.lang.String conversationFilter; |
| 70 | + |
| 71 | + /** |
| 72 | + * Output only. The time at which this analysis rule was created. |
| 73 | + * The value may be {@code null}. |
| 74 | + */ |
| 75 | + @com.google.api.client.util.Key |
| 76 | + private String createTime; |
| 77 | + |
| 78 | + /** |
| 79 | + * Display Name of the analysis rule. |
| 80 | + * The value may be {@code null}. |
| 81 | + */ |
| 82 | + @com.google.api.client.util.Key |
| 83 | + private java.lang.String displayName; |
| 84 | + |
| 85 | + /** |
| 86 | + * Identifier. The resource name of the analysis rule. Format: |
| 87 | + * projects/{project}/locations/{location}/analysisRules/{analysis_rule} |
| 88 | + * The value may be {@code null}. |
| 89 | + */ |
| 90 | + @com.google.api.client.util.Key |
| 91 | + private java.lang.String name; |
| 92 | + |
| 93 | + /** |
| 94 | + * Output only. The most recent time at which this analysis rule was updated. |
| 95 | + * The value may be {@code null}. |
| 96 | + */ |
| 97 | + @com.google.api.client.util.Key |
| 98 | + private String updateTime; |
| 99 | + |
| 100 | + /** |
| 101 | + * If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a |
| 102 | + * draft. |
| 103 | + * @return value or {@code null} for none |
| 104 | + */ |
| 105 | + public java.lang.Boolean getActive() { |
| 106 | + return active; |
| 107 | + } |
| 108 | + |
| 109 | + /** |
| 110 | + * If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a |
| 111 | + * draft. |
| 112 | + * @param active active or {@code null} for none |
| 113 | + */ |
| 114 | + public GoogleCloudContactcenterinsightsV1AnalysisRule setActive(java.lang.Boolean active) { |
| 115 | + this.active = active; |
| 116 | + return this; |
| 117 | + } |
| 118 | + |
| 119 | + /** |
| 120 | + * Percentage of conversations that we should apply this analysis setting automatically, between |
| 121 | + * [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The |
| 122 | + * original runtime_percentage & upload percentage will be replaced by defining filters on the |
| 123 | + * conversation. |
| 124 | + * @return value or {@code null} for none |
| 125 | + */ |
| 126 | + public java.lang.Double getAnalysisPercentage() { |
| 127 | + return analysisPercentage; |
| 128 | + } |
| 129 | + |
| 130 | + /** |
| 131 | + * Percentage of conversations that we should apply this analysis setting automatically, between |
| 132 | + * [0, 1]. For example, 0.1 means 10%. Conversations are sampled in a determenestic way. The |
| 133 | + * original runtime_percentage & upload percentage will be replaced by defining filters on the |
| 134 | + * conversation. |
| 135 | + * @param analysisPercentage analysisPercentage or {@code null} for none |
| 136 | + */ |
| 137 | + public GoogleCloudContactcenterinsightsV1AnalysisRule setAnalysisPercentage(java.lang.Double analysisPercentage) { |
| 138 | + this.analysisPercentage = analysisPercentage; |
| 139 | + return this; |
| 140 | + } |
| 141 | + |
| 142 | + /** |
| 143 | + * Selector of annotators to run and the phrase matchers to use for conversations that matches the |
| 144 | + * conversation_filter. If not specified, NO annotators will be run. |
| 145 | + * @return value or {@code null} for none |
| 146 | + */ |
| 147 | + public GoogleCloudContactcenterinsightsV1AnnotatorSelector getAnnotatorSelector() { |
| 148 | + return annotatorSelector; |
| 149 | + } |
| 150 | + |
| 151 | + /** |
| 152 | + * Selector of annotators to run and the phrase matchers to use for conversations that matches the |
| 153 | + * conversation_filter. If not specified, NO annotators will be run. |
| 154 | + * @param annotatorSelector annotatorSelector or {@code null} for none |
| 155 | + */ |
| 156 | + public GoogleCloudContactcenterinsightsV1AnalysisRule setAnnotatorSelector(GoogleCloudContactcenterinsightsV1AnnotatorSelector annotatorSelector) { |
| 157 | + this.annotatorSelector = annotatorSelector; |
| 158 | + return this; |
| 159 | + } |
| 160 | + |
| 161 | + /** |
| 162 | + * Filter for the conversations that should apply this analysis rule. An empty filter means this |
| 163 | + * analysis rule applies to all conversations. Refer to https://cloud.google.com/contact- |
| 164 | + * center/insights/docs/filtering for details. |
| 165 | + * @return value or {@code null} for none |
| 166 | + */ |
| 167 | + public java.lang.String getConversationFilter() { |
| 168 | + return conversationFilter; |
| 169 | + } |
| 170 | + |
| 171 | + /** |
| 172 | + * Filter for the conversations that should apply this analysis rule. An empty filter means this |
| 173 | + * analysis rule applies to all conversations. Refer to https://cloud.google.com/contact- |
| 174 | + * center/insights/docs/filtering for details. |
| 175 | + * @param conversationFilter conversationFilter or {@code null} for none |
| 176 | + */ |
| 177 | + public GoogleCloudContactcenterinsightsV1AnalysisRule setConversationFilter(java.lang.String conversationFilter) { |
| 178 | + this.conversationFilter = conversationFilter; |
| 179 | + return this; |
| 180 | + } |
| 181 | + |
| 182 | + /** |
| 183 | + * Output only. The time at which this analysis rule was created. |
| 184 | + * @return value or {@code null} for none |
| 185 | + */ |
| 186 | + public String getCreateTime() { |
| 187 | + return createTime; |
| 188 | + } |
| 189 | + |
| 190 | + /** |
| 191 | + * Output only. The time at which this analysis rule was created. |
| 192 | + * @param createTime createTime or {@code null} for none |
| 193 | + */ |
| 194 | + public GoogleCloudContactcenterinsightsV1AnalysisRule setCreateTime(String createTime) { |
| 195 | + this.createTime = createTime; |
| 196 | + return this; |
| 197 | + } |
| 198 | + |
| 199 | + /** |
| 200 | + * Display Name of the analysis rule. |
| 201 | + * @return value or {@code null} for none |
| 202 | + */ |
| 203 | + public java.lang.String getDisplayName() { |
| 204 | + return displayName; |
| 205 | + } |
| 206 | + |
| 207 | + /** |
| 208 | + * Display Name of the analysis rule. |
| 209 | + * @param displayName displayName or {@code null} for none |
| 210 | + */ |
| 211 | + public GoogleCloudContactcenterinsightsV1AnalysisRule setDisplayName(java.lang.String displayName) { |
| 212 | + this.displayName = displayName; |
| 213 | + return this; |
| 214 | + } |
| 215 | + |
| 216 | + /** |
| 217 | + * Identifier. The resource name of the analysis rule. Format: |
| 218 | + * projects/{project}/locations/{location}/analysisRules/{analysis_rule} |
| 219 | + * @return value or {@code null} for none |
| 220 | + */ |
| 221 | + public java.lang.String getName() { |
| 222 | + return name; |
| 223 | + } |
| 224 | + |
| 225 | + /** |
| 226 | + * Identifier. The resource name of the analysis rule. Format: |
| 227 | + * projects/{project}/locations/{location}/analysisRules/{analysis_rule} |
| 228 | + * @param name name or {@code null} for none |
| 229 | + */ |
| 230 | + public GoogleCloudContactcenterinsightsV1AnalysisRule setName(java.lang.String name) { |
| 231 | + this.name = name; |
| 232 | + return this; |
| 233 | + } |
| 234 | + |
| 235 | + /** |
| 236 | + * Output only. The most recent time at which this analysis rule was updated. |
| 237 | + * @return value or {@code null} for none |
| 238 | + */ |
| 239 | + public String getUpdateTime() { |
| 240 | + return updateTime; |
| 241 | + } |
| 242 | + |
| 243 | + /** |
| 244 | + * Output only. The most recent time at which this analysis rule was updated. |
| 245 | + * @param updateTime updateTime or {@code null} for none |
| 246 | + */ |
| 247 | + public GoogleCloudContactcenterinsightsV1AnalysisRule setUpdateTime(String updateTime) { |
| 248 | + this.updateTime = updateTime; |
| 249 | + return this; |
| 250 | + } |
| 251 | + |
| 252 | + @Override |
| 253 | + public GoogleCloudContactcenterinsightsV1AnalysisRule set(String fieldName, Object value) { |
| 254 | + return (GoogleCloudContactcenterinsightsV1AnalysisRule) super.set(fieldName, value); |
| 255 | + } |
| 256 | + |
| 257 | + @Override |
| 258 | + public GoogleCloudContactcenterinsightsV1AnalysisRule clone() { |
| 259 | + return (GoogleCloudContactcenterinsightsV1AnalysisRule) super.clone(); |
| 260 | + } |
| 261 | + |
| 262 | +} |
0 commit comments