1 /* 2 * Copyright 2022 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 /** 18 * A client to Dialogflow API 19 * 20 * <p>The interfaces provided are listed below, along with usage samples. 21 * 22 * <p>======================= AgentsClient ======================= 23 * 24 * <p>Service Description: Service for managing [Agents][google.cloud.dialogflow.cx.v3.Agent]. 25 * 26 * <p>Sample for AgentsClient: 27 * 28 * <pre>{@code 29 * // This snippet has been automatically generated and should be regarded as a code template only. 30 * // It will require modifications to work: 31 * // - It may require correct/in-range values for request initialization. 32 * // - It may require specifying regional endpoints when creating the service client as shown in 33 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 34 * try (AgentsClient agentsClient = AgentsClient.create()) { 35 * AgentName name = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]"); 36 * Agent response = agentsClient.getAgent(name); 37 * } 38 * }</pre> 39 * 40 * <p>======================= ChangelogsClient ======================= 41 * 42 * <p>Service Description: Service for managing 43 * [Changelogs][google.cloud.dialogflow.cx.v3.Changelog]. 44 * 45 * <p>Sample for ChangelogsClient: 46 * 47 * <pre>{@code 48 * // This snippet has been automatically generated and should be regarded as a code template only. 49 * // It will require modifications to work: 50 * // - It may require correct/in-range values for request initialization. 51 * // - It may require specifying regional endpoints when creating the service client as shown in 52 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 53 * try (ChangelogsClient changelogsClient = ChangelogsClient.create()) { 54 * ChangelogName name = ChangelogName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]"); 55 * Changelog response = changelogsClient.getChangelog(name); 56 * } 57 * }</pre> 58 * 59 * <p>======================= DeploymentsClient ======================= 60 * 61 * <p>Service Description: Service for managing 62 * [Deployments][google.cloud.dialogflow.cx.v3.Deployment]. 63 * 64 * <p>Sample for DeploymentsClient: 65 * 66 * <pre>{@code 67 * // This snippet has been automatically generated and should be regarded as a code template only. 68 * // It will require modifications to work: 69 * // - It may require correct/in-range values for request initialization. 70 * // - It may require specifying regional endpoints when creating the service client as shown in 71 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 72 * try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) { 73 * DeploymentName name = 74 * DeploymentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[DEPLOYMENT]"); 75 * Deployment response = deploymentsClient.getDeployment(name); 76 * } 77 * }</pre> 78 * 79 * <p>======================= EntityTypesClient ======================= 80 * 81 * <p>Service Description: Service for managing 82 * [EntityTypes][google.cloud.dialogflow.cx.v3.EntityType]. 83 * 84 * <p>Sample for EntityTypesClient: 85 * 86 * <pre>{@code 87 * // This snippet has been automatically generated and should be regarded as a code template only. 88 * // It will require modifications to work: 89 * // - It may require correct/in-range values for request initialization. 90 * // - It may require specifying regional endpoints when creating the service client as shown in 91 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 92 * try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) { 93 * EntityTypeName name = 94 * EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]"); 95 * EntityType response = entityTypesClient.getEntityType(name); 96 * } 97 * }</pre> 98 * 99 * <p>======================= EnvironmentsClient ======================= 100 * 101 * <p>Service Description: Service for managing 102 * [Environments][google.cloud.dialogflow.cx.v3.Environment]. 103 * 104 * <p>Sample for EnvironmentsClient: 105 * 106 * <pre>{@code 107 * // This snippet has been automatically generated and should be regarded as a code template only. 108 * // It will require modifications to work: 109 * // - It may require correct/in-range values for request initialization. 110 * // - It may require specifying regional endpoints when creating the service client as shown in 111 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 112 * try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) { 113 * EnvironmentName name = 114 * EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]"); 115 * Environment response = environmentsClient.getEnvironment(name); 116 * } 117 * }</pre> 118 * 119 * <p>======================= ExperimentsClient ======================= 120 * 121 * <p>Service Description: Service for managing 122 * [Experiments][google.cloud.dialogflow.cx.v3.Experiment]. 123 * 124 * <p>Sample for ExperimentsClient: 125 * 126 * <pre>{@code 127 * // This snippet has been automatically generated and should be regarded as a code template only. 128 * // It will require modifications to work: 129 * // - It may require correct/in-range values for request initialization. 130 * // - It may require specifying regional endpoints when creating the service client as shown in 131 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 132 * try (ExperimentsClient experimentsClient = ExperimentsClient.create()) { 133 * ExperimentName name = 134 * ExperimentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]"); 135 * Experiment response = experimentsClient.getExperiment(name); 136 * } 137 * }</pre> 138 * 139 * <p>======================= FlowsClient ======================= 140 * 141 * <p>Service Description: Service for managing [Flows][google.cloud.dialogflow.cx.v3.Flow]. 142 * 143 * <p>Sample for FlowsClient: 144 * 145 * <pre>{@code 146 * // This snippet has been automatically generated and should be regarded as a code template only. 147 * // It will require modifications to work: 148 * // - It may require correct/in-range values for request initialization. 149 * // - It may require specifying regional endpoints when creating the service client as shown in 150 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 151 * try (FlowsClient flowsClient = FlowsClient.create()) { 152 * AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]"); 153 * Flow flow = Flow.newBuilder().build(); 154 * Flow response = flowsClient.createFlow(parent, flow); 155 * } 156 * }</pre> 157 * 158 * <p>======================= IntentsClient ======================= 159 * 160 * <p>Service Description: Service for managing [Intents][google.cloud.dialogflow.cx.v3.Intent]. 161 * 162 * <p>Sample for IntentsClient: 163 * 164 * <pre>{@code 165 * // This snippet has been automatically generated and should be regarded as a code template only. 166 * // It will require modifications to work: 167 * // - It may require correct/in-range values for request initialization. 168 * // - It may require specifying regional endpoints when creating the service client as shown in 169 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 170 * try (IntentsClient intentsClient = IntentsClient.create()) { 171 * IntentName name = IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]"); 172 * Intent response = intentsClient.getIntent(name); 173 * } 174 * }</pre> 175 * 176 * <p>======================= PagesClient ======================= 177 * 178 * <p>Service Description: Service for managing [Pages][google.cloud.dialogflow.cx.v3.Page]. 179 * 180 * <p>Sample for PagesClient: 181 * 182 * <pre>{@code 183 * // This snippet has been automatically generated and should be regarded as a code template only. 184 * // It will require modifications to work: 185 * // - It may require correct/in-range values for request initialization. 186 * // - It may require specifying regional endpoints when creating the service client as shown in 187 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 188 * try (PagesClient pagesClient = PagesClient.create()) { 189 * PageName name = PageName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[PAGE]"); 190 * Page response = pagesClient.getPage(name); 191 * } 192 * }</pre> 193 * 194 * <p>======================= SecuritySettingsServiceClient ======================= 195 * 196 * <p>Service Description: Service for managing security settings for Dialogflow. 197 * 198 * <p>Sample for SecuritySettingsServiceClient: 199 * 200 * <pre>{@code 201 * // This snippet has been automatically generated and should be regarded as a code template only. 202 * // It will require modifications to work: 203 * // - It may require correct/in-range values for request initialization. 204 * // - It may require specifying regional endpoints when creating the service client as shown in 205 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 206 * try (SecuritySettingsServiceClient securitySettingsServiceClient = 207 * SecuritySettingsServiceClient.create()) { 208 * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); 209 * SecuritySettings securitySettings = SecuritySettings.newBuilder().build(); 210 * SecuritySettings response = 211 * securitySettingsServiceClient.createSecuritySettings(parent, securitySettings); 212 * } 213 * }</pre> 214 * 215 * <p>======================= SessionsClient ======================= 216 * 217 * <p>Service Description: A session represents an interaction with a user. You retrieve user input 218 * and pass it to the [DetectIntent][google.cloud.dialogflow.cx.v3.Sessions.DetectIntent] method to 219 * determine user intent and respond. 220 * 221 * <p>Sample for SessionsClient: 222 * 223 * <pre>{@code 224 * // This snippet has been automatically generated and should be regarded as a code template only. 225 * // It will require modifications to work: 226 * // - It may require correct/in-range values for request initialization. 227 * // - It may require specifying regional endpoints when creating the service client as shown in 228 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 229 * try (SessionsClient sessionsClient = SessionsClient.create()) { 230 * DetectIntentRequest request = 231 * DetectIntentRequest.newBuilder() 232 * .setSession( 233 * SessionName.ofProjectLocationAgentSessionName( 234 * "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]") 235 * .toString()) 236 * .setQueryParams(QueryParameters.newBuilder().build()) 237 * .setQueryInput(QueryInput.newBuilder().build()) 238 * .setOutputAudioConfig(OutputAudioConfig.newBuilder().build()) 239 * .build(); 240 * DetectIntentResponse response = sessionsClient.detectIntent(request); 241 * } 242 * }</pre> 243 * 244 * <p>======================= SessionEntityTypesClient ======================= 245 * 246 * <p>Service Description: Service for managing 247 * [SessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityType]. 248 * 249 * <p>Sample for SessionEntityTypesClient: 250 * 251 * <pre>{@code 252 * // This snippet has been automatically generated and should be regarded as a code template only. 253 * // It will require modifications to work: 254 * // - It may require correct/in-range values for request initialization. 255 * // - It may require specifying regional endpoints when creating the service client as shown in 256 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 257 * try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) { 258 * SessionEntityTypeName name = 259 * SessionEntityTypeName.ofProjectLocationAgentSessionEntityTypeName( 260 * "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]"); 261 * SessionEntityType response = sessionEntityTypesClient.getSessionEntityType(name); 262 * } 263 * }</pre> 264 * 265 * <p>======================= TestCasesClient ======================= 266 * 267 * <p>Service Description: Service for managing [Test Cases][google.cloud.dialogflow.cx.v3.TestCase] 268 * and [Test Case Results][google.cloud.dialogflow.cx.v3.TestCaseResult]. 269 * 270 * <p>Sample for TestCasesClient: 271 * 272 * <pre>{@code 273 * // This snippet has been automatically generated and should be regarded as a code template only. 274 * // It will require modifications to work: 275 * // - It may require correct/in-range values for request initialization. 276 * // - It may require specifying regional endpoints when creating the service client as shown in 277 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 278 * try (TestCasesClient testCasesClient = TestCasesClient.create()) { 279 * AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]"); 280 * testCasesClient.batchDeleteTestCases(parent); 281 * } 282 * }</pre> 283 * 284 * <p>======================= TransitionRouteGroupsClient ======================= 285 * 286 * <p>Service Description: Service for managing 287 * [TransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]. 288 * 289 * <p>Sample for TransitionRouteGroupsClient: 290 * 291 * <pre>{@code 292 * // This snippet has been automatically generated and should be regarded as a code template only. 293 * // It will require modifications to work: 294 * // - It may require correct/in-range values for request initialization. 295 * // - It may require specifying regional endpoints when creating the service client as shown in 296 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 297 * try (TransitionRouteGroupsClient transitionRouteGroupsClient = 298 * TransitionRouteGroupsClient.create()) { 299 * TransitionRouteGroupName name = 300 * TransitionRouteGroupName.of( 301 * "[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[TRANSITION_ROUTE_GROUP]"); 302 * TransitionRouteGroup response = transitionRouteGroupsClient.getTransitionRouteGroup(name); 303 * } 304 * }</pre> 305 * 306 * <p>======================= VersionsClient ======================= 307 * 308 * <p>Service Description: Service for managing [Versions][google.cloud.dialogflow.cx.v3.Version]. 309 * 310 * <p>Sample for VersionsClient: 311 * 312 * <pre>{@code 313 * // This snippet has been automatically generated and should be regarded as a code template only. 314 * // It will require modifications to work: 315 * // - It may require correct/in-range values for request initialization. 316 * // - It may require specifying regional endpoints when creating the service client as shown in 317 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 318 * try (VersionsClient versionsClient = VersionsClient.create()) { 319 * VersionName name = 320 * VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]"); 321 * Version response = versionsClient.getVersion(name); 322 * } 323 * }</pre> 324 * 325 * <p>======================= WebhooksClient ======================= 326 * 327 * <p>Service Description: Service for managing [Webhooks][google.cloud.dialogflow.cx.v3.Webhook]. 328 * 329 * <p>Sample for WebhooksClient: 330 * 331 * <pre>{@code 332 * // This snippet has been automatically generated and should be regarded as a code template only. 333 * // It will require modifications to work: 334 * // - It may require correct/in-range values for request initialization. 335 * // - It may require specifying regional endpoints when creating the service client as shown in 336 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 337 * try (WebhooksClient webhooksClient = WebhooksClient.create()) { 338 * WebhookName name = WebhookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]"); 339 * Webhook response = webhooksClient.getWebhook(name); 340 * } 341 * }</pre> 342 */ 343 @Generated("by gapic-generator-java") 344 package com.google.cloud.dialogflow.cx.v3; 345 346 import javax.annotation.Generated; 347