1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
// This file is @generated by prost-build.
/// An API that can be served by one or more Gateways.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Api {
/// Output only. Resource name of the API.
/// Format: projects/{project}/locations/global/apis/{api}
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Created time.
#[prost(message, optional, tag = "2")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Updated time.
#[prost(message, optional, tag = "3")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. Resource labels to represent user-provided metadata.
/// Refer to cloud documentation on labels for more details.
/// <https://cloud.google.com/compute/docs/labeling-resources>
#[prost(btree_map = "string, string", tag = "4")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Optional. Display name.
#[prost(string, tag = "5")]
pub display_name: ::prost::alloc::string::String,
/// Optional. Immutable. The name of a Google Managed Service (
/// <https://cloud.google.com/service-infrastructure/docs/glossary#managed>). If
/// not specified, a new Service will automatically be created in the same
/// project as this API.
#[prost(string, tag = "7")]
pub managed_service: ::prost::alloc::string::String,
/// Output only. State of the API.
#[prost(enumeration = "api::State", tag = "12")]
pub state: i32,
}
/// Nested message and enum types in `Api`.
pub mod api {
/// All the possible API states.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// API does not have a state yet.
Unspecified = 0,
/// API is being created.
Creating = 1,
/// API is active.
Active = 2,
/// API creation failed.
Failed = 3,
/// API is being deleted.
Deleting = 4,
/// API is being updated.
Updating = 5,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Creating => "CREATING",
State::Active => "ACTIVE",
State::Failed => "FAILED",
State::Deleting => "DELETING",
State::Updating => "UPDATING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"CREATING" => Some(Self::Creating),
"ACTIVE" => Some(Self::Active),
"FAILED" => Some(Self::Failed),
"DELETING" => Some(Self::Deleting),
"UPDATING" => Some(Self::Updating),
_ => None,
}
}
}
}
/// An API Configuration is a combination of settings for both the Managed
/// Service and Gateways serving this API Config.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ApiConfig {
/// Output only. Resource name of the API Config.
/// Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Created time.
#[prost(message, optional, tag = "2")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Updated time.
#[prost(message, optional, tag = "3")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. Resource labels to represent user-provided metadata.
/// Refer to cloud documentation on labels for more details.
/// <https://cloud.google.com/compute/docs/labeling-resources>
#[prost(btree_map = "string, string", tag = "4")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Optional. Display name.
#[prost(string, tag = "5")]
pub display_name: ::prost::alloc::string::String,
/// Immutable. The Google Cloud IAM Service Account that Gateways serving this config
/// should use to authenticate to other services. This may either be the
/// Service Account's email
/// (`{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`) or its full resource
/// name (`projects/{PROJECT}/accounts/{UNIQUE_ID}`). This is most often used
/// when the service is a GCP resource such as a Cloud Run Service or an
/// IAP-secured service.
#[prost(string, tag = "14")]
pub gateway_service_account: ::prost::alloc::string::String,
/// Output only. The ID of the associated Service Config (
/// <https://cloud.google.com/service-infrastructure/docs/glossary#config>).
#[prost(string, tag = "12")]
pub service_config_id: ::prost::alloc::string::String,
/// Output only. State of the API Config.
#[prost(enumeration = "api_config::State", tag = "8")]
pub state: i32,
/// Optional. OpenAPI specification documents. If specified, grpc_services and
/// managed_service_configs must not be included.
#[prost(message, repeated, tag = "9")]
pub openapi_documents: ::prost::alloc::vec::Vec<api_config::OpenApiDocument>,
/// Optional. gRPC service definition files. If specified, openapi_documents must
/// not be included.
#[prost(message, repeated, tag = "10")]
pub grpc_services: ::prost::alloc::vec::Vec<api_config::GrpcServiceDefinition>,
/// Optional. Service Configuration files. At least one must be included when using gRPC
/// service definitions. See
/// <https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview>
/// for the expected file contents.
///
/// If multiple files are specified, the files are merged with the following
/// rules:
/// * All singular scalar fields are merged using "last one wins" semantics in
/// the order of the files uploaded.
/// * Repeated fields are concatenated.
/// * Singular embedded messages are merged using these rules for nested
/// fields.
#[prost(message, repeated, tag = "11")]
pub managed_service_configs: ::prost::alloc::vec::Vec<api_config::File>,
}
/// Nested message and enum types in `ApiConfig`.
pub mod api_config {
/// A lightweight description of a file.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct File {
/// The file path (full or relative path). This is typically the path of the
/// file when it is uploaded.
#[prost(string, tag = "1")]
pub path: ::prost::alloc::string::String,
/// The bytes that constitute the file.
#[prost(bytes = "bytes", tag = "2")]
pub contents: ::prost::bytes::Bytes,
}
/// An OpenAPI Specification Document describing an API.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OpenApiDocument {
/// The OpenAPI Specification document file.
#[prost(message, optional, tag = "1")]
pub document: ::core::option::Option<File>,
}
/// A gRPC service definition.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GrpcServiceDefinition {
/// Input only. File descriptor set, generated by protoc.
///
/// To generate, use protoc with imports and source info included.
/// For an example test.proto file, the following command would put the value
/// in a new file named out.pb.
///
/// $ protoc --include_imports --include_source_info test.proto -o out.pb
#[prost(message, optional, tag = "1")]
pub file_descriptor_set: ::core::option::Option<File>,
/// Optional. Uncompiled proto files associated with the descriptor set, used for
/// display purposes (server-side compilation is not supported). These
/// should match the inputs to 'protoc' command used to generate
/// file_descriptor_set.
#[prost(message, repeated, tag = "2")]
pub source: ::prost::alloc::vec::Vec<File>,
}
/// All the possible API Config states.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// API Config does not have a state yet.
Unspecified = 0,
/// API Config is being created and deployed to the API Controller.
Creating = 1,
/// API Config is ready for use by Gateways.
Active = 2,
/// API Config creation failed.
Failed = 3,
/// API Config is being deleted.
Deleting = 4,
/// API Config is being updated.
Updating = 5,
/// API Config settings are being activated in downstream systems.
/// API Configs in this state cannot be used by Gateways.
Activating = 6,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Creating => "CREATING",
State::Active => "ACTIVE",
State::Failed => "FAILED",
State::Deleting => "DELETING",
State::Updating => "UPDATING",
State::Activating => "ACTIVATING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"CREATING" => Some(Self::Creating),
"ACTIVE" => Some(Self::Active),
"FAILED" => Some(Self::Failed),
"DELETING" => Some(Self::Deleting),
"UPDATING" => Some(Self::Updating),
"ACTIVATING" => Some(Self::Activating),
_ => None,
}
}
}
}
/// A Gateway is an API-aware HTTP proxy. It performs API-Method and/or
/// API-Consumer specific actions based on an API Config such as authentication,
/// policy enforcement, and backend selection.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Gateway {
/// Output only. Resource name of the Gateway.
/// Format: projects/{project}/locations/{location}/gateways/{gateway}
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Output only. Created time.
#[prost(message, optional, tag = "2")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Updated time.
#[prost(message, optional, tag = "3")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// Optional. Resource labels to represent user-provided metadata.
/// Refer to cloud documentation on labels for more details.
/// <https://cloud.google.com/compute/docs/labeling-resources>
#[prost(btree_map = "string, string", tag = "4")]
pub labels: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Optional. Display name.
#[prost(string, tag = "5")]
pub display_name: ::prost::alloc::string::String,
/// Required. Resource name of the API Config for this Gateway.
/// Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
#[prost(string, tag = "6")]
pub api_config: ::prost::alloc::string::String,
/// Output only. The current state of the Gateway.
#[prost(enumeration = "gateway::State", tag = "7")]
pub state: i32,
/// Output only. The default API Gateway host name of the form
/// `{gateway_id}-{hash}.{region_code}.gateway.dev`.
#[prost(string, tag = "9")]
pub default_hostname: ::prost::alloc::string::String,
}
/// Nested message and enum types in `Gateway`.
pub mod gateway {
/// All the possible Gateway states.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Gateway does not have a state yet.
Unspecified = 0,
/// Gateway is being created.
Creating = 1,
/// Gateway is running and ready for requests.
Active = 2,
/// Gateway creation failed.
Failed = 3,
/// Gateway is being deleted.
Deleting = 4,
/// Gateway is being updated.
Updating = 5,
}
impl State {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
State::Unspecified => "STATE_UNSPECIFIED",
State::Creating => "CREATING",
State::Active => "ACTIVE",
State::Failed => "FAILED",
State::Deleting => "DELETING",
State::Updating => "UPDATING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"CREATING" => Some(Self::Creating),
"ACTIVE" => Some(Self::Active),
"FAILED" => Some(Self::Failed),
"DELETING" => Some(Self::Deleting),
"UPDATING" => Some(Self::Updating),
_ => None,
}
}
}
}
/// Request message for ApiGatewayService.ListGateways
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListGatewaysRequest {
/// Required. Parent resource of the Gateway, of the form:
/// `projects/*/locations/*`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Page size.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Page token.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// Filter.
#[prost(string, tag = "4")]
pub filter: ::prost::alloc::string::String,
/// Order by parameters.
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for ApiGatewayService.ListGateways
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListGatewaysResponse {
/// Gateways.
#[prost(message, repeated, tag = "1")]
pub gateways: ::prost::alloc::vec::Vec<Gateway>,
/// Next page token.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
/// Locations that could not be reached.
#[prost(string, repeated, tag = "3")]
pub unreachable_locations: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Request message for ApiGatewayService.GetGateway
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetGatewayRequest {
/// Required. Resource name of the form:
/// `projects/*/locations/*/gateways/*`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for ApiGatewayService.CreateGateway
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateGatewayRequest {
/// Required. Parent resource of the Gateway, of the form:
/// `projects/*/locations/*`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. Identifier to assign to the Gateway. Must be unique within scope of
/// the parent resource.
#[prost(string, tag = "2")]
pub gateway_id: ::prost::alloc::string::String,
/// Required. Gateway resource.
#[prost(message, optional, tag = "3")]
pub gateway: ::core::option::Option<Gateway>,
}
/// Request message for ApiGatewayService.UpdateGateway
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateGatewayRequest {
/// Field mask is used to specify the fields to be overwritten in the
/// Gateway resource by the update.
/// The fields specified in the update_mask are relative to the resource, not
/// the full request. A field will be overwritten if it is in the mask. If the
/// user does not provide a mask then all fields will be overwritten.
#[prost(message, optional, tag = "1")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
/// Required. Gateway resource.
#[prost(message, optional, tag = "2")]
pub gateway: ::core::option::Option<Gateway>,
}
/// Request message for ApiGatewayService.DeleteGateway
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteGatewayRequest {
/// Required. Resource name of the form:
/// `projects/*/locations/*/gateways/*`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for ApiGatewayService.ListApis
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListApisRequest {
/// Required. Parent resource of the API, of the form:
/// `projects/*/locations/global`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Page size.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Page token.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// Filter.
#[prost(string, tag = "4")]
pub filter: ::prost::alloc::string::String,
/// Order by parameters.
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for ApiGatewayService.ListApis
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListApisResponse {
/// APIs.
#[prost(message, repeated, tag = "1")]
pub apis: ::prost::alloc::vec::Vec<Api>,
/// Next page token.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
/// Locations that could not be reached.
#[prost(string, repeated, tag = "3")]
pub unreachable_locations: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Request message for ApiGatewayService.GetApi
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetApiRequest {
/// Required. Resource name of the form:
/// `projects/*/locations/global/apis/*`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for ApiGatewayService.CreateApi
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateApiRequest {
/// Required. Parent resource of the API, of the form:
/// `projects/*/locations/global`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. Identifier to assign to the API. Must be unique within scope of
/// the parent resource.
#[prost(string, tag = "2")]
pub api_id: ::prost::alloc::string::String,
/// Required. API resource.
#[prost(message, optional, tag = "3")]
pub api: ::core::option::Option<Api>,
}
/// Request message for ApiGatewayService.UpdateApi
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateApiRequest {
/// Field mask is used to specify the fields to be overwritten in the
/// Api resource by the update.
/// The fields specified in the update_mask are relative to the resource, not
/// the full request. A field will be overwritten if it is in the mask. If the
/// user does not provide a mask then all fields will be overwritten.
#[prost(message, optional, tag = "1")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
/// Required. API resource.
#[prost(message, optional, tag = "2")]
pub api: ::core::option::Option<Api>,
}
/// Request message for ApiGatewayService.DeleteApi
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteApiRequest {
/// Required. Resource name of the form:
/// `projects/*/locations/global/apis/*`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for ApiGatewayService.ListApiConfigs
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListApiConfigsRequest {
/// Required. Parent resource of the API Config, of the form:
/// `projects/*/locations/global/apis/*`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Page size.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// Page token.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
/// Filter.
#[prost(string, tag = "4")]
pub filter: ::prost::alloc::string::String,
/// Order by parameters.
#[prost(string, tag = "5")]
pub order_by: ::prost::alloc::string::String,
}
/// Response message for ApiGatewayService.ListApiConfigs
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListApiConfigsResponse {
/// API Configs.
#[prost(message, repeated, tag = "1")]
pub api_configs: ::prost::alloc::vec::Vec<ApiConfig>,
/// Next page token.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
/// Locations that could not be reached.
#[prost(string, repeated, tag = "3")]
pub unreachable_locations: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Request message for ApiGatewayService.GetApiConfig
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetApiConfigRequest {
/// Required. Resource name of the form:
/// `projects/*/locations/global/apis/*/configs/*`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Specifies which fields of the API Config are returned in the response.
/// Defaults to `BASIC` view.
#[prost(enumeration = "get_api_config_request::ConfigView", tag = "3")]
pub view: i32,
}
/// Nested message and enum types in `GetApiConfigRequest`.
pub mod get_api_config_request {
/// Enum to control which fields should be included in the response.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ConfigView {
Unspecified = 0,
/// Do not include configuration source files.
Basic = 1,
/// Include configuration source files.
Full = 2,
}
impl ConfigView {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
ConfigView::Unspecified => "CONFIG_VIEW_UNSPECIFIED",
ConfigView::Basic => "BASIC",
ConfigView::Full => "FULL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"CONFIG_VIEW_UNSPECIFIED" => Some(Self::Unspecified),
"BASIC" => Some(Self::Basic),
"FULL" => Some(Self::Full),
_ => None,
}
}
}
}
/// Request message for ApiGatewayService.CreateApiConfig
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateApiConfigRequest {
/// Required. Parent resource of the API Config, of the form:
/// `projects/*/locations/global/apis/*`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. Identifier to assign to the API Config. Must be unique within scope of
/// the parent resource.
#[prost(string, tag = "2")]
pub api_config_id: ::prost::alloc::string::String,
/// Required. API resource.
#[prost(message, optional, tag = "3")]
pub api_config: ::core::option::Option<ApiConfig>,
}
/// Request message for ApiGatewayService.UpdateApiConfig
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateApiConfigRequest {
/// Field mask is used to specify the fields to be overwritten in the
/// ApiConfig resource by the update.
/// The fields specified in the update_mask are relative to the resource, not
/// the full request. A field will be overwritten if it is in the mask. If the
/// user does not provide a mask then all fields will be overwritten.
#[prost(message, optional, tag = "1")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
/// Required. API Config resource.
#[prost(message, optional, tag = "2")]
pub api_config: ::core::option::Option<ApiConfig>,
}
/// Request message for ApiGatewayService.DeleteApiConfig
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteApiConfigRequest {
/// Required. Resource name of the form:
/// `projects/*/locations/global/apis/*/configs/*`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Represents the metadata of the long-running operation.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OperationMetadata {
/// Output only. The time the operation was created.
#[prost(message, optional, tag = "1")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The time the operation finished running.
#[prost(message, optional, tag = "2")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. Server-defined resource path for the target of the operation.
#[prost(string, tag = "3")]
pub target: ::prost::alloc::string::String,
/// Output only. Name of the verb executed by the operation.
#[prost(string, tag = "4")]
pub verb: ::prost::alloc::string::String,
/// Output only. Human-readable status of the operation, if any.
#[prost(string, tag = "5")]
pub status_message: ::prost::alloc::string::String,
/// Output only. Identifies whether the user has requested cancellation
/// of the operation. Operations that have successfully been cancelled
/// have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
/// corresponding to `Code.CANCELLED`.
#[prost(bool, tag = "6")]
pub requested_cancellation: bool,
/// Output only. API version used to start the operation.
#[prost(string, tag = "7")]
pub api_version: ::prost::alloc::string::String,
/// Output only. Diagnostics generated during processing of configuration source files.
#[prost(message, repeated, tag = "8")]
pub diagnostics: ::prost::alloc::vec::Vec<operation_metadata::Diagnostic>,
}
/// Nested message and enum types in `OperationMetadata`.
pub mod operation_metadata {
/// Diagnostic information from configuration processing.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Diagnostic {
/// Location of the diagnostic.
#[prost(string, tag = "1")]
pub location: ::prost::alloc::string::String,
/// The diagnostic message.
#[prost(string, tag = "2")]
pub message: ::prost::alloc::string::String,
}
}
/// Generated client implementations.
pub mod api_gateway_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// The API Gateway Service is the interface for managing API Gateways.
#[derive(Debug, Clone)]
pub struct ApiGatewayServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> ApiGatewayServiceClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> ApiGatewayServiceClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
>>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
{
ApiGatewayServiceClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Lists Gateways in a given project and location.
pub async fn list_gateways(
&mut self,
request: impl tonic::IntoRequest<super::ListGatewaysRequest>,
) -> std::result::Result<
tonic::Response<super::ListGatewaysResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/ListGateways",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"ListGateways",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets details of a single Gateway.
pub async fn get_gateway(
&mut self,
request: impl tonic::IntoRequest<super::GetGatewayRequest>,
) -> std::result::Result<tonic::Response<super::Gateway>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/GetGateway",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"GetGateway",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a new Gateway in a given project and location.
pub async fn create_gateway(
&mut self,
request: impl tonic::IntoRequest<super::CreateGatewayRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/CreateGateway",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"CreateGateway",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates the parameters of a single Gateway.
pub async fn update_gateway(
&mut self,
request: impl tonic::IntoRequest<super::UpdateGatewayRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/UpdateGateway",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"UpdateGateway",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a single Gateway.
pub async fn delete_gateway(
&mut self,
request: impl tonic::IntoRequest<super::DeleteGatewayRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/DeleteGateway",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"DeleteGateway",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists Apis in a given project and location.
pub async fn list_apis(
&mut self,
request: impl tonic::IntoRequest<super::ListApisRequest>,
) -> std::result::Result<
tonic::Response<super::ListApisResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/ListApis",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"ListApis",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets details of a single Api.
pub async fn get_api(
&mut self,
request: impl tonic::IntoRequest<super::GetApiRequest>,
) -> std::result::Result<tonic::Response<super::Api>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/GetApi",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"GetApi",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a new Api in a given project and location.
pub async fn create_api(
&mut self,
request: impl tonic::IntoRequest<super::CreateApiRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/CreateApi",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"CreateApi",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates the parameters of a single Api.
pub async fn update_api(
&mut self,
request: impl tonic::IntoRequest<super::UpdateApiRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/UpdateApi",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"UpdateApi",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a single Api.
pub async fn delete_api(
&mut self,
request: impl tonic::IntoRequest<super::DeleteApiRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/DeleteApi",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"DeleteApi",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists ApiConfigs in a given project and location.
pub async fn list_api_configs(
&mut self,
request: impl tonic::IntoRequest<super::ListApiConfigsRequest>,
) -> std::result::Result<
tonic::Response<super::ListApiConfigsResponse>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/ListApiConfigs",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"ListApiConfigs",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets details of a single ApiConfig.
pub async fn get_api_config(
&mut self,
request: impl tonic::IntoRequest<super::GetApiConfigRequest>,
) -> std::result::Result<tonic::Response<super::ApiConfig>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/GetApiConfig",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"GetApiConfig",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a new ApiConfig in a given project and location.
pub async fn create_api_config(
&mut self,
request: impl tonic::IntoRequest<super::CreateApiConfigRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/CreateApiConfig",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"CreateApiConfig",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates the parameters of a single ApiConfig.
pub async fn update_api_config(
&mut self,
request: impl tonic::IntoRequest<super::UpdateApiConfigRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/UpdateApiConfig",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"UpdateApiConfig",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a single ApiConfig.
pub async fn delete_api_config(
&mut self,
request: impl tonic::IntoRequest<super::DeleteApiConfigRequest>,
) -> std::result::Result<
tonic::Response<super::super::super::super::longrunning::Operation>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.cloud.apigateway.v1.ApiGatewayService/DeleteApiConfig",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.apigateway.v1.ApiGatewayService",
"DeleteApiConfig",
),
);
self.inner.unary(req, path, codec).await
}
}
}