| [e3d4e0a] | 1 | <?php
|
|---|
| 2 | /*
|
|---|
| 3 | * Copyright 2014 Google Inc.
|
|---|
| 4 | *
|
|---|
| 5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
|---|
| 6 | * use this file except in compliance with the License. You may obtain a copy of
|
|---|
| 7 | * the License at
|
|---|
| 8 | *
|
|---|
| 9 | * http://www.apache.org/licenses/LICENSE-2.0
|
|---|
| 10 | *
|
|---|
| 11 | * Unless required by applicable law or agreed to in writing, software
|
|---|
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|---|
| 13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|---|
| 14 | * License for the specific language governing permissions and limitations under
|
|---|
| 15 | * the License.
|
|---|
| 16 | */
|
|---|
| 17 |
|
|---|
| 18 | namespace Google\Service\Dialogflow\Resource;
|
|---|
| 19 |
|
|---|
| 20 | use Google\Service\Dialogflow\GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse;
|
|---|
| 21 | use Google\Service\Dialogflow\GoogleCloudDialogflowCxV3TransitionRouteGroup;
|
|---|
| 22 | use Google\Service\Dialogflow\GoogleProtobufEmpty;
|
|---|
| 23 |
|
|---|
| 24 | /**
|
|---|
| 25 | * The "transitionRouteGroups" collection of methods.
|
|---|
| 26 | * Typical usage is:
|
|---|
| 27 | * <code>
|
|---|
| 28 | * $dialogflowService = new Google\Service\Dialogflow(...);
|
|---|
| 29 | * $transitionRouteGroups = $dialogflowService->projects_locations_agents_flows_transitionRouteGroups;
|
|---|
| 30 | * </code>
|
|---|
| 31 | */
|
|---|
| 32 | class ProjectsLocationsAgentsFlowsTransitionRouteGroups extends \Google\Service\Resource
|
|---|
| 33 | {
|
|---|
| 34 | /**
|
|---|
| 35 | * Creates an TransitionRouteGroup in the specified flow. Note: You should
|
|---|
| 36 | * always train a flow prior to sending it queries. See the [training
|
|---|
| 37 | * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
|
|---|
| 38 | * (transitionRouteGroups.create)
|
|---|
| 39 | *
|
|---|
| 40 | * @param string $parent Required. The flow to create an TransitionRouteGroup
|
|---|
| 41 | * for. Format: `projects//locations//agents//flows/` or
|
|---|
| 42 | * `projects//locations//agents/` for agent-level groups.
|
|---|
| 43 | * @param GoogleCloudDialogflowCxV3TransitionRouteGroup $postBody
|
|---|
| 44 | * @param array $optParams Optional parameters.
|
|---|
| 45 | *
|
|---|
| 46 | * @opt_param string languageCode The language of the following fields in
|
|---|
| 47 | * `TransitionRouteGroup`: *
|
|---|
| 48 | * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `Tran
|
|---|
| 49 | * sitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If
|
|---|
| 50 | * not specified, the agent's default language is used. [Many
|
|---|
| 51 | * languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
|
|---|
| 52 | * are supported. Note: languages must be enabled in the agent before they can
|
|---|
| 53 | * be used.
|
|---|
| 54 | * @return GoogleCloudDialogflowCxV3TransitionRouteGroup
|
|---|
| 55 | * @throws \Google\Service\Exception
|
|---|
| 56 | */
|
|---|
| 57 | public function create($parent, GoogleCloudDialogflowCxV3TransitionRouteGroup $postBody, $optParams = [])
|
|---|
| 58 | {
|
|---|
| 59 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
|---|
| 60 | $params = array_merge($params, $optParams);
|
|---|
| 61 | return $this->call('create', [$params], GoogleCloudDialogflowCxV3TransitionRouteGroup::class);
|
|---|
| 62 | }
|
|---|
| 63 | /**
|
|---|
| 64 | * Deletes the specified TransitionRouteGroup. Note: You should always train a
|
|---|
| 65 | * flow prior to sending it queries. See the [training
|
|---|
| 66 | * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
|
|---|
| 67 | * (transitionRouteGroups.delete)
|
|---|
| 68 | *
|
|---|
| 69 | * @param string $name Required. The name of the TransitionRouteGroup to delete.
|
|---|
| 70 | * Format: `projects//locations//agents//flows//transitionRouteGroups/` or
|
|---|
| 71 | * `projects//locations//agents//transitionRouteGroups/`.
|
|---|
| 72 | * @param array $optParams Optional parameters.
|
|---|
| 73 | *
|
|---|
| 74 | * @opt_param bool force This field has no effect for transition route group
|
|---|
| 75 | * that no page is using. If the transition route group is referenced by any
|
|---|
| 76 | * page: * If `force` is set to false, an error will be returned with message
|
|---|
| 77 | * indicating pages that reference the transition route group. * If `force` is
|
|---|
| 78 | * set to true, Dialogflow will remove the transition route group, as well as
|
|---|
| 79 | * any reference to it.
|
|---|
| 80 | * @return GoogleProtobufEmpty
|
|---|
| 81 | * @throws \Google\Service\Exception
|
|---|
| 82 | */
|
|---|
| 83 | public function delete($name, $optParams = [])
|
|---|
| 84 | {
|
|---|
| 85 | $params = ['name' => $name];
|
|---|
| 86 | $params = array_merge($params, $optParams);
|
|---|
| 87 | return $this->call('delete', [$params], GoogleProtobufEmpty::class);
|
|---|
| 88 | }
|
|---|
| 89 | /**
|
|---|
| 90 | * Retrieves the specified TransitionRouteGroup. (transitionRouteGroups.get)
|
|---|
| 91 | *
|
|---|
| 92 | * @param string $name Required. The name of the TransitionRouteGroup. Format:
|
|---|
| 93 | * `projects//locations//agents//flows//transitionRouteGroups/` or
|
|---|
| 94 | * `projects//locations//agents//transitionRouteGroups/`.
|
|---|
| 95 | * @param array $optParams Optional parameters.
|
|---|
| 96 | *
|
|---|
| 97 | * @opt_param string languageCode The language to retrieve the transition route
|
|---|
| 98 | * group for. The following fields are language dependent: *
|
|---|
| 99 | * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `Tran
|
|---|
| 100 | * sitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If
|
|---|
| 101 | * not specified, the agent's default language is used. [Many
|
|---|
| 102 | * languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
|
|---|
| 103 | * are supported. Note: languages must be enabled in the agent before they can
|
|---|
| 104 | * be used.
|
|---|
| 105 | * @return GoogleCloudDialogflowCxV3TransitionRouteGroup
|
|---|
| 106 | * @throws \Google\Service\Exception
|
|---|
| 107 | */
|
|---|
| 108 | public function get($name, $optParams = [])
|
|---|
| 109 | {
|
|---|
| 110 | $params = ['name' => $name];
|
|---|
| 111 | $params = array_merge($params, $optParams);
|
|---|
| 112 | return $this->call('get', [$params], GoogleCloudDialogflowCxV3TransitionRouteGroup::class);
|
|---|
| 113 | }
|
|---|
| 114 | /**
|
|---|
| 115 | * Returns the list of all transition route groups in the specified flow.
|
|---|
| 116 | * (transitionRouteGroups.listProjectsLocationsAgentsFlowsTransitionRouteGroups)
|
|---|
| 117 | *
|
|---|
| 118 | * @param string $parent Required. The flow to list all transition route groups
|
|---|
| 119 | * for. Format: `projects//locations//agents//flows/` or
|
|---|
| 120 | * `projects//locations//agents/.
|
|---|
| 121 | * @param array $optParams Optional parameters.
|
|---|
| 122 | *
|
|---|
| 123 | * @opt_param string languageCode The language to list transition route groups
|
|---|
| 124 | * for. The following fields are language dependent: *
|
|---|
| 125 | * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `Tran
|
|---|
| 126 | * sitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If
|
|---|
| 127 | * not specified, the agent's default language is used. [Many
|
|---|
| 128 | * languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
|
|---|
| 129 | * are supported. Note: languages must be enabled in the agent before they can
|
|---|
| 130 | * be used.
|
|---|
| 131 | * @opt_param int pageSize The maximum number of items to return in a single
|
|---|
| 132 | * page. By default 100 and at most 1000.
|
|---|
| 133 | * @opt_param string pageToken The next_page_token value returned from a
|
|---|
| 134 | * previous list request.
|
|---|
| 135 | * @return GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse
|
|---|
| 136 | * @throws \Google\Service\Exception
|
|---|
| 137 | */
|
|---|
| 138 | public function listProjectsLocationsAgentsFlowsTransitionRouteGroups($parent, $optParams = [])
|
|---|
| 139 | {
|
|---|
| 140 | $params = ['parent' => $parent];
|
|---|
| 141 | $params = array_merge($params, $optParams);
|
|---|
| 142 | return $this->call('list', [$params], GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse::class);
|
|---|
| 143 | }
|
|---|
| 144 | /**
|
|---|
| 145 | * Updates the specified TransitionRouteGroup. Note: You should always train a
|
|---|
| 146 | * flow prior to sending it queries. See the [training
|
|---|
| 147 | * documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
|
|---|
| 148 | * (transitionRouteGroups.patch)
|
|---|
| 149 | *
|
|---|
| 150 | * @param string $name The unique identifier of the transition route group.
|
|---|
| 151 | * TransitionRouteGroups.CreateTransitionRouteGroup populates the name
|
|---|
| 152 | * automatically. Format:
|
|---|
| 153 | * `projects//locations//agents//flows//transitionRouteGroups/` .
|
|---|
| 154 | * @param GoogleCloudDialogflowCxV3TransitionRouteGroup $postBody
|
|---|
| 155 | * @param array $optParams Optional parameters.
|
|---|
| 156 | *
|
|---|
| 157 | * @opt_param string languageCode The language of the following fields in
|
|---|
| 158 | * `TransitionRouteGroup`: *
|
|---|
| 159 | * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `Tran
|
|---|
| 160 | * sitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If
|
|---|
| 161 | * not specified, the agent's default language is used. [Many
|
|---|
| 162 | * languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
|
|---|
| 163 | * are supported. Note: languages must be enabled in the agent before they can
|
|---|
| 164 | * be used.
|
|---|
| 165 | * @opt_param string updateMask The mask to control which fields get updated.
|
|---|
| 166 | * @return GoogleCloudDialogflowCxV3TransitionRouteGroup
|
|---|
| 167 | * @throws \Google\Service\Exception
|
|---|
| 168 | */
|
|---|
| 169 | public function patch($name, GoogleCloudDialogflowCxV3TransitionRouteGroup $postBody, $optParams = [])
|
|---|
| 170 | {
|
|---|
| 171 | $params = ['name' => $name, 'postBody' => $postBody];
|
|---|
| 172 | $params = array_merge($params, $optParams);
|
|---|
| 173 | return $this->call('patch', [$params], GoogleCloudDialogflowCxV3TransitionRouteGroup::class);
|
|---|
| 174 | }
|
|---|
| 175 | }
|
|---|
| 176 |
|
|---|
| 177 | // Adding a class alias for backwards compatibility with the previous class name.
|
|---|
| 178 | class_alias(ProjectsLocationsAgentsFlowsTransitionRouteGroups::class, 'Google_Service_Dialogflow_Resource_ProjectsLocationsAgentsFlowsTransitionRouteGroups');
|
|---|
