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 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module FirebaseV1beta1
# All fields are required.
class AddFirebaseRequest
include Google::Apis::Core::Hashable
# Deprecated. Instead, to set your project's default GCP resource location,
# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)
# after you add Firebase resources to your project.
# <br>
# <br>The ID of the project's default GCP resource location. The location
# must be one of the available
# [GCP resource
# locations](https://firebase.google.com/docs/projects/locations).
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
# Deprecated. Instead, to link your Project with a Google Analytics account,
# call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics)
# after you add Firebase resources to your Project.
# <br>
# <br>The region code (CLDR) that the account will use for Firebase Analytics
# data.
# <br>For example: US, GB, or DE
# <br>
# <br>In Java, use `com.google.i18n.identifiers.RegionCode`.
# Corresponds to the JSON property `regionCode`
# @return [String]
attr_accessor :region_code
# Deprecated. Instead, to link your Project with a Google Analytics account,
# call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics)
# after you add Firebase resources to your Project.
# <br>
# <br>The time zone that the account will use for Firebase Analytics data.
# <br>For example: America/Los_Angeles or Africa/Abidjan
# Corresponds to the JSON property `timeZone`
# @return [String]
attr_accessor :time_zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@location_id = args[:location_id] if args.key?(:location_id)
@region_code = args[:region_code] if args.key?(:region_code)
@time_zone = args[:time_zone] if args.key?(:time_zone)
end
end
#
class AddGoogleAnalyticsRequest
include Google::Apis::Core::Hashable
# The ID for the existing
# [Google Analytics account](http://www.google.com/analytics/) that you
# want to link with your `FirebaseProject`.
# <br>
# <br>Specifying this field will provision a new Google Analytics
# property in your Google Analytics account and associate the new property
# with your `FirebaseProject`.
# Corresponds to the JSON property `analyticsAccountId`
# @return [String]
attr_accessor :analytics_account_id
# The ID for the existing Google Analytics property that you want to
# associate with your `FirebaseProject`.
# Corresponds to the JSON property `analyticsPropertyId`
# @return [String]
attr_accessor :analytics_property_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@analytics_account_id = args[:analytics_account_id] if args.key?(:analytics_account_id)
@analytics_property_id = args[:analytics_property_id] if args.key?(:analytics_property_id)
end
end
#
class AdminSdkConfig
include Google::Apis::Core::Hashable
# The default Firebase Realtime Database URL.
# Corresponds to the JSON property `databaseURL`
# @return [String]
attr_accessor :database_url
# The ID of the project's default GCP resource location. The location is one
# of the available
# [GCP resource
# locations](https://firebase.google.com/docs/projects/locations). <br>
# <br>This field is omitted if the default GCP resource location has not been
# finalized yet. To set your project's default GCP resource location,
# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)
# after you add Firebase services to your project.
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
# Immutable. The globally unique, user-assigned project ID of the parent
# Project.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
# The default Cloud Storage for Firebase storage bucket name.
# Corresponds to the JSON property `storageBucket`
# @return [String]
attr_accessor :storage_bucket
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@database_url = args[:database_url] if args.key?(:database_url)
@location_id = args[:location_id] if args.key?(:location_id)
@project_id = args[:project_id] if args.key?(:project_id)
@storage_bucket = args[:storage_bucket] if args.key?(:storage_bucket)
end
end
#
class AnalyticsDetails
include Google::Apis::Core::Hashable
# Details of a Google Analytics property
# Corresponds to the JSON property `analyticsProperty`
# @return [Google::Apis::FirebaseV1beta1::AnalyticsProperty]
attr_accessor :analytics_property
# For Android Apps and iOS Apps: A map of `app` to `streamId` for each
# Firebase App in the specified `FirebaseProject`. Each `app` and
# `streamId` appears only once.<br>
# <br>
# For Web Apps: A map of `app` to `streamId` and `measurementId` for each
# Firebase App in the specified `FirebaseProject`. Each `app`, `streamId`,
# and `measurementId` appears only once.
# Corresponds to the JSON property `streamMappings`
# @return [Array<Google::Apis::FirebaseV1beta1::StreamMapping>]
attr_accessor :stream_mappings
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@analytics_property = args[:analytics_property] if args.key?(:analytics_property)
@stream_mappings = args[:stream_mappings] if args.key?(:stream_mappings)
end
end
# Details of a Google Analytics property
class AnalyticsProperty
include Google::Apis::Core::Hashable
# The display name of the Google Analytics property associated with the
# specified `FirebaseProject`.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The globally unique, Google-assigned identifier of the Google Analytics
# property associated with the specified `FirebaseProject`.
# <br>
# <br>If you called
# [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) to link
# your `FirebaseProject` with a Google Analytics account, the value in this
# `id` field is the same as the ID of the property either specified or
# provisioned with that call to `AddGoogleAnalytics`.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] if args.key?(:display_name)
@id = args[:id] if args.key?(:id)
end
end
# Details of a Firebase App for Android.
class AndroidApp
include Google::Apis::Core::Hashable
# Immutable. The globally unique, Firebase-assigned identifier of the App.
# <br>
# <br>This identifier should be treated as an opaque token, as the data
# format is not specified.
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
# The user-assigned display name of the App.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The fully qualified resource name of the App, in the format:
# <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code>
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The canonical package name of the Android App as would appear in the
# Google Play Developer Console.
# Corresponds to the JSON property `packageName`
# @return [String]
attr_accessor :package_name
# The globally unique, user-assigned ID of the parent Project for the App.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@app_id = args[:app_id] if args.key?(:app_id)
@display_name = args[:display_name] if args.key?(:display_name)
@name = args[:name] if args.key?(:name)
@package_name = args[:package_name] if args.key?(:package_name)
@project_id = args[:project_id] if args.key?(:project_id)
end
end
# Configuration metadata of a single Firebase App for Android.
class AndroidAppConfig
include Google::Apis::Core::Hashable
# The contents of the JSON configuration file.
# Corresponds to the JSON property `configFileContents`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :config_file_contents
# The filename that the configuration artifact is typically saved as.
# <br>For example: `google-services.json`
# Corresponds to the JSON property `configFilename`
# @return [String]
attr_accessor :config_filename
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@config_file_contents = args[:config_file_contents] if args.key?(:config_file_contents)
@config_filename = args[:config_filename] if args.key?(:config_filename)
end
end
# The default resources associated with a `FirebaseProject`.
class DefaultResources
include Google::Apis::Core::Hashable
# The default Firebase Hosting site name, in the format:
# <br><code><var>projectId</var></code>
# <br>Though rare, your `projectId` might already be used as the name for an
# existing Hosting site in another project (learn more about creating
# non-default,
# [additional sites](https://firebase.google.com/docs/hosting/multisites)).
# In these cases, your `projectId` is appended with a hyphen then five
# alphanumeric characters to create your default Hosting site name. For
# example, if your `projectId` is `myproject123`, your default Hosting site
# name might be:
# <br><code>myproject123-a5c16</code>
# Corresponds to the JSON property `hostingSite`
# @return [String]
attr_accessor :hosting_site
# The ID of the project's default GCP resource location. The location is one
# of the available
# [GCP resource
# locations](https://firebase.google.com/docs/projects/locations). <br>
# <br>This field is omitted if the default GCP resource location has not been
# finalized yet. To set your project's default GCP resource location,
# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)
# after you add Firebase services to your project.
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
# The default Firebase Realtime Database instance name, in the format:
# <br><code><var>projectId</var></code>
# <br>Though rare, your `projectId` might already be used as the name for an
# existing Realtime Database instance in another project (learn more about
# [database
# sharding](https://firebase.google.com/docs/database/usage/sharding)). In
# these cases, your `projectId` is appended with a hyphen then five
# alphanumeric characters to create your default Realtime Database instance
# name. For example, if your `projectId` is `myproject123`, your default
# database instance name might be:
# <br><code>myproject123-a5c16</code>
# Corresponds to the JSON property `realtimeDatabaseInstance`
# @return [String]
attr_accessor :realtime_database_instance
# The default Cloud Storage for Firebase storage bucket, in the format:
# <br><code><var>projectId</var>.appspot.com</code>
# Corresponds to the JSON property `storageBucket`
# @return [String]
attr_accessor :storage_bucket
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@hosting_site = args[:hosting_site] if args.key?(:hosting_site)
@location_id = args[:location_id] if args.key?(:location_id)
@realtime_database_instance = args[:realtime_database_instance] if args.key?(:realtime_database_instance)
@storage_bucket = args[:storage_bucket] if args.key?(:storage_bucket)
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
#
class FinalizeDefaultLocationRequest
include Google::Apis::Core::Hashable
# The ID of the default GCP resource location for the Project. The location
# must be one of the available
# [GCP resource
# locations](https://firebase.google.com/docs/projects/locations).
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@location_id = args[:location_id] if args.key?(:location_id)
end
end
# A high-level summary of an App.
class FirebaseAppInfo
include Google::Apis::Core::Hashable
# Immutable. The globally unique, Firebase-assigned identifier of the App.
# <br>
# <br>This identifier should be treated as an opaque token, as the data
# format is not specified.
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
# The user-assigned display name of the Firebase App.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The fully qualified resource name of the Firebase App, in the format:
# <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code>
# or <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var>
# </code>
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The platform of the Firebase App.
# Corresponds to the JSON property `platform`
# @return [String]
attr_accessor :platform
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@app_id = args[:app_id] if args.key?(:app_id)
@display_name = args[:display_name] if args.key?(:display_name)
@name = args[:name] if args.key?(:name)
@platform = args[:platform] if args.key?(:platform)
end
end
# A `FirebaseProject` is the top-level Firebase entity. It is the container for
# Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime
# Database, Cloud Firestore, Cloud Storage buckets) and other Firebase and
# Google Cloud Platform (GCP) resources.
# <br>
# <br>You can create a new `FirebaseProject` in the
# [Firebase console](https://console.firebase.google.com/),
# or you can add Firebase resources to an existing
# [GCP
# `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/
# projects)
# by calling
# AddFirebase.
# <br>
# <br>A `FirebaseProject` is actually also a GCP `Project`, so a
# `FirebaseProject` uses underlying GCP identifiers (most importantly,
# `projectId`) as its own for easy interop with GCP APIs.
class FirebaseProject
include Google::Apis::Core::Hashable
# The user-assigned display name of the Project.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The fully qualified resource name of the Project, in the format:
# <br><code>projects/<var>projectId</var></code>
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Immutable. The globally unique, user-assigned ID of the Project.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
# The globally unique, Google-assigned identifier of the Project.
# Corresponds to the JSON property `projectNumber`
# @return [Fixnum]
attr_accessor :project_number
# The default resources associated with a `FirebaseProject`.
# Corresponds to the JSON property `resources`
# @return [Google::Apis::FirebaseV1beta1::DefaultResources]
attr_accessor :resources
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] if args.key?(:display_name)
@name = args[:name] if args.key?(:name)
@project_id = args[:project_id] if args.key?(:project_id)
@project_number = args[:project_number] if args.key?(:project_number)
@resources = args[:resources] if args.key?(:resources)
end
end
# Details of a Firebase App for iOS.
class IosApp
include Google::Apis::Core::Hashable
# Immutable. The globally unique, Firebase-assigned identifier of the App.
# <br>
# <br>This identifier should be treated as an opaque token, as the data
# format is not specified.
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
# The automatically generated Apple ID assigned to the App by Apple in the
# iOS App Store.
# Corresponds to the JSON property `appStoreId`
# @return [String]
attr_accessor :app_store_id
# The canonical bundle ID of the iOS App as it would appear in the iOS
# AppStore.
# Corresponds to the JSON property `bundleId`
# @return [String]
attr_accessor :bundle_id
# The user-assigned display name of the App.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The fully qualified resource name of the App, in the format:
# <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code>
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The globally unique, user-assigned ID of the parent Project for the App.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@app_id = args[:app_id] if args.key?(:app_id)
@app_store_id = args[:app_store_id] if args.key?(:app_store_id)
@bundle_id = args[:bundle_id] if args.key?(:bundle_id)
@display_name = args[:display_name] if args.key?(:display_name)
@name = args[:name] if args.key?(:name)
@project_id = args[:project_id] if args.key?(:project_id)
end
end
# Configuration metadata of a single Firebase App for iOS.
class IosAppConfig
include Google::Apis::Core::Hashable
# The content of the XML configuration file.
# Corresponds to the JSON property `configFileContents`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :config_file_contents
# The filename that the configuration artifact is typically saved as.
# <br>For example: `GoogleService-Info.plist`
# Corresponds to the JSON property `configFilename`
# @return [String]
attr_accessor :config_filename
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@config_file_contents = args[:config_file_contents] if args.key?(:config_file_contents)
@config_filename = args[:config_filename] if args.key?(:config_filename)
end
end
#
class ListAndroidAppsResponse
include Google::Apis::Core::Hashable
# List of each AndroidApp that is in the parent Firebase Project.
# Corresponds to the JSON property `apps`
# @return [Array<Google::Apis::FirebaseV1beta1::AndroidApp>]
attr_accessor :apps
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
# <br>
# <br>This token can be used in a subsequent call to `ListAndroidApps` to
# find the next group of Apps.
# <br>
# <br>Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@apps = args[:apps] if args.key?(:apps)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
#
class ListAvailableLocationsResponse
include Google::Apis::Core::Hashable
# One page of results from a call to `ListAvailableLocations`.
# Corresponds to the JSON property `locations`
# @return [Array<Google::Apis::FirebaseV1beta1::Location>]
attr_accessor :locations
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results and all available locations have been listed.
# <br>
# <br>This token can be used in a subsequent call to
# `ListAvailableLocations` to find more locations.
# <br>
# <br>Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@locations = args[:locations] if args.key?(:locations)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
#
class ListAvailableProjectsResponse
include Google::Apis::Core::Hashable
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
# <br>
# <br>This token can be used in a subsequent calls to `ListAvailableProjects`
# to find the next group of GCP `Projects`.
# <br>
# <br>Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The list of GCP `Projects` which can have Firebase resources added to them.
# Corresponds to the JSON property `projectInfo`
# @return [Array<Google::Apis::FirebaseV1beta1::ProjectInfo>]
attr_accessor :project_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@project_info = args[:project_info] if args.key?(:project_info)
end
end
#
class ListFirebaseProjectsResponse
include Google::Apis::Core::Hashable
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
# <br>
# <br>This token can be used in a subsequent calls to `ListFirebaseProjects`
# to find the next group of Projects.
# <br>
# <br>Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# One page of the list of Projects that are accessible to the caller.
# Corresponds to the JSON property `results`
# @return [Array<Google::Apis::FirebaseV1beta1::FirebaseProject>]
attr_accessor :results
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@results = args[:results] if args.key?(:results)
end
end
#
class ListIosAppsResponse
include Google::Apis::Core::Hashable
# List of each IosApp that is in the parent Firebase Project.
# Corresponds to the JSON property `apps`
# @return [Array<Google::Apis::FirebaseV1beta1::IosApp>]
attr_accessor :apps
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
# <br>
# <br>This token can be used in a subsequent call to `ListIosApps` to find
# the next group of Apps.
# <br>
# <br>Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@apps = args[:apps] if args.key?(:apps)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
#
class ListShaCertificatesResponse
include Google::Apis::Core::Hashable
# The list of SHA certificates associated with the App.
# Corresponds to the JSON property `certificates`
# @return [Array<Google::Apis::FirebaseV1beta1::ShaCertificate>]
attr_accessor :certificates
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@certificates = args[:certificates] if args.key?(:certificates)
end
end
#
class ListWebAppsResponse
include Google::Apis::Core::Hashable
# List of each WebApp that is in the parent Firebase Project.
# Corresponds to the JSON property `apps`
# @return [Array<Google::Apis::FirebaseV1beta1::WebApp>]
attr_accessor :apps
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
# <br>
# <br>This token can be used in a subsequent call to `ListWebApps` to find
# the next group of Apps.
# <br>
# <br>Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@apps = args[:apps] if args.key?(:apps)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# A GCP resource location that can be selected for a Project.
class Location
include Google::Apis::Core::Hashable
# The ID of the default GCP resource location. It must be one of the
# available
# [GCP resource
# locations](https://firebase.google.com/docs/projects/locations).
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@location_id = args[:location_id] if args.key?(:location_id)
end
end
# This is proto2's version of MessageSet.
class MessageSet
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# This resource represents a long-running operation that is the result of a
# network API call.
class Operation
include Google::Apis::Core::Hashable
# If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# The `Status` type defines a logical error model that is suitable for
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
# Corresponds to the JSON property `error`
# @return [Google::Apis::FirebaseV1beta1::Status]
attr_accessor :error
# Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
# The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/`unique_id``.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
# methods, the response should have the type `XxxResponse`, where `Xxx`
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@done = args[:done] if args.key?(:done)
@error = args[:error] if args.key?(:error)
@metadata = args[:metadata] if args.key?(:metadata)
@name = args[:name] if args.key?(:name)
@response = args[:response] if args.key?(:response)
end
end
# A reference to a Google Cloud Platform (GCP) `Project`.
class ProjectInfo
include Google::Apis::Core::Hashable
# The user-assigned display name of the GCP `Project`, for example:
# <code>My App</code>
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The ID of the project's default GCP resource location. The location is one
# of the available
# [GCP resource
# locations](https://firebase.google.com/docs/projects/locations). <br> <br>
# Not all projects will have this field populated. If it is not populated, it
# means that the project does not yet have a default GCP resource location.
# To set your project's default GCP resource location, call
# [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you
# add Firebase resources to your project.
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
# The resource name of the GCP `Project` to which Firebase resources can be
# added, in the format:
# <br><code>projects/<var>projectId</var></code>
# Corresponds to the JSON property `project`
# @return [String]
attr_accessor :project
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] if args.key?(:display_name)
@location_id = args[:location_id] if args.key?(:location_id)
@project = args[:project] if args.key?(:project)
end
end
#
class RemoveAnalyticsRequest
include Google::Apis::Core::Hashable
# Optional. The ID of the Google Analytics property associated with the
# specified `FirebaseProject`.
# <ul>
# <li>If not set, then the Google Analytics property that is currently
# associated with the specified `FirebaseProject` is removed.</li>
# <li>If set, and the specified `FirebaseProject` is currently associated
# with a <em>different</em> Google Analytics property, then the response is a
# `412 Precondition Failed` error.</li>
# </ul>
# Corresponds to the JSON property `analyticsPropertyId`
# @return [String]
attr_accessor :analytics_property_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@analytics_property_id = args[:analytics_property_id] if args.key?(:analytics_property_id)
end
end
#
class SearchFirebaseAppsResponse
include Google::Apis::Core::Hashable
# One page of results from a call to `SearchFirebaseApps`.
# Corresponds to the JSON property `apps`
# @return [Array<Google::Apis::FirebaseV1beta1::FirebaseAppInfo>]
attr_accessor :apps
# If the result list is too large to fit in a single response, then a token
# is returned.
# <br>
# <br>This token can be used in a subsequent calls to `SearchFirebaseApps`
# to find the next group of Apps.
# <br>If the string is empty, then this response is the last page of results.
# <br>Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@apps = args[:apps] if args.key?(:apps)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# A SHA-1 or SHA-256 certificate associated with the AndroidApp.
class ShaCertificate
include Google::Apis::Core::Hashable
# The SHA certificate type.
# Corresponds to the JSON property `certType`
# @return [String]
attr_accessor :cert_type
# The fully qualified resource name of the `sha-key`, in the format:
# <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var>/sha/<var>
# shaId</var></code>
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The certificate hash for the App.
# Corresponds to the JSON property `shaHash`
# @return [String]
attr_accessor :sha_hash
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cert_type = args[:cert_type] if args.key?(:cert_type)
@name = args[:name] if args.key?(:name)
@sha_hash = args[:sha_hash] if args.key?(:sha_hash)
end
end
# The `Status` type defines a logical error model that is suitable for
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
class Status
include Google::Apis::Core::Hashable
# The status code, which should be an enum value of google.rpc.Code.
# Corresponds to the JSON property `code`
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@details = args[:details] if args.key?(:details)
@message = args[:message] if args.key?(:message)
end
end
# Wire-format for a Status object
class StatusProto
include Google::Apis::Core::Hashable
# The canonical error code (see codes.proto) that most closely
# corresponds to this status. May be missing.
# Corresponds to the JSON property `canonicalCode`
# @return [Fixnum]
attr_accessor :canonical_code
# Numeric code drawn from the space specified below. Often, this is the
# canonical error space, and code is drawn from google3/util/task/codes.proto
# Corresponds to the JSON property `code`
# @return [Fixnum]
attr_accessor :code
# Detail message
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
# This is proto2's version of MessageSet.
# Corresponds to the JSON property `messageSet`
# @return [Google::Apis::FirebaseV1beta1::MessageSet]
attr_accessor :message_set
# Message that groups a protocol type_id (as defined by MessageSet),
# with an encoded message of that type. Its use is similar to
# MessageSet, except it represents a single (type, encoded message)
# instead of a set.
# To fill for known protocol type:
# MyProtocolMsg proto;
# TypedMessage typed_msg;
# typed_msg.set_type_id(MyProtocolMsg::MESSAGE_TYPE_ID);
# proto.AppendToCord(typed_msg.mutable_message());
# To fill for unknown protocol type:
# ProtocolMessage proto;
# TypedMessage typed_msg;
# typed_msg.set_type_id(proto.GetMapper()->type_id());
# proto.AppendToCord(typed_msg.mutable_message());
# Corresponds to the JSON property `payload`
# @return [Google::Apis::FirebaseV1beta1::TypedMessage]
attr_accessor :payload
# The following are usually only present when code != 0
# Space to which this status belongs
# Corresponds to the JSON property `space`
# @return [String]
attr_accessor :space
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@canonical_code = args[:canonical_code] if args.key?(:canonical_code)
@code = args[:code] if args.key?(:code)
@message = args[:message] if args.key?(:message)
@message_set = args[:message_set] if args.key?(:message_set)
@payload = args[:payload] if args.key?(:payload)
@space = args[:space] if args.key?(:space)
end
end
# A mapping of a Firebase App to a Google Analytics data stream
class StreamMapping
include Google::Apis::Core::Hashable
# The fully qualified resource name of the Firebase App associated with the
# Google Analytics data stream, in the format:
# <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code>
# or
# <code>projects/<var>projectId</var>/iosApps/<var>appId</var></code>
# or
# <code>projects/<var>projectId</var>/webApps/<var>appId</var></code>
# Corresponds to the JSON property `app`
# @return [String]
attr_accessor :app
# Applicable for Firebase Web Apps only.<br>
# <br>The unique Google-assigned identifier of the Google Analytics web
# stream associated with the Firebase Web App. Firebase SDKs use this ID to
# interact with Google Analytics APIs.
# <br>
# <br>Learn more about this ID and Google Analytics web streams in the
# [Analytics
# documentation](https://support.google.com/analytics/topic/9303475).
# Corresponds to the JSON property `measurementId`
# @return [String]
attr_accessor :measurement_id
# The unique Google-assigned identifier of the Google Analytics data stream
# associated with the Firebase App.
# <br>
# <br>Learn more about Google Analytics data streams in the
# [Analytics
# documentation](https://support.google.com/analytics/answer/9303323).
# Corresponds to the JSON property `streamId`
# @return [Fixnum]
attr_accessor :stream_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@app = args[:app] if args.key?(:app)
@measurement_id = args[:measurement_id] if args.key?(:measurement_id)
@stream_id = args[:stream_id] if args.key?(:stream_id)
end
end
# Message that groups a protocol type_id (as defined by MessageSet),
# with an encoded message of that type. Its use is similar to
# MessageSet, except it represents a single (type, encoded message)
# instead of a set.
# To fill for known protocol type:
# MyProtocolMsg proto;
# TypedMessage typed_msg;
# typed_msg.set_type_id(MyProtocolMsg::MESSAGE_TYPE_ID);
# proto.AppendToCord(typed_msg.mutable_message());
# To fill for unknown protocol type:
# ProtocolMessage proto;
# TypedMessage typed_msg;
# typed_msg.set_type_id(proto.GetMapper()->type_id());
# proto.AppendToCord(typed_msg.mutable_message());
class TypedMessage
include Google::Apis::Core::Hashable
# Message bytes.
# Corresponds to the JSON property `message`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :message
# Identifier for the type.
# Corresponds to the JSON property `typeId`
# @return [Fixnum]
attr_accessor :type_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@message = args[:message] if args.key?(:message)
@type_id = args[:type_id] if args.key?(:type_id)
end
end
# Details of a Firebase App for the web.
class WebApp
include Google::Apis::Core::Hashable
# Immutable. The globally unique, Firebase-assigned identifier of the App.
# <br>
# <br>This identifier should be treated as an opaque token, as the data
# format is not specified.
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
# The fully qualified URLs where the App is hosted.
# Corresponds to the JSON property `appUrls`
# @return [Array<String>]
attr_accessor :app_urls
# The user-assigned display name of the App.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The fully qualified resource name of the App, for example:
# <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code>
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The globally unique, user-assigned ID of the parent Project for the App.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@app_id = args[:app_id] if args.key?(:app_id)
@app_urls = args[:app_urls] if args.key?(:app_urls)
@display_name = args[:display_name] if args.key?(:display_name)
@name = args[:name] if args.key?(:name)
@project_id = args[:project_id] if args.key?(:project_id)
end
end
# Configuration metadata of a single Firebase App for the web.
class WebAppConfig
include Google::Apis::Core::Hashable
# The API key associated with the web App.
# Corresponds to the JSON property `apiKey`
# @return [String]
attr_accessor :api_key
# Immutable. The globally unique, Firebase-assigned identifier of the App.
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
# The domain Firebase Auth configures for OAuth redirects, in the format:
# <br><code><var>projectId</var>.firebaseapp.com</code>
# Corresponds to the JSON property `authDomain`
# @return [String]
attr_accessor :auth_domain
# The default Firebase Realtime Database URL.
# Corresponds to the JSON property `databaseURL`
# @return [String]
attr_accessor :database_url
# The ID of the project's default GCP resource location. The location is one
# of the available
# [GCP resource
# locations](https://firebase.google.com/docs/projects/locations). <br>
# <br>This field is omitted if the default GCP resource location has not been
# finalized yet. To set your project's default GCP resource location,
# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)
# after you add Firebase services to your project.
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
# The unique Google-assigned identifier of the Google Analytics web stream
# associated with the Firebase Web App. Firebase SDKs use this ID to interact
# with Google Analytics APIs.
# <br>
# <br>This field is only present if the App is linked to a web stream in a
# Google Analytics App + Web property. Learn more about this ID and Google
# Analytics web streams in the [Analytics
# documentation](https://support.google.com/analytics/topic/9303475).
# <br>
# <br>To generate a `measurementId` and link the Web App with a Google
# Analytics web stream, call
# [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics).
# Corresponds to the JSON property `measurementId`
# @return [String]
attr_accessor :measurement_id
# The sender ID for use with Firebase Cloud Messaging.
# Corresponds to the JSON property `messagingSenderId`
# @return [String]
attr_accessor :messaging_sender_id
# Immutable. The globally unique, user-assigned project ID of the parent
# Project for the App.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
# The default Cloud Storage for Firebase storage bucket name.
# Corresponds to the JSON property `storageBucket`
# @return [String]
attr_accessor :storage_bucket
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@api_key = args[:api_key] if args.key?(:api_key)
@app_id = args[:app_id] if args.key?(:app_id)
@auth_domain = args[:auth_domain] if args.key?(:auth_domain)
@database_url = args[:database_url] if args.key?(:database_url)
@location_id = args[:location_id] if args.key?(:location_id)
@measurement_id = args[:measurement_id] if args.key?(:measurement_id)
@messaging_sender_id = args[:messaging_sender_id] if args.key?(:messaging_sender_id)
@project_id = args[:project_id] if args.key?(:project_id)
@storage_bucket = args[:storage_bucket] if args.key?(:storage_bucket)
end
end
end
end
end
|