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 ApiConfigOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.apigateway.v1.ApiConfig) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Output only. Resource name of the API Config. 31 * Format: projects/{project}/locations/global/apis/{api}/configs/{api_config} 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 Config. 44 * Format: projects/{project}/locations/global/apis/{api}/configs/{api_config} 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 * Immutable. The Google Cloud IAM Service Account that Gateways serving this config 227 * should use to authenticate to other services. This may either be the 228 * Service Account's email 229 * (`{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`) or its full resource 230 * name (`projects/{PROJECT}/accounts/{UNIQUE_ID}`). This is most often used 231 * when the service is a GCP resource such as a Cloud Run Service or an 232 * IAP-secured service. 233 * </pre> 234 * 235 * <code> 236 * string gateway_service_account = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... } 237 * </code> 238 * 239 * @return The gatewayServiceAccount. 240 */ getGatewayServiceAccount()241 java.lang.String getGatewayServiceAccount(); 242 /** 243 * 244 * 245 * <pre> 246 * Immutable. The Google Cloud IAM Service Account that Gateways serving this config 247 * should use to authenticate to other services. This may either be the 248 * Service Account's email 249 * (`{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`) or its full resource 250 * name (`projects/{PROJECT}/accounts/{UNIQUE_ID}`). This is most often used 251 * when the service is a GCP resource such as a Cloud Run Service or an 252 * IAP-secured service. 253 * </pre> 254 * 255 * <code> 256 * string gateway_service_account = 14 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... } 257 * </code> 258 * 259 * @return The bytes for gatewayServiceAccount. 260 */ getGatewayServiceAccountBytes()261 com.google.protobuf.ByteString getGatewayServiceAccountBytes(); 262 263 /** 264 * 265 * 266 * <pre> 267 * Output only. The ID of the associated Service Config ( 268 * https://cloud.google.com/service-infrastructure/docs/glossary#config). 269 * </pre> 270 * 271 * <code> 272 * string service_config_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... } 273 * </code> 274 * 275 * @return The serviceConfigId. 276 */ getServiceConfigId()277 java.lang.String getServiceConfigId(); 278 /** 279 * 280 * 281 * <pre> 282 * Output only. The ID of the associated Service Config ( 283 * https://cloud.google.com/service-infrastructure/docs/glossary#config). 284 * </pre> 285 * 286 * <code> 287 * string service_config_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... } 288 * </code> 289 * 290 * @return The bytes for serviceConfigId. 291 */ getServiceConfigIdBytes()292 com.google.protobuf.ByteString getServiceConfigIdBytes(); 293 294 /** 295 * 296 * 297 * <pre> 298 * Output only. State of the API Config. 299 * </pre> 300 * 301 * <code> 302 * .google.cloud.apigateway.v1.ApiConfig.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; 303 * </code> 304 * 305 * @return The enum numeric value on the wire for state. 306 */ getStateValue()307 int getStateValue(); 308 /** 309 * 310 * 311 * <pre> 312 * Output only. State of the API Config. 313 * </pre> 314 * 315 * <code> 316 * .google.cloud.apigateway.v1.ApiConfig.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; 317 * </code> 318 * 319 * @return The state. 320 */ getState()321 com.google.cloud.apigateway.v1.ApiConfig.State getState(); 322 323 /** 324 * 325 * 326 * <pre> 327 * Optional. OpenAPI specification documents. If specified, grpc_services and 328 * managed_service_configs must not be included. 329 * </pre> 330 * 331 * <code> 332 * repeated .google.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9 [(.google.api.field_behavior) = OPTIONAL]; 333 * </code> 334 */ 335 java.util.List<com.google.cloud.apigateway.v1.ApiConfig.OpenApiDocument> getOpenapiDocumentsList()336 getOpenapiDocumentsList(); 337 /** 338 * 339 * 340 * <pre> 341 * Optional. OpenAPI specification documents. If specified, grpc_services and 342 * managed_service_configs must not be included. 343 * </pre> 344 * 345 * <code> 346 * repeated .google.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9 [(.google.api.field_behavior) = OPTIONAL]; 347 * </code> 348 */ getOpenapiDocuments(int index)349 com.google.cloud.apigateway.v1.ApiConfig.OpenApiDocument getOpenapiDocuments(int index); 350 /** 351 * 352 * 353 * <pre> 354 * Optional. OpenAPI specification documents. If specified, grpc_services and 355 * managed_service_configs must not be included. 356 * </pre> 357 * 358 * <code> 359 * repeated .google.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9 [(.google.api.field_behavior) = OPTIONAL]; 360 * </code> 361 */ getOpenapiDocumentsCount()362 int getOpenapiDocumentsCount(); 363 /** 364 * 365 * 366 * <pre> 367 * Optional. OpenAPI specification documents. If specified, grpc_services and 368 * managed_service_configs must not be included. 369 * </pre> 370 * 371 * <code> 372 * repeated .google.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9 [(.google.api.field_behavior) = OPTIONAL]; 373 * </code> 374 */ 375 java.util.List<? extends com.google.cloud.apigateway.v1.ApiConfig.OpenApiDocumentOrBuilder> getOpenapiDocumentsOrBuilderList()376 getOpenapiDocumentsOrBuilderList(); 377 /** 378 * 379 * 380 * <pre> 381 * Optional. OpenAPI specification documents. If specified, grpc_services and 382 * managed_service_configs must not be included. 383 * </pre> 384 * 385 * <code> 386 * repeated .google.cloud.apigateway.v1.ApiConfig.OpenApiDocument openapi_documents = 9 [(.google.api.field_behavior) = OPTIONAL]; 387 * </code> 388 */ getOpenapiDocumentsOrBuilder( int index)389 com.google.cloud.apigateway.v1.ApiConfig.OpenApiDocumentOrBuilder getOpenapiDocumentsOrBuilder( 390 int index); 391 392 /** 393 * 394 * 395 * <pre> 396 * Optional. gRPC service definition files. If specified, openapi_documents must 397 * not be included. 398 * </pre> 399 * 400 * <code> 401 * repeated .google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10 [(.google.api.field_behavior) = OPTIONAL]; 402 * </code> 403 */ 404 java.util.List<com.google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition> getGrpcServicesList()405 getGrpcServicesList(); 406 /** 407 * 408 * 409 * <pre> 410 * Optional. gRPC service definition files. If specified, openapi_documents must 411 * not be included. 412 * </pre> 413 * 414 * <code> 415 * repeated .google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10 [(.google.api.field_behavior) = OPTIONAL]; 416 * </code> 417 */ getGrpcServices(int index)418 com.google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition getGrpcServices(int index); 419 /** 420 * 421 * 422 * <pre> 423 * Optional. gRPC service definition files. If specified, openapi_documents must 424 * not be included. 425 * </pre> 426 * 427 * <code> 428 * repeated .google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10 [(.google.api.field_behavior) = OPTIONAL]; 429 * </code> 430 */ getGrpcServicesCount()431 int getGrpcServicesCount(); 432 /** 433 * 434 * 435 * <pre> 436 * Optional. gRPC service definition files. If specified, openapi_documents must 437 * not be included. 438 * </pre> 439 * 440 * <code> 441 * repeated .google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10 [(.google.api.field_behavior) = OPTIONAL]; 442 * </code> 443 */ 444 java.util.List<? extends com.google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinitionOrBuilder> getGrpcServicesOrBuilderList()445 getGrpcServicesOrBuilderList(); 446 /** 447 * 448 * 449 * <pre> 450 * Optional. gRPC service definition files. If specified, openapi_documents must 451 * not be included. 452 * </pre> 453 * 454 * <code> 455 * repeated .google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinition grpc_services = 10 [(.google.api.field_behavior) = OPTIONAL]; 456 * </code> 457 */ getGrpcServicesOrBuilder( int index)458 com.google.cloud.apigateway.v1.ApiConfig.GrpcServiceDefinitionOrBuilder getGrpcServicesOrBuilder( 459 int index); 460 461 /** 462 * 463 * 464 * <pre> 465 * Optional. Service Configuration files. At least one must be included when using gRPC 466 * service definitions. See 467 * https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview 468 * for the expected file contents. 469 * If multiple files are specified, the files are merged with the following 470 * rules: 471 * * All singular scalar fields are merged using "last one wins" semantics in 472 * the order of the files uploaded. 473 * * Repeated fields are concatenated. 474 * * Singular embedded messages are merged using these rules for nested 475 * fields. 476 * </pre> 477 * 478 * <code> 479 * repeated .google.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11 [(.google.api.field_behavior) = OPTIONAL]; 480 * </code> 481 */ getManagedServiceConfigsList()482 java.util.List<com.google.cloud.apigateway.v1.ApiConfig.File> getManagedServiceConfigsList(); 483 /** 484 * 485 * 486 * <pre> 487 * Optional. Service Configuration files. At least one must be included when using gRPC 488 * service definitions. See 489 * https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview 490 * for the expected file contents. 491 * If multiple files are specified, the files are merged with the following 492 * rules: 493 * * All singular scalar fields are merged using "last one wins" semantics in 494 * the order of the files uploaded. 495 * * Repeated fields are concatenated. 496 * * Singular embedded messages are merged using these rules for nested 497 * fields. 498 * </pre> 499 * 500 * <code> 501 * repeated .google.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11 [(.google.api.field_behavior) = OPTIONAL]; 502 * </code> 503 */ getManagedServiceConfigs(int index)504 com.google.cloud.apigateway.v1.ApiConfig.File getManagedServiceConfigs(int index); 505 /** 506 * 507 * 508 * <pre> 509 * Optional. Service Configuration files. At least one must be included when using gRPC 510 * service definitions. See 511 * https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview 512 * for the expected file contents. 513 * If multiple files are specified, the files are merged with the following 514 * rules: 515 * * All singular scalar fields are merged using "last one wins" semantics in 516 * the order of the files uploaded. 517 * * Repeated fields are concatenated. 518 * * Singular embedded messages are merged using these rules for nested 519 * fields. 520 * </pre> 521 * 522 * <code> 523 * repeated .google.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11 [(.google.api.field_behavior) = OPTIONAL]; 524 * </code> 525 */ getManagedServiceConfigsCount()526 int getManagedServiceConfigsCount(); 527 /** 528 * 529 * 530 * <pre> 531 * Optional. Service Configuration files. At least one must be included when using gRPC 532 * service definitions. See 533 * https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview 534 * for the expected file contents. 535 * If multiple files are specified, the files are merged with the following 536 * rules: 537 * * All singular scalar fields are merged using "last one wins" semantics in 538 * the order of the files uploaded. 539 * * Repeated fields are concatenated. 540 * * Singular embedded messages are merged using these rules for nested 541 * fields. 542 * </pre> 543 * 544 * <code> 545 * repeated .google.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11 [(.google.api.field_behavior) = OPTIONAL]; 546 * </code> 547 */ 548 java.util.List<? extends com.google.cloud.apigateway.v1.ApiConfig.FileOrBuilder> getManagedServiceConfigsOrBuilderList()549 getManagedServiceConfigsOrBuilderList(); 550 /** 551 * 552 * 553 * <pre> 554 * Optional. Service Configuration files. At least one must be included when using gRPC 555 * service definitions. See 556 * https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview 557 * for the expected file contents. 558 * If multiple files are specified, the files are merged with the following 559 * rules: 560 * * All singular scalar fields are merged using "last one wins" semantics in 561 * the order of the files uploaded. 562 * * Repeated fields are concatenated. 563 * * Singular embedded messages are merged using these rules for nested 564 * fields. 565 * </pre> 566 * 567 * <code> 568 * repeated .google.cloud.apigateway.v1.ApiConfig.File managed_service_configs = 11 [(.google.api.field_behavior) = OPTIONAL]; 569 * </code> 570 */ getManagedServiceConfigsOrBuilder( int index)571 com.google.cloud.apigateway.v1.ApiConfig.FileOrBuilder getManagedServiceConfigsOrBuilder( 572 int index); 573 } 574