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 package com.google.cloud.dialogflow.v2; 18 19 import com.google.api.core.BetaApi; 20 import com.google.api.pathtemplate.PathTemplate; 21 import com.google.api.pathtemplate.ValidationException; 22 import com.google.api.resourcenames.ResourceName; 23 import com.google.common.base.Preconditions; 24 import com.google.common.collect.ImmutableMap; 25 import java.util.ArrayList; 26 import java.util.List; 27 import java.util.Map; 28 import java.util.Objects; 29 import javax.annotation.Generated; 30 31 // AUTO-GENERATED DOCUMENTATION AND CLASS. 32 @Generated("by gapic-generator-java") 33 public class ConversationName implements ResourceName { 34 private static final PathTemplate PROJECT_CONVERSATION = 35 PathTemplate.createWithoutUrlEncoding("projects/{project}/conversations/{conversation}"); 36 private static final PathTemplate PROJECT_LOCATION_CONVERSATION = 37 PathTemplate.createWithoutUrlEncoding( 38 "projects/{project}/locations/{location}/conversations/{conversation}"); 39 private volatile Map<String, String> fieldValuesMap; 40 private PathTemplate pathTemplate; 41 private String fixedValue; 42 private final String project; 43 private final String conversation; 44 private final String location; 45 46 @Deprecated ConversationName()47 protected ConversationName() { 48 project = null; 49 conversation = null; 50 location = null; 51 } 52 ConversationName(Builder builder)53 private ConversationName(Builder builder) { 54 project = Preconditions.checkNotNull(builder.getProject()); 55 conversation = Preconditions.checkNotNull(builder.getConversation()); 56 location = null; 57 pathTemplate = PROJECT_CONVERSATION; 58 } 59 ConversationName(ProjectLocationConversationBuilder builder)60 private ConversationName(ProjectLocationConversationBuilder builder) { 61 project = Preconditions.checkNotNull(builder.getProject()); 62 location = Preconditions.checkNotNull(builder.getLocation()); 63 conversation = Preconditions.checkNotNull(builder.getConversation()); 64 pathTemplate = PROJECT_LOCATION_CONVERSATION; 65 } 66 getProject()67 public String getProject() { 68 return project; 69 } 70 getConversation()71 public String getConversation() { 72 return conversation; 73 } 74 getLocation()75 public String getLocation() { 76 return location; 77 } 78 newBuilder()79 public static Builder newBuilder() { 80 return new Builder(); 81 } 82 83 @BetaApi("The per-pattern Builders are not stable yet and may be changed in the future.") newProjectConversationBuilder()84 public static Builder newProjectConversationBuilder() { 85 return new Builder(); 86 } 87 88 @BetaApi("The per-pattern Builders are not stable yet and may be changed in the future.") newProjectLocationConversationBuilder()89 public static ProjectLocationConversationBuilder newProjectLocationConversationBuilder() { 90 return new ProjectLocationConversationBuilder(); 91 } 92 toBuilder()93 public Builder toBuilder() { 94 return new Builder(this); 95 } 96 of(String project, String conversation)97 public static ConversationName of(String project, String conversation) { 98 return newBuilder().setProject(project).setConversation(conversation).build(); 99 } 100 101 @BetaApi("The static create methods are not stable yet and may be changed in the future.") ofProjectConversationName(String project, String conversation)102 public static ConversationName ofProjectConversationName(String project, String conversation) { 103 return newBuilder().setProject(project).setConversation(conversation).build(); 104 } 105 106 @BetaApi("The static create methods are not stable yet and may be changed in the future.") ofProjectLocationConversationName( String project, String location, String conversation)107 public static ConversationName ofProjectLocationConversationName( 108 String project, String location, String conversation) { 109 return newProjectLocationConversationBuilder() 110 .setProject(project) 111 .setLocation(location) 112 .setConversation(conversation) 113 .build(); 114 } 115 format(String project, String conversation)116 public static String format(String project, String conversation) { 117 return newBuilder().setProject(project).setConversation(conversation).build().toString(); 118 } 119 120 @BetaApi("The static format methods are not stable yet and may be changed in the future.") formatProjectConversationName(String project, String conversation)121 public static String formatProjectConversationName(String project, String conversation) { 122 return newBuilder().setProject(project).setConversation(conversation).build().toString(); 123 } 124 125 @BetaApi("The static format methods are not stable yet and may be changed in the future.") formatProjectLocationConversationName( String project, String location, String conversation)126 public static String formatProjectLocationConversationName( 127 String project, String location, String conversation) { 128 return newProjectLocationConversationBuilder() 129 .setProject(project) 130 .setLocation(location) 131 .setConversation(conversation) 132 .build() 133 .toString(); 134 } 135 parse(String formattedString)136 public static ConversationName parse(String formattedString) { 137 if (formattedString.isEmpty()) { 138 return null; 139 } 140 if (PROJECT_CONVERSATION.matches(formattedString)) { 141 Map<String, String> matchMap = PROJECT_CONVERSATION.match(formattedString); 142 return ofProjectConversationName(matchMap.get("project"), matchMap.get("conversation")); 143 } else if (PROJECT_LOCATION_CONVERSATION.matches(formattedString)) { 144 Map<String, String> matchMap = PROJECT_LOCATION_CONVERSATION.match(formattedString); 145 return ofProjectLocationConversationName( 146 matchMap.get("project"), matchMap.get("location"), matchMap.get("conversation")); 147 } 148 throw new ValidationException("ConversationName.parse: formattedString not in valid format"); 149 } 150 parseList(List<String> formattedStrings)151 public static List<ConversationName> parseList(List<String> formattedStrings) { 152 List<ConversationName> list = new ArrayList<>(formattedStrings.size()); 153 for (String formattedString : formattedStrings) { 154 list.add(parse(formattedString)); 155 } 156 return list; 157 } 158 toStringList(List<ConversationName> values)159 public static List<String> toStringList(List<ConversationName> values) { 160 List<String> list = new ArrayList<>(values.size()); 161 for (ConversationName value : values) { 162 if (value == null) { 163 list.add(""); 164 } else { 165 list.add(value.toString()); 166 } 167 } 168 return list; 169 } 170 isParsableFrom(String formattedString)171 public static boolean isParsableFrom(String formattedString) { 172 return PROJECT_CONVERSATION.matches(formattedString) 173 || PROJECT_LOCATION_CONVERSATION.matches(formattedString); 174 } 175 176 @Override getFieldValuesMap()177 public Map<String, String> getFieldValuesMap() { 178 if (fieldValuesMap == null) { 179 synchronized (this) { 180 if (fieldValuesMap == null) { 181 ImmutableMap.Builder<String, String> fieldMapBuilder = ImmutableMap.builder(); 182 if (project != null) { 183 fieldMapBuilder.put("project", project); 184 } 185 if (conversation != null) { 186 fieldMapBuilder.put("conversation", conversation); 187 } 188 if (location != null) { 189 fieldMapBuilder.put("location", location); 190 } 191 fieldValuesMap = fieldMapBuilder.build(); 192 } 193 } 194 } 195 return fieldValuesMap; 196 } 197 getFieldValue(String fieldName)198 public String getFieldValue(String fieldName) { 199 return getFieldValuesMap().get(fieldName); 200 } 201 202 @Override toString()203 public String toString() { 204 return fixedValue != null ? fixedValue : pathTemplate.instantiate(getFieldValuesMap()); 205 } 206 207 @Override equals(Object o)208 public boolean equals(Object o) { 209 if (o == this) { 210 return true; 211 } 212 if (o != null || getClass() == o.getClass()) { 213 ConversationName that = ((ConversationName) o); 214 return Objects.equals(this.project, that.project) 215 && Objects.equals(this.conversation, that.conversation) 216 && Objects.equals(this.location, that.location); 217 } 218 return false; 219 } 220 221 @Override hashCode()222 public int hashCode() { 223 int h = 1; 224 h *= 1000003; 225 h ^= Objects.hashCode(fixedValue); 226 h *= 1000003; 227 h ^= Objects.hashCode(project); 228 h *= 1000003; 229 h ^= Objects.hashCode(conversation); 230 h *= 1000003; 231 h ^= Objects.hashCode(location); 232 return h; 233 } 234 235 /** Builder for projects/{project}/conversations/{conversation}. */ 236 public static class Builder { 237 private String project; 238 private String conversation; 239 Builder()240 protected Builder() {} 241 getProject()242 public String getProject() { 243 return project; 244 } 245 getConversation()246 public String getConversation() { 247 return conversation; 248 } 249 setProject(String project)250 public Builder setProject(String project) { 251 this.project = project; 252 return this; 253 } 254 setConversation(String conversation)255 public Builder setConversation(String conversation) { 256 this.conversation = conversation; 257 return this; 258 } 259 Builder(ConversationName conversationName)260 private Builder(ConversationName conversationName) { 261 Preconditions.checkArgument( 262 Objects.equals(conversationName.pathTemplate, PROJECT_CONVERSATION), 263 "toBuilder is only supported when ConversationName has the pattern of projects/{project}/conversations/{conversation}"); 264 this.project = conversationName.project; 265 this.conversation = conversationName.conversation; 266 } 267 build()268 public ConversationName build() { 269 return new ConversationName(this); 270 } 271 } 272 273 /** Builder for projects/{project}/locations/{location}/conversations/{conversation}. */ 274 @BetaApi("The per-pattern Builders are not stable yet and may be changed in the future.") 275 public static class ProjectLocationConversationBuilder { 276 private String project; 277 private String location; 278 private String conversation; 279 ProjectLocationConversationBuilder()280 protected ProjectLocationConversationBuilder() {} 281 getProject()282 public String getProject() { 283 return project; 284 } 285 getLocation()286 public String getLocation() { 287 return location; 288 } 289 getConversation()290 public String getConversation() { 291 return conversation; 292 } 293 setProject(String project)294 public ProjectLocationConversationBuilder setProject(String project) { 295 this.project = project; 296 return this; 297 } 298 setLocation(String location)299 public ProjectLocationConversationBuilder setLocation(String location) { 300 this.location = location; 301 return this; 302 } 303 setConversation(String conversation)304 public ProjectLocationConversationBuilder setConversation(String conversation) { 305 this.conversation = conversation; 306 return this; 307 } 308 build()309 public ConversationName build() { 310 return new ConversationName(this); 311 } 312 } 313 } 314