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/apigateway/v1/apigateway.proto 18 19 package com.google.cloud.apigateway.v1; 20 21 public interface ApiOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.apigateway.v1.Api) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Output only. Resource name of the API. 31 * Format: projects/{project}/locations/global/apis/{api} 32 * </pre> 33 * 34 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 35 * 36 * @return The name. 37 */ getName()38 java.lang.String getName(); 39 /** 40 * 41 * 42 * <pre> 43 * Output only. Resource name of the API. 44 * Format: projects/{project}/locations/global/apis/{api} 45 * </pre> 46 * 47 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 48 * 49 * @return The bytes for name. 50 */ getNameBytes()51 com.google.protobuf.ByteString getNameBytes(); 52 53 /** 54 * 55 * 56 * <pre> 57 * Output only. Created time. 58 * </pre> 59 * 60 * <code>.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; 61 * </code> 62 * 63 * @return Whether the createTime field is set. 64 */ hasCreateTime()65 boolean hasCreateTime(); 66 /** 67 * 68 * 69 * <pre> 70 * Output only. Created time. 71 * </pre> 72 * 73 * <code>.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; 74 * </code> 75 * 76 * @return The createTime. 77 */ getCreateTime()78 com.google.protobuf.Timestamp getCreateTime(); 79 /** 80 * 81 * 82 * <pre> 83 * Output only. Created time. 84 * </pre> 85 * 86 * <code>.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; 87 * </code> 88 */ getCreateTimeOrBuilder()89 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 90 91 /** 92 * 93 * 94 * <pre> 95 * Output only. Updated time. 96 * </pre> 97 * 98 * <code>.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; 99 * </code> 100 * 101 * @return Whether the updateTime field is set. 102 */ hasUpdateTime()103 boolean hasUpdateTime(); 104 /** 105 * 106 * 107 * <pre> 108 * Output only. Updated time. 109 * </pre> 110 * 111 * <code>.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; 112 * </code> 113 * 114 * @return The updateTime. 115 */ getUpdateTime()116 com.google.protobuf.Timestamp getUpdateTime(); 117 /** 118 * 119 * 120 * <pre> 121 * Output only. Updated time. 122 * </pre> 123 * 124 * <code>.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; 125 * </code> 126 */ getUpdateTimeOrBuilder()127 com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder(); 128 129 /** 130 * 131 * 132 * <pre> 133 * Optional. Resource labels to represent user-provided metadata. 134 * Refer to cloud documentation on labels for more details. 135 * https://cloud.google.com/compute/docs/labeling-resources 136 * </pre> 137 * 138 * <code>map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 139 */ getLabelsCount()140 int getLabelsCount(); 141 /** 142 * 143 * 144 * <pre> 145 * Optional. Resource labels to represent user-provided metadata. 146 * Refer to cloud documentation on labels for more details. 147 * https://cloud.google.com/compute/docs/labeling-resources 148 * </pre> 149 * 150 * <code>map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 151 */ containsLabels(java.lang.String key)152 boolean containsLabels(java.lang.String key); 153 /** Use {@link #getLabelsMap()} instead. */ 154 @java.lang.Deprecated getLabels()155 java.util.Map<java.lang.String, java.lang.String> getLabels(); 156 /** 157 * 158 * 159 * <pre> 160 * Optional. Resource labels to represent user-provided metadata. 161 * Refer to cloud documentation on labels for more details. 162 * https://cloud.google.com/compute/docs/labeling-resources 163 * </pre> 164 * 165 * <code>map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 166 */ getLabelsMap()167 java.util.Map<java.lang.String, java.lang.String> getLabelsMap(); 168 /** 169 * 170 * 171 * <pre> 172 * Optional. Resource labels to represent user-provided metadata. 173 * Refer to cloud documentation on labels for more details. 174 * https://cloud.google.com/compute/docs/labeling-resources 175 * </pre> 176 * 177 * <code>map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 178 */ 179 /* nullable */ getLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)180 java.lang.String getLabelsOrDefault( 181 java.lang.String key, 182 /* nullable */ 183 java.lang.String defaultValue); 184 /** 185 * 186 * 187 * <pre> 188 * Optional. Resource labels to represent user-provided metadata. 189 * Refer to cloud documentation on labels for more details. 190 * https://cloud.google.com/compute/docs/labeling-resources 191 * </pre> 192 * 193 * <code>map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 194 */ getLabelsOrThrow(java.lang.String key)195 java.lang.String getLabelsOrThrow(java.lang.String key); 196 197 /** 198 * 199 * 200 * <pre> 201 * Optional. Display name. 202 * </pre> 203 * 204 * <code>string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];</code> 205 * 206 * @return The displayName. 207 */ getDisplayName()208 java.lang.String getDisplayName(); 209 /** 210 * 211 * 212 * <pre> 213 * Optional. Display name. 214 * </pre> 215 * 216 * <code>string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];</code> 217 * 218 * @return The bytes for displayName. 219 */ getDisplayNameBytes()220 com.google.protobuf.ByteString getDisplayNameBytes(); 221 222 /** 223 * 224 * 225 * <pre> 226 * Optional. Immutable. The name of a Google Managed Service ( 227 * https://cloud.google.com/service-infrastructure/docs/glossary#managed). If 228 * not specified, a new Service will automatically be created in the same 229 * project as this API. 230 * </pre> 231 * 232 * <code> 233 * string managed_service = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... } 234 * </code> 235 * 236 * @return The managedService. 237 */ getManagedService()238 java.lang.String getManagedService(); 239 /** 240 * 241 * 242 * <pre> 243 * Optional. Immutable. The name of a Google Managed Service ( 244 * https://cloud.google.com/service-infrastructure/docs/glossary#managed). If 245 * not specified, a new Service will automatically be created in the same 246 * project as this API. 247 * </pre> 248 * 249 * <code> 250 * string managed_service = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... } 251 * </code> 252 * 253 * @return The bytes for managedService. 254 */ getManagedServiceBytes()255 com.google.protobuf.ByteString getManagedServiceBytes(); 256 257 /** 258 * 259 * 260 * <pre> 261 * Output only. State of the API. 262 * </pre> 263 * 264 * <code> 265 * .google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 266 * </code> 267 * 268 * @return The enum numeric value on the wire for state. 269 */ getStateValue()270 int getStateValue(); 271 /** 272 * 273 * 274 * <pre> 275 * Output only. State of the API. 276 * </pre> 277 * 278 * <code> 279 * .google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 280 * </code> 281 * 282 * @return The state. 283 */ getState()284 com.google.cloud.apigateway.v1.Api.State getState(); 285 } 286