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
// This file is @generated by prost-build.
/// Cloud Firestore indexes enable simple and complex queries against
/// documents in a database.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Index {
/// Output only. A server defined name for this index.
/// The form of this name for composite indexes will be:
/// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}`
/// For single field indexes, this field will be empty.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Indexes with a collection query scope specified allow queries
/// against a collection that is the child of a specific document, specified at
/// query time, and that has the same collection id.
///
/// Indexes with a collection group query scope specified allow queries against
/// all collections descended from a specific document, specified at query
/// time, and that have the same collection id as this index.
#[prost(enumeration = "index::QueryScope", tag = "2")]
pub query_scope: i32,
/// The fields supported by this index.
///
/// For composite indexes, this is always 2 or more fields.
/// The last field entry is always for the field path `__name__`. If, on
/// creation, `__name__` was not specified as the last field, it will be added
/// automatically with the same direction as that of the last field defined. If
/// the final field in a composite index is not directional, the `__name__`
/// will be ordered ASCENDING (unless explicitly specified).
///
/// For single field indexes, this will always be exactly one entry with a
/// field path equal to the field path of the associated field.
#[prost(message, repeated, tag = "3")]
pub fields: ::prost::alloc::vec::Vec<index::IndexField>,
/// Output only. The serving state of the index.
#[prost(enumeration = "index::State", tag = "4")]
pub state: i32,
}
/// Nested message and enum types in `Index`.
pub mod index {
/// A field in an index.
/// The field_path describes which field is indexed, the value_mode describes
/// how the field value is indexed.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IndexField {
/// Can be __name__.
/// For single field indexes, this must match the name of the field or may
/// be omitted.
#[prost(string, tag = "1")]
pub field_path: ::prost::alloc::string::String,
/// How the field value is indexed.
#[prost(oneof = "index_field::ValueMode", tags = "2, 3")]
pub value_mode: ::core::option::Option<index_field::ValueMode>,
}
/// Nested message and enum types in `IndexField`.
pub mod index_field {
/// The supported orderings.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Order {
/// The ordering is unspecified. Not a valid option.
Unspecified = 0,
/// The field is ordered by ascending field value.
Ascending = 1,
/// The field is ordered by descending field value.
Descending = 2,
}
impl Order {
/// 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 {
Order::Unspecified => "ORDER_UNSPECIFIED",
Order::Ascending => "ASCENDING",
Order::Descending => "DESCENDING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ORDER_UNSPECIFIED" => Some(Self::Unspecified),
"ASCENDING" => Some(Self::Ascending),
"DESCENDING" => Some(Self::Descending),
_ => None,
}
}
}
/// The supported array value configurations.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ArrayConfig {
/// The index does not support additional array queries.
Unspecified = 0,
/// The index supports array containment queries.
Contains = 1,
}
impl ArrayConfig {
/// 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 {
ArrayConfig::Unspecified => "ARRAY_CONFIG_UNSPECIFIED",
ArrayConfig::Contains => "CONTAINS",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ARRAY_CONFIG_UNSPECIFIED" => Some(Self::Unspecified),
"CONTAINS" => Some(Self::Contains),
_ => None,
}
}
}
/// How the field value is indexed.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ValueMode {
/// Indicates that this field supports ordering by the specified order or
/// comparing using =, <, <=, >, >=.
#[prost(enumeration = "Order", tag = "2")]
Order(i32),
/// Indicates that this field supports operations on `array_value`s.
#[prost(enumeration = "ArrayConfig", tag = "3")]
ArrayConfig(i32),
}
}
/// Query Scope defines the scope at which a query is run. This is specified on
/// a StructuredQuery's `from` field.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum QueryScope {
/// The query scope is unspecified. Not a valid option.
Unspecified = 0,
/// Indexes with a collection query scope specified allow queries
/// against a collection that is the child of a specific document, specified
/// at query time, and that has the collection id specified by the index.
Collection = 1,
/// Indexes with a collection group query scope specified allow queries
/// against all collections that has the collection id specified by the
/// index.
CollectionGroup = 2,
}
impl QueryScope {
/// 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 {
QueryScope::Unspecified => "QUERY_SCOPE_UNSPECIFIED",
QueryScope::Collection => "COLLECTION",
QueryScope::CollectionGroup => "COLLECTION_GROUP",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"QUERY_SCOPE_UNSPECIFIED" => Some(Self::Unspecified),
"COLLECTION" => Some(Self::Collection),
"COLLECTION_GROUP" => Some(Self::CollectionGroup),
_ => None,
}
}
}
/// The state of an index. During index creation, an index will be in the
/// `CREATING` state. If the index is created successfully, it will transition
/// to the `READY` state. If the index creation encounters a problem, the index
/// will transition to the `NEEDS_REPAIR` state.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// The state is unspecified.
Unspecified = 0,
/// The index is being created.
/// There is an active long-running operation for the index.
/// The index is updated when writing a document.
/// Some index data may exist.
Creating = 1,
/// The index is ready to be used.
/// The index is updated when writing a document.
/// The index is fully populated from all stored documents it applies to.
Ready = 2,
/// The index was being created, but something went wrong.
/// There is no active long-running operation for the index,
/// and the most recently finished long-running operation failed.
/// The index is not updated when writing a document.
/// Some index data may exist.
/// Use the google.longrunning.Operations API to determine why the operation
/// that last attempted to create this index failed, then re-create the
/// index.
NeedsRepair = 3,
}
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::Ready => "READY",
State::NeedsRepair => "NEEDS_REPAIR",
}
}
/// 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),
"READY" => Some(Self::Ready),
"NEEDS_REPAIR" => Some(Self::NeedsRepair),
_ => None,
}
}
}
}
/// Represents a single field in the database.
///
/// Fields are grouped by their "Collection Group", which represent all
/// collections in the database with the same id.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Field {
/// A field name of the form
/// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
///
/// A field path may be a simple field name, e.g. `address` or a path to fields
/// within map_value , e.g. `address.city`,
/// or a special field path. The only valid special field is `*`, which
/// represents any field.
///
/// Field paths may be quoted using ` (backtick). The only character that needs
/// to be escaped within a quoted field path is the backtick character itself,
/// escaped using a backslash. Special characters in field paths that
/// must be quoted include: `*`, `.`,
/// ``` (backtick), `\[`, `\]`, as well as any ascii symbolic characters.
///
/// Examples:
/// (Note: Comments here are written in markdown syntax, so there is an
/// additional layer of backticks to represent a code block)
/// `\`address.city\`` represents a field named `address.city`, not the map key
/// `city` in the field `address`.
/// `\`*\`` represents a field named `*`, not any field.
///
/// A special `Field` contains the default indexing settings for all fields.
/// This field's resource name is:
/// `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`
/// Indexes defined on this `Field` will be applied to all fields which do not
/// have their own `Field` index configuration.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The index configuration for this field. If unset, field indexing will
/// revert to the configuration defined by the `ancestor_field`. To
/// explicitly remove all indexes for this field, specify an index config
/// with an empty list of indexes.
#[prost(message, optional, tag = "2")]
pub index_config: ::core::option::Option<field::IndexConfig>,
}
/// Nested message and enum types in `Field`.
pub mod field {
/// The index configuration for this field.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IndexConfig {
/// The indexes supported for this field.
#[prost(message, repeated, tag = "1")]
pub indexes: ::prost::alloc::vec::Vec<super::Index>,
/// Output only. When true, the `Field`'s index configuration is set from the
/// configuration specified by the `ancestor_field`.
/// When false, the `Field`'s index configuration is defined explicitly.
#[prost(bool, tag = "2")]
pub uses_ancestor_config: bool,
/// Output only. Specifies the resource name of the `Field` from which this field's
/// index configuration is set (when `uses_ancestor_config` is true),
/// or from which it *would* be set if this field had no index configuration
/// (when `uses_ancestor_config` is false).
#[prost(string, tag = "3")]
pub ancestor_field: ::prost::alloc::string::String,
/// Output only
/// When true, the `Field`'s index configuration is in the process of being
/// reverted. Once complete, the index config will transition to the same
/// state as the field specified by `ancestor_field`, at which point
/// `uses_ancestor_config` will be `true` and `reverting` will be `false`.
#[prost(bool, tag = "4")]
pub reverting: bool,
}
}
/// The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateIndexRequest {
/// A parent name of the form
/// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The composite index to create.
#[prost(message, optional, tag = "2")]
pub index: ::core::option::Option<Index>,
}
/// The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListIndexesRequest {
/// A parent name of the form
/// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The filter to apply to list results.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The number of results to return.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A page token, returned from a previous call to
/// [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes], that may be used to get the next
/// page of results.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
}
/// The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1beta2.FirestoreAdmin.ListIndexes].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListIndexesResponse {
/// The requested indexes.
#[prost(message, repeated, tag = "1")]
pub indexes: ::prost::alloc::vec::Vec<Index>,
/// A page token that may be used to request another page of results. If blank,
/// this is the last page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1beta2.FirestoreAdmin.GetIndex].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetIndexRequest {
/// A name of the form
/// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1beta2.FirestoreAdmin.DeleteIndex].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteIndexRequest {
/// A name of the form
/// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// The request for [FirestoreAdmin.UpdateField][google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateFieldRequest {
/// The field to be updated.
#[prost(message, optional, tag = "1")]
pub field: ::core::option::Option<Field>,
/// A mask, relative to the field. If specified, only configuration specified
/// by this field_mask will be updated in the field.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// The request for [FirestoreAdmin.GetField][google.firestore.admin.v1beta2.FirestoreAdmin.GetField].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetFieldRequest {
/// A name of the form
/// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// The request for [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFieldsRequest {
/// A parent name of the form
/// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The filter to apply to list results. Currently,
/// [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields] only supports listing fields
/// that have been explicitly overridden. To issue this query, call
/// [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields] with the filter set to
/// `indexConfig.usesAncestorConfig:false`.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// The number of results to return.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A page token, returned from a previous call to
/// [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields], that may be used to get the next
/// page of results.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
}
/// The response for [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListFieldsResponse {
/// The requested fields.
#[prost(message, repeated, tag = "1")]
pub fields: ::prost::alloc::vec::Vec<Field>,
/// A page token that may be used to request another page of results. If blank,
/// this is the last page.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportDocumentsRequest {
/// Database to export. Should be of the form:
/// `projects/{project_id}/databases/{database_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Which collection ids to export. Unspecified means all collections.
#[prost(string, repeated, tag = "2")]
pub collection_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The output URI. Currently only supports Google Cloud Storage URIs of the
/// form: `gs://BUCKET_NAME\[/NAMESPACE_PATH\]`, where `BUCKET_NAME` is the name
/// of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional
/// Google Cloud Storage namespace path. When
/// choosing a name, be sure to consider Google Cloud Storage naming
/// guidelines: <https://cloud.google.com/storage/docs/naming.>
/// If the URI is a bucket (without a namespace path), a prefix will be
/// generated based on the start time.
#[prost(string, tag = "3")]
pub output_uri_prefix: ::prost::alloc::string::String,
}
/// The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ImportDocumentsRequest {
/// Database to import into. Should be of the form:
/// `projects/{project_id}/databases/{database_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Which collection ids to import. Unspecified means all collections included
/// in the import.
#[prost(string, repeated, tag = "2")]
pub collection_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Location of the exported files.
/// This must match the output_uri_prefix of an ExportDocumentsResponse from
/// an export that has completed successfully.
/// See:
/// [google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix][google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix].
#[prost(string, tag = "3")]
pub input_uri_prefix: ::prost::alloc::string::String,
}
/// Generated client implementations.
pub mod firestore_admin_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Operations are created by service `FirestoreAdmin`, but are accessed via
/// service `google.longrunning.Operations`.
#[derive(Debug, Clone)]
pub struct FirestoreAdminClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> FirestoreAdminClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + 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,
) -> FirestoreAdminClient<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> + Send + Sync,
{
FirestoreAdminClient::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
}
/// Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation]
/// which may be used to track the status of the creation. The metadata for
/// the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1beta2.IndexOperationMetadata].
pub async fn create_index(
&mut self,
request: impl tonic::IntoRequest<super::CreateIndexRequest>,
) -> 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.firestore.admin.v1beta2.FirestoreAdmin/CreateIndex",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.firestore.admin.v1beta2.FirestoreAdmin",
"CreateIndex",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists composite indexes.
pub async fn list_indexes(
&mut self,
request: impl tonic::IntoRequest<super::ListIndexesRequest>,
) -> std::result::Result<
tonic::Response<super::ListIndexesResponse>,
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.firestore.admin.v1beta2.FirestoreAdmin/ListIndexes",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.firestore.admin.v1beta2.FirestoreAdmin",
"ListIndexes",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a composite index.
pub async fn get_index(
&mut self,
request: impl tonic::IntoRequest<super::GetIndexRequest>,
) -> std::result::Result<tonic::Response<super::Index>, 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.firestore.admin.v1beta2.FirestoreAdmin/GetIndex",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.firestore.admin.v1beta2.FirestoreAdmin",
"GetIndex",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a composite index.
pub async fn delete_index(
&mut self,
request: impl tonic::IntoRequest<super::DeleteIndexRequest>,
) -> std::result::Result<tonic::Response<()>, 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.firestore.admin.v1beta2.FirestoreAdmin/DeleteIndex",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.firestore.admin.v1beta2.FirestoreAdmin",
"DeleteIndex",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets the metadata and configuration for a Field.
pub async fn get_field(
&mut self,
request: impl tonic::IntoRequest<super::GetFieldRequest>,
) -> std::result::Result<tonic::Response<super::Field>, 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.firestore.admin.v1beta2.FirestoreAdmin/GetField",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.firestore.admin.v1beta2.FirestoreAdmin",
"GetField",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a field configuration. Currently, field updates apply only to
/// single field index configuration. However, calls to
/// [FirestoreAdmin.UpdateField][google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField] should provide a field mask to avoid
/// changing any configuration that the caller isn't aware of. The field mask
/// should be specified as: `{ paths: "index_config" }`.
///
/// This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to
/// track the status of the field update. The metadata for
/// the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1beta2.FieldOperationMetadata].
///
/// To configure the default field settings for the database, use
/// the special `Field` with resource name:
/// `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.
pub async fn update_field(
&mut self,
request: impl tonic::IntoRequest<super::UpdateFieldRequest>,
) -> 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.firestore.admin.v1beta2.FirestoreAdmin/UpdateField",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.firestore.admin.v1beta2.FirestoreAdmin",
"UpdateField",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists the field configuration and metadata for this database.
///
/// Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields] only supports listing fields
/// that have been explicitly overridden. To issue this query, call
/// [FirestoreAdmin.ListFields][google.firestore.admin.v1beta2.FirestoreAdmin.ListFields] with the filter set to
/// `indexConfig.usesAncestorConfig:false`.
pub async fn list_fields(
&mut self,
request: impl tonic::IntoRequest<super::ListFieldsRequest>,
) -> std::result::Result<
tonic::Response<super::ListFieldsResponse>,
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.firestore.admin.v1beta2.FirestoreAdmin/ListFields",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.firestore.admin.v1beta2.FirestoreAdmin",
"ListFields",
),
);
self.inner.unary(req, path, codec).await
}
/// Exports a copy of all or a subset of documents from Google Cloud Firestore
/// to another storage system, such as Google Cloud Storage. Recent updates to
/// documents may not be reflected in the export. The export occurs in the
/// background and its progress can be monitored and managed via the
/// Operation resource that is created. The output of an export may only be
/// used once the associated operation is done. If an export operation is
/// cancelled before completion it may leave partial data behind in Google
/// Cloud Storage.
pub async fn export_documents(
&mut self,
request: impl tonic::IntoRequest<super::ExportDocumentsRequest>,
) -> 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.firestore.admin.v1beta2.FirestoreAdmin/ExportDocuments",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.firestore.admin.v1beta2.FirestoreAdmin",
"ExportDocuments",
),
);
self.inner.unary(req, path, codec).await
}
/// Imports documents into Google Cloud Firestore. Existing documents with the
/// same name are overwritten. The import occurs in the background and its
/// progress can be monitored and managed via the Operation resource that is
/// created. If an ImportDocuments operation is cancelled, it is possible
/// that a subset of the data has already been imported to Cloud Firestore.
pub async fn import_documents(
&mut self,
request: impl tonic::IntoRequest<super::ImportDocumentsRequest>,
) -> 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.firestore.admin.v1beta2.FirestoreAdmin/ImportDocuments",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.firestore.admin.v1beta2.FirestoreAdmin",
"ImportDocuments",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from
/// [FirestoreAdmin.CreateIndex][google.firestore.admin.v1beta2.FirestoreAdmin.CreateIndex].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IndexOperationMetadata {
/// The time this operation started.
#[prost(message, optional, tag = "1")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time this operation completed. Will be unset if operation still in
/// progress.
#[prost(message, optional, tag = "2")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// The index resource that this operation is acting on. For example:
/// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
#[prost(string, tag = "3")]
pub index: ::prost::alloc::string::String,
/// The state of the operation.
#[prost(enumeration = "OperationState", tag = "4")]
pub state: i32,
/// The progress, in documents, of this operation.
#[prost(message, optional, tag = "5")]
pub progress_documents: ::core::option::Option<Progress>,
/// The progress, in bytes, of this operation.
#[prost(message, optional, tag = "6")]
pub progress_bytes: ::core::option::Option<Progress>,
}
/// Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from
/// [FirestoreAdmin.UpdateField][google.firestore.admin.v1beta2.FirestoreAdmin.UpdateField].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FieldOperationMetadata {
/// The time this operation started.
#[prost(message, optional, tag = "1")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time this operation completed. Will be unset if operation still in
/// progress.
#[prost(message, optional, tag = "2")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// The field resource that this operation is acting on. For example:
/// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
#[prost(string, tag = "3")]
pub field: ::prost::alloc::string::String,
/// A list of [IndexConfigDelta][google.firestore.admin.v1beta2.FieldOperationMetadata.IndexConfigDelta], which describe the intent of this
/// operation.
#[prost(message, repeated, tag = "4")]
pub index_config_deltas: ::prost::alloc::vec::Vec<
field_operation_metadata::IndexConfigDelta,
>,
/// The state of the operation.
#[prost(enumeration = "OperationState", tag = "5")]
pub state: i32,
/// The progress, in documents, of this operation.
#[prost(message, optional, tag = "6")]
pub document_progress: ::core::option::Option<Progress>,
/// The progress, in bytes, of this operation.
#[prost(message, optional, tag = "7")]
pub bytes_progress: ::core::option::Option<Progress>,
}
/// Nested message and enum types in `FieldOperationMetadata`.
pub mod field_operation_metadata {
/// Information about an index configuration change.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct IndexConfigDelta {
/// Specifies how the index is changing.
#[prost(enumeration = "index_config_delta::ChangeType", tag = "1")]
pub change_type: i32,
/// The index being changed.
#[prost(message, optional, tag = "2")]
pub index: ::core::option::Option<super::Index>,
}
/// Nested message and enum types in `IndexConfigDelta`.
pub mod index_config_delta {
/// Specifies how the index is changing.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ChangeType {
/// The type of change is not specified or known.
Unspecified = 0,
/// The single field index is being added.
Add = 1,
/// The single field index is being removed.
Remove = 2,
}
impl ChangeType {
/// 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 {
ChangeType::Unspecified => "CHANGE_TYPE_UNSPECIFIED",
ChangeType::Add => "ADD",
ChangeType::Remove => "REMOVE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"CHANGE_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"ADD" => Some(Self::Add),
"REMOVE" => Some(Self::Remove),
_ => None,
}
}
}
}
}
/// Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from
/// [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ExportDocuments].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportDocumentsMetadata {
/// The time this operation started.
#[prost(message, optional, tag = "1")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time this operation completed. Will be unset if operation still in
/// progress.
#[prost(message, optional, tag = "2")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// The state of the export operation.
#[prost(enumeration = "OperationState", tag = "3")]
pub operation_state: i32,
/// The progress, in documents, of this operation.
#[prost(message, optional, tag = "4")]
pub progress_documents: ::core::option::Option<Progress>,
/// The progress, in bytes, of this operation.
#[prost(message, optional, tag = "5")]
pub progress_bytes: ::core::option::Option<Progress>,
/// Which collection ids are being exported.
#[prost(string, repeated, tag = "6")]
pub collection_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Where the entities are being exported to.
#[prost(string, tag = "7")]
pub output_uri_prefix: ::prost::alloc::string::String,
}
/// Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from
/// [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1beta2.FirestoreAdmin.ImportDocuments].
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ImportDocumentsMetadata {
/// The time this operation started.
#[prost(message, optional, tag = "1")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time this operation completed. Will be unset if operation still in
/// progress.
#[prost(message, optional, tag = "2")]
pub end_time: ::core::option::Option<::prost_types::Timestamp>,
/// The state of the import operation.
#[prost(enumeration = "OperationState", tag = "3")]
pub operation_state: i32,
/// The progress, in documents, of this operation.
#[prost(message, optional, tag = "4")]
pub progress_documents: ::core::option::Option<Progress>,
/// The progress, in bytes, of this operation.
#[prost(message, optional, tag = "5")]
pub progress_bytes: ::core::option::Option<Progress>,
/// Which collection ids are being imported.
#[prost(string, repeated, tag = "6")]
pub collection_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The location of the documents being imported.
#[prost(string, tag = "7")]
pub input_uri_prefix: ::prost::alloc::string::String,
}
/// Returned in the [google.longrunning.Operation][google.longrunning.Operation] response field.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExportDocumentsResponse {
/// Location of the output files. This can be used to begin an import
/// into Cloud Firestore (this project or another project) after the operation
/// completes successfully.
#[prost(string, tag = "1")]
pub output_uri_prefix: ::prost::alloc::string::String,
}
/// Describes the progress of the operation.
/// Unit of work is generic and must be interpreted based on where [Progress][google.firestore.admin.v1beta2.Progress]
/// is used.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Progress {
/// The amount of work estimated.
#[prost(int64, tag = "1")]
pub estimated_work: i64,
/// The amount of work completed.
#[prost(int64, tag = "2")]
pub completed_work: i64,
}
/// Describes the state of the operation.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum OperationState {
/// Unspecified.
Unspecified = 0,
/// Request is being prepared for processing.
Initializing = 1,
/// Request is actively being processed.
Processing = 2,
/// Request is in the process of being cancelled after user called
/// google.longrunning.Operations.CancelOperation on the operation.
Cancelling = 3,
/// Request has been processed and is in its finalization stage.
Finalizing = 4,
/// Request has completed successfully.
Successful = 5,
/// Request has finished being processed, but encountered an error.
Failed = 6,
/// Request has finished being cancelled after user called
/// google.longrunning.Operations.CancelOperation.
Cancelled = 7,
}
impl OperationState {
/// 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 {
OperationState::Unspecified => "OPERATION_STATE_UNSPECIFIED",
OperationState::Initializing => "INITIALIZING",
OperationState::Processing => "PROCESSING",
OperationState::Cancelling => "CANCELLING",
OperationState::Finalizing => "FINALIZING",
OperationState::Successful => "SUCCESSFUL",
OperationState::Failed => "FAILED",
OperationState::Cancelled => "CANCELLED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OPERATION_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"INITIALIZING" => Some(Self::Initializing),
"PROCESSING" => Some(Self::Processing),
"CANCELLING" => Some(Self::Cancelling),
"FINALIZING" => Some(Self::Finalizing),
"SUCCESSFUL" => Some(Self::Successful),
"FAILED" => Some(Self::Failed),
"CANCELLED" => Some(Self::Cancelled),
_ => None,
}
}
}