1 /* 2 * Copyright 2020 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 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/dialogflow/v2/context.proto 18 19 package com.google.cloud.dialogflow.v2; 20 21 public interface ContextOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2.Context) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The unique identifier of the context. Format: 31 * `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`, 32 * or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User 33 * ID>/sessions/<Session ID>/contexts/<Context ID>`. 34 * The `Context ID` is always converted to lowercase, may only contain 35 * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. 36 * If `Environment ID` is not specified, we assume default 'draft' 37 * environment. If `User ID` is not specified, we assume default '-' user. 38 * The following context names are reserved for internal use by Dialogflow. 39 * You should not use these contexts or create contexts with these names: 40 * * `__system_counters__` 41 * * `*_id_dialog_context` 42 * * `*_dialog_params_size` 43 * </pre> 44 * 45 * <code>string name = 1 [(.google.api.field_behavior) = REQUIRED];</code> 46 * 47 * @return The name. 48 */ getName()49 java.lang.String getName(); 50 /** 51 * 52 * 53 * <pre> 54 * Required. The unique identifier of the context. Format: 55 * `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`, 56 * or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User 57 * ID>/sessions/<Session ID>/contexts/<Context ID>`. 58 * The `Context ID` is always converted to lowercase, may only contain 59 * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. 60 * If `Environment ID` is not specified, we assume default 'draft' 61 * environment. If `User ID` is not specified, we assume default '-' user. 62 * The following context names are reserved for internal use by Dialogflow. 63 * You should not use these contexts or create contexts with these names: 64 * * `__system_counters__` 65 * * `*_id_dialog_context` 66 * * `*_dialog_params_size` 67 * </pre> 68 * 69 * <code>string name = 1 [(.google.api.field_behavior) = REQUIRED];</code> 70 * 71 * @return The bytes for name. 72 */ getNameBytes()73 com.google.protobuf.ByteString getNameBytes(); 74 75 /** 76 * 77 * 78 * <pre> 79 * Optional. The number of conversational query requests after which the 80 * context expires. The default is `0`. If set to `0`, the context expires 81 * immediately. Contexts expire automatically after 20 minutes if there 82 * are no matching queries. 83 * </pre> 84 * 85 * <code>int32 lifespan_count = 2 [(.google.api.field_behavior) = OPTIONAL];</code> 86 * 87 * @return The lifespanCount. 88 */ getLifespanCount()89 int getLifespanCount(); 90 91 /** 92 * 93 * 94 * <pre> 95 * Optional. The collection of parameters associated with this context. 96 * Depending on your protocol or client library language, this is a 97 * map, associative array, symbol table, dictionary, or JSON object 98 * composed of a collection of (MapKey, MapValue) pairs: 99 * - MapKey type: string 100 * - MapKey value: parameter name 101 * - MapValue type: 102 * - If parameter's entity type is a composite entity: map 103 * - Else: depending on parameter value type, could be one of string, 104 * number, boolean, null, list or map 105 * - MapValue value: 106 * - If parameter's entity type is a composite entity: 107 * map from composite entity property names to property values 108 * - Else: parameter value 109 * </pre> 110 * 111 * <code>.google.protobuf.Struct parameters = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 112 * 113 * @return Whether the parameters field is set. 114 */ hasParameters()115 boolean hasParameters(); 116 /** 117 * 118 * 119 * <pre> 120 * Optional. The collection of parameters associated with this context. 121 * Depending on your protocol or client library language, this is a 122 * map, associative array, symbol table, dictionary, or JSON object 123 * composed of a collection of (MapKey, MapValue) pairs: 124 * - MapKey type: string 125 * - MapKey value: parameter name 126 * - MapValue type: 127 * - If parameter's entity type is a composite entity: map 128 * - Else: depending on parameter value type, could be one of string, 129 * number, boolean, null, list or map 130 * - MapValue value: 131 * - If parameter's entity type is a composite entity: 132 * map from composite entity property names to property values 133 * - Else: parameter value 134 * </pre> 135 * 136 * <code>.google.protobuf.Struct parameters = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 137 * 138 * @return The parameters. 139 */ getParameters()140 com.google.protobuf.Struct getParameters(); 141 /** 142 * 143 * 144 * <pre> 145 * Optional. The collection of parameters associated with this context. 146 * Depending on your protocol or client library language, this is a 147 * map, associative array, symbol table, dictionary, or JSON object 148 * composed of a collection of (MapKey, MapValue) pairs: 149 * - MapKey type: string 150 * - MapKey value: parameter name 151 * - MapValue type: 152 * - If parameter's entity type is a composite entity: map 153 * - Else: depending on parameter value type, could be one of string, 154 * number, boolean, null, list or map 155 * - MapValue value: 156 * - If parameter's entity type is a composite entity: 157 * map from composite entity property names to property values 158 * - Else: parameter value 159 * </pre> 160 * 161 * <code>.google.protobuf.Struct parameters = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 162 */ getParametersOrBuilder()163 com.google.protobuf.StructOrBuilder getParametersOrBuilder(); 164 } 165