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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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 161 * [Intents][google.cloud.dialogflow.cx.v3beta1.Intent]. 162 * 163 * <p>Sample for IntentsClient: 164 * 165 * <pre>{@code 166 * // This snippet has been automatically generated and should be regarded as a code template only. 167 * // It will require modifications to work: 168 * // - It may require correct/in-range values for request initialization. 169 * // - It may require specifying regional endpoints when creating the service client as shown in 170 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 171 * try (IntentsClient intentsClient = IntentsClient.create()) { 172 * IntentName name = IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]"); 173 * Intent response = intentsClient.getIntent(name); 174 * } 175 * }</pre> 176 * 177 * <p>======================= PagesClient ======================= 178 * 179 * <p>Service Description: Service for managing [Pages][google.cloud.dialogflow.cx.v3beta1.Page]. 180 * 181 * <p>Sample for PagesClient: 182 * 183 * <pre>{@code 184 * // This snippet has been automatically generated and should be regarded as a code template only. 185 * // It will require modifications to work: 186 * // - It may require correct/in-range values for request initialization. 187 * // - It may require specifying regional endpoints when creating the service client as shown in 188 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 189 * try (PagesClient pagesClient = PagesClient.create()) { 190 * PageName name = PageName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[PAGE]"); 191 * Page response = pagesClient.getPage(name); 192 * } 193 * }</pre> 194 * 195 * <p>======================= SecuritySettingsServiceClient ======================= 196 * 197 * <p>Service Description: Service for managing security settings for Dialogflow. 198 * 199 * <p>Sample for SecuritySettingsServiceClient: 200 * 201 * <pre>{@code 202 * // This snippet has been automatically generated and should be regarded as a code template only. 203 * // It will require modifications to work: 204 * // - It may require correct/in-range values for request initialization. 205 * // - It may require specifying regional endpoints when creating the service client as shown in 206 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 207 * try (SecuritySettingsServiceClient securitySettingsServiceClient = 208 * SecuritySettingsServiceClient.create()) { 209 * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); 210 * SecuritySettings securitySettings = SecuritySettings.newBuilder().build(); 211 * SecuritySettings response = 212 * securitySettingsServiceClient.createSecuritySettings(parent, securitySettings); 213 * } 214 * }</pre> 215 * 216 * <p>======================= SessionsClient ======================= 217 * 218 * <p>Service Description: A session represents an interaction with a user. You retrieve user input 219 * and pass it to the [DetectIntent][google.cloud.dialogflow.cx.v3beta1.Sessions.DetectIntent] 220 * method to determine user intent and respond. 221 * 222 * <p>Sample for SessionsClient: 223 * 224 * <pre>{@code 225 * // This snippet has been automatically generated and should be regarded as a code template only. 226 * // It will require modifications to work: 227 * // - It may require correct/in-range values for request initialization. 228 * // - It may require specifying regional endpoints when creating the service client as shown in 229 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 230 * try (SessionsClient sessionsClient = SessionsClient.create()) { 231 * DetectIntentRequest request = 232 * DetectIntentRequest.newBuilder() 233 * .setSession( 234 * SessionName.ofProjectLocationAgentSessionName( 235 * "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]") 236 * .toString()) 237 * .setQueryParams(QueryParameters.newBuilder().build()) 238 * .setQueryInput(QueryInput.newBuilder().build()) 239 * .setOutputAudioConfig(OutputAudioConfig.newBuilder().build()) 240 * .build(); 241 * DetectIntentResponse response = sessionsClient.detectIntent(request); 242 * } 243 * }</pre> 244 * 245 * <p>======================= SessionEntityTypesClient ======================= 246 * 247 * <p>Service Description: Service for managing 248 * [SessionEntityTypes][google.cloud.dialogflow.cx.v3beta1.SessionEntityType]. 249 * 250 * <p>Sample for SessionEntityTypesClient: 251 * 252 * <pre>{@code 253 * // This snippet has been automatically generated and should be regarded as a code template only. 254 * // It will require modifications to work: 255 * // - It may require correct/in-range values for request initialization. 256 * // - It may require specifying regional endpoints when creating the service client as shown in 257 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 258 * try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) { 259 * SessionEntityTypeName name = 260 * SessionEntityTypeName.ofProjectLocationAgentSessionEntityTypeName( 261 * "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]"); 262 * SessionEntityType response = sessionEntityTypesClient.getSessionEntityType(name); 263 * } 264 * }</pre> 265 * 266 * <p>======================= TestCasesClient ======================= 267 * 268 * <p>Service Description: Service for managing [Test 269 * Cases][google.cloud.dialogflow.cx.v3beta1.TestCase] and [Test Case 270 * Results][google.cloud.dialogflow.cx.v3beta1.TestCaseResult]. 271 * 272 * <p>Sample for TestCasesClient: 273 * 274 * <pre>{@code 275 * // This snippet has been automatically generated and should be regarded as a code template only. 276 * // It will require modifications to work: 277 * // - It may require correct/in-range values for request initialization. 278 * // - It may require specifying regional endpoints when creating the service client as shown in 279 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 280 * try (TestCasesClient testCasesClient = TestCasesClient.create()) { 281 * AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]"); 282 * testCasesClient.batchDeleteTestCases(parent); 283 * } 284 * }</pre> 285 * 286 * <p>======================= TransitionRouteGroupsClient ======================= 287 * 288 * <p>Service Description: Service for managing 289 * [TransitionRouteGroups][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup]. 290 * 291 * <p>Sample for TransitionRouteGroupsClient: 292 * 293 * <pre>{@code 294 * // This snippet has been automatically generated and should be regarded as a code template only. 295 * // It will require modifications to work: 296 * // - It may require correct/in-range values for request initialization. 297 * // - It may require specifying regional endpoints when creating the service client as shown in 298 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 299 * try (TransitionRouteGroupsClient transitionRouteGroupsClient = 300 * TransitionRouteGroupsClient.create()) { 301 * TransitionRouteGroupName name = 302 * TransitionRouteGroupName.of( 303 * "[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[TRANSITION_ROUTE_GROUP]"); 304 * TransitionRouteGroup response = transitionRouteGroupsClient.getTransitionRouteGroup(name); 305 * } 306 * }</pre> 307 * 308 * <p>======================= VersionsClient ======================= 309 * 310 * <p>Service Description: Service for managing 311 * [Versions][google.cloud.dialogflow.cx.v3beta1.Version]. 312 * 313 * <p>Sample for VersionsClient: 314 * 315 * <pre>{@code 316 * // This snippet has been automatically generated and should be regarded as a code template only. 317 * // It will require modifications to work: 318 * // - It may require correct/in-range values for request initialization. 319 * // - It may require specifying regional endpoints when creating the service client as shown in 320 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 321 * try (VersionsClient versionsClient = VersionsClient.create()) { 322 * VersionName name = 323 * VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]"); 324 * Version response = versionsClient.getVersion(name); 325 * } 326 * }</pre> 327 * 328 * <p>======================= WebhooksClient ======================= 329 * 330 * <p>Service Description: Service for managing 331 * [Webhooks][google.cloud.dialogflow.cx.v3beta1.Webhook]. 332 * 333 * <p>Sample for WebhooksClient: 334 * 335 * <pre>{@code 336 * // This snippet has been automatically generated and should be regarded as a code template only. 337 * // It will require modifications to work: 338 * // - It may require correct/in-range values for request initialization. 339 * // - It may require specifying regional endpoints when creating the service client as shown in 340 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 341 * try (WebhooksClient webhooksClient = WebhooksClient.create()) { 342 * WebhookName name = WebhookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]"); 343 * Webhook response = webhooksClient.getWebhook(name); 344 * } 345 * }</pre> 346 */ 347 @Generated("by gapic-generator-java") 348 package com.google.cloud.dialogflow.cx.v3beta1; 349 350 import javax.annotation.Generated; 351