Autogenerated update (2017-10-04)
Update: - androidenterprise_v1 - bigquerydatatransfer_v1 - identitytoolkit_v3 - ml_v1 - proximitybeacon_v1beta1
This commit is contained in:
Google APIs committed
1 parent
6f6fec685d
commit
e0d837f35d
19 files changed
+4518
-55
No files matched your search
@@ -25,7 +25,7 @@ module Google
|
||||
# @see https://developers.google.com/android/work/play/emm-api
|
||||
module AndroidenterpriseV1
|
||||
VERSION = 'V1'
|
||||
REVISION = '20170911'
|
||||
REVISION = '20170929'
|
||||
|
||||
# Manage corporate Android devices
|
||||
AUTH_ANDROIDENTERPRISE = 'https://www.googleapis.com/auth/androidenterprise'
|
||||
|
||||
@@ -323,6 +323,12 @@ module Google
|
||||
class AppVersion
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The track that this app was published in. For example if track is "alpha",
|
||||
# this is an alpha version of the app.
|
||||
# Corresponds to the JSON property `track`
|
||||
# @return [String]
|
||||
attr_accessor :track
|
||||
|
||||
# Unique increasing identifier for the app version.
|
||||
# Corresponds to the JSON property `versionCode`
|
||||
# @return [Fixnum]
|
||||
@@ -341,6 +347,7 @@ module Google
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@track = args[:track] if args.key?(:track)
|
||||
@version_code = args[:version_code] if args.key?(:version_code)
|
||||
@version_string = args[:version_string] if args.key?(:version_string)
|
||||
end
|
||||
@@ -1471,6 +1478,11 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :author_name
|
||||
|
||||
# The tracks that are visible to the enterprise.
|
||||
# Corresponds to the JSON property `availableTracks`
|
||||
# @return [Array<String>]
|
||||
attr_accessor :available_tracks
|
||||
|
||||
# A link to the (consumer) Google Play details page for the product.
|
||||
# Corresponds to the JSON property `detailsUrl`
|
||||
# @return [String]
|
||||
@@ -1547,6 +1559,7 @@ module Google
|
||||
def update!(**args)
|
||||
@app_version = args[:app_version] if args.key?(:app_version)
|
||||
@author_name = args[:author_name] if args.key?(:author_name)
|
||||
@available_tracks = args[:available_tracks] if args.key?(:available_tracks)
|
||||
@details_url = args[:details_url] if args.key?(:details_url)
|
||||
@distribution_channel = args[:distribution_channel] if args.key?(:distribution_channel)
|
||||
@icon_url = args[:icon_url] if args.key?(:icon_url)
|
||||
@@ -1706,6 +1719,16 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :product_set_behavior
|
||||
|
||||
# Other products that are part of the set, in addition to those specified in the
|
||||
# productId array. The only difference between this field and the productId
|
||||
# array is that it's possible to specify additional information about this
|
||||
# product visibility, see ProductVisibility and its fields for more information.
|
||||
# Specifying the same product ID both here and in the productId array is not
|
||||
# allowed and it will result in an error.
|
||||
# Corresponds to the JSON property `productVisibility`
|
||||
# @return [Array<Google::Apis::AndroidenterpriseV1::ProductVisibility>]
|
||||
attr_accessor :product_visibility
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
@@ -1715,6 +1738,7 @@ module Google
|
||||
@kind = args[:kind] if args.key?(:kind)
|
||||
@product_id = args[:product_id] if args.key?(:product_id)
|
||||
@product_set_behavior = args[:product_set_behavior] if args.key?(:product_set_behavior)
|
||||
@product_visibility = args[:product_visibility] if args.key?(:product_visibility)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1745,6 +1769,45 @@ module Google
|
||||
end
|
||||
end
|
||||
|
||||
# A product to be made visible to a user.
|
||||
class ProductVisibility
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The product ID that should be made visible to the user. This is required.
|
||||
# Corresponds to the JSON property `productId`
|
||||
# @return [String]
|
||||
attr_accessor :product_id
|
||||
|
||||
# This allows to only grant visibility to the specified tracks of the app. For
|
||||
# example, if an app has a prod version, a beta version and an alpha version and
|
||||
# the enterprise has been granted visibility to both the alpha and beta tracks,
|
||||
# if tracks is `"beta", "production"` the user will be able to install the app
|
||||
# and they will get the beta version of the app. If there are no app versions in
|
||||
# the specified track or if the enterprise wasn't granted visibility for the
|
||||
# track, adding the "alpha" and "beta" values to the list of tracks will have no
|
||||
# effect for now; however they will take effect once both conditions are met.
|
||||
# Note that the enterprise itself needs to be granted access to the alpha and/or
|
||||
# beta tracks, regardless of whether individual users or admins have access to
|
||||
# those tracks.
|
||||
# The allowed sets are: `` (considered equivalent to `"production"`) `"
|
||||
# production"` `"beta", "production"` `"alpha", "beta", "production"` The order
|
||||
# of elements is not relevant. Any other set of tracks will be rejected with an
|
||||
# error.
|
||||
# Corresponds to the JSON property `tracks`
|
||||
# @return [Array<String>]
|
||||
attr_accessor :tracks
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@product_id = args[:product_id] if args.key?(:product_id)
|
||||
@tracks = args[:tracks] if args.key?(:tracks)
|
||||
end
|
||||
end
|
||||
|
||||
#
|
||||
class ApproveProductRequest
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
@@ -298,6 +298,12 @@ module Google
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class ProductVisibility
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class ApproveProductRequest
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
@@ -479,6 +485,7 @@ module Google
|
||||
class AppVersion
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :track, as: 'track'
|
||||
property :version_code, as: 'versionCode'
|
||||
property :version_string, as: 'versionString'
|
||||
end
|
||||
@@ -777,6 +784,7 @@ module Google
|
||||
collection :app_version, as: 'appVersion', class: Google::Apis::AndroidenterpriseV1::AppVersion, decorator: Google::Apis::AndroidenterpriseV1::AppVersion::Representation
|
||||
|
||||
property :author_name, as: 'authorName'
|
||||
collection :available_tracks, as: 'availableTracks'
|
||||
property :details_url, as: 'detailsUrl'
|
||||
property :distribution_channel, as: 'distributionChannel'
|
||||
property :icon_url, as: 'iconUrl'
|
||||
@@ -832,6 +840,8 @@ module Google
|
||||
property :kind, as: 'kind'
|
||||
collection :product_id, as: 'productId'
|
||||
property :product_set_behavior, as: 'productSetBehavior'
|
||||
collection :product_visibility, as: 'productVisibility', class: Google::Apis::AndroidenterpriseV1::ProductVisibility, decorator: Google::Apis::AndroidenterpriseV1::ProductVisibility::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
@@ -843,6 +853,14 @@ module Google
|
||||
end
|
||||
end
|
||||
|
||||
class ProductVisibility
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :product_id, as: 'productId'
|
||||
collection :tracks, as: 'tracks'
|
||||
end
|
||||
end
|
||||
|
||||
class ApproveProductRequest
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
|
||||
@@ -26,7 +26,7 @@ module Google
|
||||
# @see https://cloud.google.com/bigquery/
|
||||
module BigquerydatatransferV1
|
||||
VERSION = 'V1'
|
||||
REVISION = '20170925'
|
||||
REVISION = '20171002'
|
||||
|
||||
# View and manage your data in Google BigQuery
|
||||
AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery'
|
||||
|
||||
@@ -346,11 +346,10 @@ module Google
|
||||
# @return [Array<Google::Apis::BigquerydatatransferV1::DataSource>]
|
||||
attr_accessor :data_sources
|
||||
|
||||
# The next-pagination token. For multiple-page list results,
|
||||
# Output only. The next-pagination token. For multiple-page list results,
|
||||
# this token can be used as the
|
||||
# `ListDataSourcesRequest.page_token`
|
||||
# to request the next page of list results.
|
||||
# Output only.
|
||||
# Corresponds to the JSON property `nextPageToken`
|
||||
# @return [String]
|
||||
attr_accessor :next_page_token
|
||||
@@ -395,17 +394,15 @@ module Google
|
||||
class ListTransferConfigsResponse
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The next-pagination token. For multiple-page list results,
|
||||
# Output only. The next-pagination token. For multiple-page list results,
|
||||
# this token can be used as the
|
||||
# `ListTransferConfigsRequest.page_token`
|
||||
# to request the next page of list results.
|
||||
# Output only.
|
||||
# Corresponds to the JSON property `nextPageToken`
|
||||
# @return [String]
|
||||
attr_accessor :next_page_token
|
||||
|
||||
# The stored pipeline transfer configurations.
|
||||
# Output only.
|
||||
# Output only. The stored pipeline transfer configurations.
|
||||
# Corresponds to the JSON property `transferConfigs`
|
||||
# @return [Array<Google::Apis::BigquerydatatransferV1::TransferConfig>]
|
||||
attr_accessor :transfer_configs
|
||||
@@ -425,17 +422,15 @@ module Google
|
||||
class ListTransferLogsResponse
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The next-pagination token. For multiple-page list results,
|
||||
# Output only. The next-pagination token. For multiple-page list results,
|
||||
# this token can be used as the
|
||||
# `GetTransferRunLogRequest.page_token`
|
||||
# to request the next page of list results.
|
||||
# Output only.
|
||||
# Corresponds to the JSON property `nextPageToken`
|
||||
# @return [String]
|
||||
attr_accessor :next_page_token
|
||||
|
||||
# The stored pipeline transfer messages.
|
||||
# Output only.
|
||||
# Output only. The stored pipeline transfer messages.
|
||||
# Corresponds to the JSON property `transferMessages`
|
||||
# @return [Array<Google::Apis::BigquerydatatransferV1::TransferMessage>]
|
||||
attr_accessor :transfer_messages
|
||||
@@ -455,17 +450,15 @@ module Google
|
||||
class ListTransferRunsResponse
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The next-pagination token. For multiple-page list results,
|
||||
# Output only. The next-pagination token. For multiple-page list results,
|
||||
# this token can be used as the
|
||||
# `ListTransferRunsRequest.page_token`
|
||||
# to request the next page of list results.
|
||||
# Output only.
|
||||
# Corresponds to the JSON property `nextPageToken`
|
||||
# @return [String]
|
||||
attr_accessor :next_page_token
|
||||
|
||||
# The stored pipeline transfer runs.
|
||||
# Output only.
|
||||
# Output only. The stored pipeline transfer runs.
|
||||
# Corresponds to the JSON property `transferRuns`
|
||||
# @return [Array<Google::Apis::BigquerydatatransferV1::TransferRun>]
|
||||
attr_accessor :transfer_runs
|
||||
@@ -591,9 +584,7 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :data_source_id
|
||||
|
||||
# Region in which BigQuery dataset is located. Currently possible values are:
|
||||
# "US" and "EU".
|
||||
# Output only.
|
||||
# Output only. Region in which BigQuery dataset is located.
|
||||
# Corresponds to the JSON property `datasetRegion`
|
||||
# @return [String]
|
||||
attr_accessor :dataset_region
|
||||
@@ -625,8 +616,7 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :name
|
||||
|
||||
# Next time when data transfer will run.
|
||||
# Output only.
|
||||
# Output only. Next time when data transfer will run.
|
||||
# Corresponds to the JSON property `nextRunTime`
|
||||
# @return [String]
|
||||
attr_accessor :next_run_time
|
||||
@@ -653,22 +643,19 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :schedule
|
||||
|
||||
# State of the most recently updated transfer run.
|
||||
# Output only.
|
||||
# Output only. State of the most recently updated transfer run.
|
||||
# Corresponds to the JSON property `state`
|
||||
# @return [String]
|
||||
attr_accessor :state
|
||||
|
||||
# Data transfer modification time. Ignored by server on input.
|
||||
# Output only.
|
||||
# Output only. Data transfer modification time. Ignored by server on input.
|
||||
# Corresponds to the JSON property `updateTime`
|
||||
# @return [String]
|
||||
attr_accessor :update_time
|
||||
|
||||
# Unique ID of the user on whose behalf transfer is done. Applicable only
|
||||
# to data sources that do not support service accounts. When set to 0,
|
||||
# the data source service account credentials are used.
|
||||
# Output only.
|
||||
# Output only. Unique ID of the user on whose behalf transfer is done.
|
||||
# Applicable only to data sources that do not support service accounts.
|
||||
# When set to 0, the data source service account credentials are used.
|
||||
# Corresponds to the JSON property `userId`
|
||||
# @return [Fixnum]
|
||||
attr_accessor :user_id
|
||||
@@ -730,15 +717,12 @@ module Google
|
||||
class TransferRun
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# Data source id.
|
||||
# Output only.
|
||||
# Output only. Data source id.
|
||||
# Corresponds to the JSON property `dataSourceId`
|
||||
# @return [String]
|
||||
attr_accessor :data_source_id
|
||||
|
||||
# Region in which BigQuery dataset is located. Currently possible values are:
|
||||
# "US" and "EU".
|
||||
# Output only.
|
||||
# Output only. Region in which BigQuery dataset is located.
|
||||
# Corresponds to the JSON property `datasetRegion`
|
||||
# @return [String]
|
||||
attr_accessor :dataset_region
|
||||
@@ -748,9 +732,8 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :destination_dataset_id
|
||||
|
||||
# Time when transfer run ended. Parameter ignored by server for input
|
||||
# requests.
|
||||
# Output only.
|
||||
# Output only. Time when transfer run ended.
|
||||
# Parameter ignored by server for input requests.
|
||||
# Corresponds to the JSON property `endTime`
|
||||
# @return [String]
|
||||
attr_accessor :end_time
|
||||
@@ -775,12 +758,11 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :run_time
|
||||
|
||||
# Describes the schedule of this transfer run if it was created as part of
|
||||
# a regular schedule. For batch transfer runs that are directly created,
|
||||
# this is empty.
|
||||
# Output only. Describes the schedule of this transfer run if it was
|
||||
# created as part of a regular schedule. For batch transfer runs that are
|
||||
# scheduled manually, this is empty.
|
||||
# NOTE: the system might choose to delay the schedule depending on the
|
||||
# current load, so `schedule_time` doesn't always matches this.
|
||||
# Output only.
|
||||
# Corresponds to the JSON property `schedule`
|
||||
# @return [String]
|
||||
attr_accessor :schedule
|
||||
@@ -790,29 +772,25 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :schedule_time
|
||||
|
||||
# Time when transfer run was started. Parameter ignored by server for input
|
||||
# requests.
|
||||
# Output only.
|
||||
# Output only. Time when transfer run was started.
|
||||
# Parameter ignored by server for input requests.
|
||||
# Corresponds to the JSON property `startTime`
|
||||
# @return [String]
|
||||
attr_accessor :start_time
|
||||
|
||||
# Data transfer run state. Ignored for input requests.
|
||||
# Output only.
|
||||
# Output only. Data transfer run state. Ignored for input requests.
|
||||
# Corresponds to the JSON property `state`
|
||||
# @return [String]
|
||||
attr_accessor :state
|
||||
|
||||
# Last time the data transfer run state was updated.
|
||||
# Output only.
|
||||
# Output only. Last time the data transfer run state was updated.
|
||||
# Corresponds to the JSON property `updateTime`
|
||||
# @return [String]
|
||||
attr_accessor :update_time
|
||||
|
||||
# Unique ID of the user on whose behalf transfer is done. Applicable only
|
||||
# to data sources that do not support service accounts. When set to 0,
|
||||
# the data source service account credentials are used.
|
||||
# Output only.
|
||||
# Output only. Unique ID of the user on whose behalf transfer is done.
|
||||
# Applicable only to data sources that do not support service accounts.
|
||||
# When set to 0, the data source service account credentials are used.
|
||||
# Corresponds to the JSON property `userId`
|
||||
# @return [Fixnum]
|
||||
attr_accessor :user_id
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
# 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 'google/apis/firestore_v1beta1/service.rb'
|
||||
require 'google/apis/firestore_v1beta1/classes.rb'
|
||||
require 'google/apis/firestore_v1beta1/representations.rb'
|
||||
|
||||
module Google
|
||||
module Apis
|
||||
# Google Cloud Firestore API
|
||||
#
|
||||
#
|
||||
#
|
||||
# @see https://cloud.google.com/firestore
|
||||
module FirestoreV1beta1
|
||||
VERSION = 'V1beta1'
|
||||
REVISION = '0'
|
||||
|
||||
# View and manage your data across Google Cloud Platform services
|
||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||
|
||||
# View and manage your Google Cloud Datastore data
|
||||
AUTH_DATASTORE = 'https://www.googleapis.com/auth/datastore'
|
||||
end
|
||||
end
|
||||
end
|
||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,899 @@
|
||||
# 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 FirestoreV1beta1
|
||||
|
||||
class ArrayValue
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class BatchGetDocumentsRequest
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class BatchGetDocumentsResponse
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class BeginTransactionRequest
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class BeginTransactionResponse
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class CollectionSelector
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class CommitRequest
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class CommitResponse
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class CompositeFilter
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Cursor
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Document
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class DocumentChange
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class DocumentDelete
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class DocumentMask
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class DocumentRemove
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class DocumentTransform
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class DocumentsTarget
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Empty
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class ExistenceFilter
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class FieldFilter
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class FieldReference
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class FieldTransform
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Filter
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Index
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class IndexField
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class IndexOperationMetadata
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class LatLng
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class ListCollectionIdsResponse
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class ListDocumentsResponse
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class ListIndexesResponse
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class ListenRequest
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class ListenResponse
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class MapValue
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Operation
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Order
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Precondition
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Progress
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Projection
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class QueryTarget
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class ReadOnly
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class ReadWrite
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class RollbackRequest
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class RunQueryRequest
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class RunQueryResponse
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Status
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class StructuredQuery
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Target
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class TargetChange
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class TransactionOptions
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class UnaryFilter
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Value
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class Write
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class WriteRequest
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class WriteResponse
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class WriteResult
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class ArrayValue
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :values, as: 'values', class: Google::Apis::FirestoreV1beta1::Value, decorator: Google::Apis::FirestoreV1beta1::Value::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class BatchGetDocumentsRequest
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :documents, as: 'documents'
|
||||
property :mask, as: 'mask', class: Google::Apis::FirestoreV1beta1::DocumentMask, decorator: Google::Apis::FirestoreV1beta1::DocumentMask::Representation
|
||||
|
||||
property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
|
||||
|
||||
property :read_time, as: 'readTime'
|
||||
property :transaction, :base64 => true, as: 'transaction'
|
||||
end
|
||||
end
|
||||
|
||||
class BatchGetDocumentsResponse
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :found, as: 'found', class: Google::Apis::FirestoreV1beta1::Document, decorator: Google::Apis::FirestoreV1beta1::Document::Representation
|
||||
|
||||
property :missing, as: 'missing'
|
||||
property :read_time, as: 'readTime'
|
||||
property :transaction, :base64 => true, as: 'transaction'
|
||||
end
|
||||
end
|
||||
|
||||
class BeginTransactionRequest
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :options, as: 'options', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class BeginTransactionResponse
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :transaction, :base64 => true, as: 'transaction'
|
||||
end
|
||||
end
|
||||
|
||||
class CollectionSelector
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :all_descendants, as: 'allDescendants'
|
||||
property :collection_id, as: 'collectionId'
|
||||
end
|
||||
end
|
||||
|
||||
class CommitRequest
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :transaction, :base64 => true, as: 'transaction'
|
||||
collection :writes, as: 'writes', class: Google::Apis::FirestoreV1beta1::Write, decorator: Google::Apis::FirestoreV1beta1::Write::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class CommitResponse
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :commit_time, as: 'commitTime'
|
||||
collection :write_results, as: 'writeResults', class: Google::Apis::FirestoreV1beta1::WriteResult, decorator: Google::Apis::FirestoreV1beta1::WriteResult::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class CompositeFilter
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :filters, as: 'filters', class: Google::Apis::FirestoreV1beta1::Filter, decorator: Google::Apis::FirestoreV1beta1::Filter::Representation
|
||||
|
||||
property :op, as: 'op'
|
||||
end
|
||||
end
|
||||
|
||||
class Cursor
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :before, as: 'before'
|
||||
collection :values, as: 'values', class: Google::Apis::FirestoreV1beta1::Value, decorator: Google::Apis::FirestoreV1beta1::Value::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class Document
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :create_time, as: 'createTime'
|
||||
hash :fields, as: 'fields', class: Google::Apis::FirestoreV1beta1::Value, decorator: Google::Apis::FirestoreV1beta1::Value::Representation
|
||||
|
||||
property :name, as: 'name'
|
||||
property :update_time, as: 'updateTime'
|
||||
end
|
||||
end
|
||||
|
||||
class DocumentChange
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :document, as: 'document', class: Google::Apis::FirestoreV1beta1::Document, decorator: Google::Apis::FirestoreV1beta1::Document::Representation
|
||||
|
||||
collection :removed_target_ids, as: 'removedTargetIds'
|
||||
collection :target_ids, as: 'targetIds'
|
||||
end
|
||||
end
|
||||
|
||||
class DocumentDelete
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :document, as: 'document'
|
||||
property :read_time, as: 'readTime'
|
||||
collection :removed_target_ids, as: 'removedTargetIds'
|
||||
end
|
||||
end
|
||||
|
||||
class DocumentMask
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :field_paths, as: 'fieldPaths'
|
||||
end
|
||||
end
|
||||
|
||||
class DocumentRemove
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :document, as: 'document'
|
||||
property :read_time, as: 'readTime'
|
||||
collection :removed_target_ids, as: 'removedTargetIds'
|
||||
end
|
||||
end
|
||||
|
||||
class DocumentTransform
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :document, as: 'document'
|
||||
collection :field_transforms, as: 'fieldTransforms', class: Google::Apis::FirestoreV1beta1::FieldTransform, decorator: Google::Apis::FirestoreV1beta1::FieldTransform::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class DocumentsTarget
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :documents, as: 'documents'
|
||||
end
|
||||
end
|
||||
|
||||
class Empty
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
end
|
||||
end
|
||||
|
||||
class ExistenceFilter
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :count, as: 'count'
|
||||
property :target_id, as: 'targetId'
|
||||
end
|
||||
end
|
||||
|
||||
class FieldFilter
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :field, as: 'field', class: Google::Apis::FirestoreV1beta1::FieldReference, decorator: Google::Apis::FirestoreV1beta1::FieldReference::Representation
|
||||
|
||||
property :op, as: 'op'
|
||||
property :value, as: 'value', class: Google::Apis::FirestoreV1beta1::Value, decorator: Google::Apis::FirestoreV1beta1::Value::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class FieldReference
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :field_path, as: 'fieldPath'
|
||||
end
|
||||
end
|
||||
|
||||
class FieldTransform
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :field_path, as: 'fieldPath'
|
||||
property :set_to_server_value, as: 'setToServerValue'
|
||||
end
|
||||
end
|
||||
|
||||
class Filter
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :composite_filter, as: 'compositeFilter', class: Google::Apis::FirestoreV1beta1::CompositeFilter, decorator: Google::Apis::FirestoreV1beta1::CompositeFilter::Representation
|
||||
|
||||
property :field_filter, as: 'fieldFilter', class: Google::Apis::FirestoreV1beta1::FieldFilter, decorator: Google::Apis::FirestoreV1beta1::FieldFilter::Representation
|
||||
|
||||
property :unary_filter, as: 'unaryFilter', class: Google::Apis::FirestoreV1beta1::UnaryFilter, decorator: Google::Apis::FirestoreV1beta1::UnaryFilter::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class Index
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :collection_id, as: 'collectionId'
|
||||
collection :fields, as: 'fields', class: Google::Apis::FirestoreV1beta1::IndexField, decorator: Google::Apis::FirestoreV1beta1::IndexField::Representation
|
||||
|
||||
property :name, as: 'name'
|
||||
property :state, as: 'state'
|
||||
end
|
||||
end
|
||||
|
||||
class IndexField
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :field_path, as: 'fieldPath'
|
||||
property :mode, as: 'mode'
|
||||
end
|
||||
end
|
||||
|
||||
class IndexOperationMetadata
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :cancelled, as: 'cancelled'
|
||||
property :document_progress, as: 'documentProgress', class: Google::Apis::FirestoreV1beta1::Progress, decorator: Google::Apis::FirestoreV1beta1::Progress::Representation
|
||||
|
||||
property :end_time, as: 'endTime'
|
||||
property :index, as: 'index'
|
||||
property :operation_type, as: 'operationType'
|
||||
property :start_time, as: 'startTime'
|
||||
end
|
||||
end
|
||||
|
||||
class LatLng
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :latitude, as: 'latitude'
|
||||
property :longitude, as: 'longitude'
|
||||
end
|
||||
end
|
||||
|
||||
class ListCollectionIdsResponse
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :collection_ids, as: 'collectionIds'
|
||||
property :next_page_token, as: 'nextPageToken'
|
||||
end
|
||||
end
|
||||
|
||||
class ListDocumentsResponse
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :documents, as: 'documents', class: Google::Apis::FirestoreV1beta1::Document, decorator: Google::Apis::FirestoreV1beta1::Document::Representation
|
||||
|
||||
property :next_page_token, as: 'nextPageToken'
|
||||
end
|
||||
end
|
||||
|
||||
class ListIndexesResponse
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :indexes, as: 'indexes', class: Google::Apis::FirestoreV1beta1::Index, decorator: Google::Apis::FirestoreV1beta1::Index::Representation
|
||||
|
||||
property :next_page_token, as: 'nextPageToken'
|
||||
end
|
||||
end
|
||||
|
||||
class ListenRequest
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :add_target, as: 'addTarget', class: Google::Apis::FirestoreV1beta1::Target, decorator: Google::Apis::FirestoreV1beta1::Target::Representation
|
||||
|
||||
hash :labels, as: 'labels'
|
||||
property :remove_target, as: 'removeTarget'
|
||||
end
|
||||
end
|
||||
|
||||
class ListenResponse
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :document_change, as: 'documentChange', class: Google::Apis::FirestoreV1beta1::DocumentChange, decorator: Google::Apis::FirestoreV1beta1::DocumentChange::Representation
|
||||
|
||||
property :document_delete, as: 'documentDelete', class: Google::Apis::FirestoreV1beta1::DocumentDelete, decorator: Google::Apis::FirestoreV1beta1::DocumentDelete::Representation
|
||||
|
||||
property :document_remove, as: 'documentRemove', class: Google::Apis::FirestoreV1beta1::DocumentRemove, decorator: Google::Apis::FirestoreV1beta1::DocumentRemove::Representation
|
||||
|
||||
property :filter, as: 'filter', class: Google::Apis::FirestoreV1beta1::ExistenceFilter, decorator: Google::Apis::FirestoreV1beta1::ExistenceFilter::Representation
|
||||
|
||||
property :target_change, as: 'targetChange', class: Google::Apis::FirestoreV1beta1::TargetChange, decorator: Google::Apis::FirestoreV1beta1::TargetChange::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class MapValue
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
hash :fields, as: 'fields', class: Google::Apis::FirestoreV1beta1::Value, decorator: Google::Apis::FirestoreV1beta1::Value::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class Operation
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :done, as: 'done'
|
||||
property :error, as: 'error', class: Google::Apis::FirestoreV1beta1::Status, decorator: Google::Apis::FirestoreV1beta1::Status::Representation
|
||||
|
||||
hash :metadata, as: 'metadata'
|
||||
property :name, as: 'name'
|
||||
hash :response, as: 'response'
|
||||
end
|
||||
end
|
||||
|
||||
class Order
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :direction, as: 'direction'
|
||||
property :field, as: 'field', class: Google::Apis::FirestoreV1beta1::FieldReference, decorator: Google::Apis::FirestoreV1beta1::FieldReference::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class Precondition
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :exists, as: 'exists'
|
||||
property :update_time, as: 'updateTime'
|
||||
end
|
||||
end
|
||||
|
||||
class Progress
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :work_completed, :numeric_string => true, as: 'workCompleted'
|
||||
property :work_estimated, :numeric_string => true, as: 'workEstimated'
|
||||
end
|
||||
end
|
||||
|
||||
class Projection
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :fields, as: 'fields', class: Google::Apis::FirestoreV1beta1::FieldReference, decorator: Google::Apis::FirestoreV1beta1::FieldReference::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class QueryTarget
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :parent, as: 'parent'
|
||||
property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1beta1::StructuredQuery, decorator: Google::Apis::FirestoreV1beta1::StructuredQuery::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class ReadOnly
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :read_time, as: 'readTime'
|
||||
end
|
||||
end
|
||||
|
||||
class ReadWrite
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :retry_transaction, :base64 => true, as: 'retryTransaction'
|
||||
end
|
||||
end
|
||||
|
||||
class RollbackRequest
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :transaction, :base64 => true, as: 'transaction'
|
||||
end
|
||||
end
|
||||
|
||||
class RunQueryRequest
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
|
||||
|
||||
property :read_time, as: 'readTime'
|
||||
property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1beta1::StructuredQuery, decorator: Google::Apis::FirestoreV1beta1::StructuredQuery::Representation
|
||||
|
||||
property :transaction, :base64 => true, as: 'transaction'
|
||||
end
|
||||
end
|
||||
|
||||
class RunQueryResponse
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :document, as: 'document', class: Google::Apis::FirestoreV1beta1::Document, decorator: Google::Apis::FirestoreV1beta1::Document::Representation
|
||||
|
||||
property :read_time, as: 'readTime'
|
||||
property :skipped_results, as: 'skippedResults'
|
||||
property :transaction, :base64 => true, as: 'transaction'
|
||||
end
|
||||
end
|
||||
|
||||
class Status
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :code, as: 'code'
|
||||
collection :details, as: 'details'
|
||||
property :message, as: 'message'
|
||||
end
|
||||
end
|
||||
|
||||
class StructuredQuery
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :end_at, as: 'endAt', class: Google::Apis::FirestoreV1beta1::Cursor, decorator: Google::Apis::FirestoreV1beta1::Cursor::Representation
|
||||
|
||||
collection :from, as: 'from', class: Google::Apis::FirestoreV1beta1::CollectionSelector, decorator: Google::Apis::FirestoreV1beta1::CollectionSelector::Representation
|
||||
|
||||
property :limit, as: 'limit'
|
||||
property :offset, as: 'offset'
|
||||
collection :order_by, as: 'orderBy', class: Google::Apis::FirestoreV1beta1::Order, decorator: Google::Apis::FirestoreV1beta1::Order::Representation
|
||||
|
||||
property :select, as: 'select', class: Google::Apis::FirestoreV1beta1::Projection, decorator: Google::Apis::FirestoreV1beta1::Projection::Representation
|
||||
|
||||
property :start_at, as: 'startAt', class: Google::Apis::FirestoreV1beta1::Cursor, decorator: Google::Apis::FirestoreV1beta1::Cursor::Representation
|
||||
|
||||
property :where, as: 'where', class: Google::Apis::FirestoreV1beta1::Filter, decorator: Google::Apis::FirestoreV1beta1::Filter::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class Target
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :documents, as: 'documents', class: Google::Apis::FirestoreV1beta1::DocumentsTarget, decorator: Google::Apis::FirestoreV1beta1::DocumentsTarget::Representation
|
||||
|
||||
property :once, as: 'once'
|
||||
property :query, as: 'query', class: Google::Apis::FirestoreV1beta1::QueryTarget, decorator: Google::Apis::FirestoreV1beta1::QueryTarget::Representation
|
||||
|
||||
property :read_time, as: 'readTime'
|
||||
property :resume_token, :base64 => true, as: 'resumeToken'
|
||||
property :target_id, as: 'targetId'
|
||||
end
|
||||
end
|
||||
|
||||
class TargetChange
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :cause, as: 'cause', class: Google::Apis::FirestoreV1beta1::Status, decorator: Google::Apis::FirestoreV1beta1::Status::Representation
|
||||
|
||||
property :read_time, as: 'readTime'
|
||||
property :resume_token, :base64 => true, as: 'resumeToken'
|
||||
property :target_change_type, as: 'targetChangeType'
|
||||
collection :target_ids, as: 'targetIds'
|
||||
end
|
||||
end
|
||||
|
||||
class TransactionOptions
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :read_only, as: 'readOnly', class: Google::Apis::FirestoreV1beta1::ReadOnly, decorator: Google::Apis::FirestoreV1beta1::ReadOnly::Representation
|
||||
|
||||
property :read_write, as: 'readWrite', class: Google::Apis::FirestoreV1beta1::ReadWrite, decorator: Google::Apis::FirestoreV1beta1::ReadWrite::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class UnaryFilter
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :field, as: 'field', class: Google::Apis::FirestoreV1beta1::FieldReference, decorator: Google::Apis::FirestoreV1beta1::FieldReference::Representation
|
||||
|
||||
property :op, as: 'op'
|
||||
end
|
||||
end
|
||||
|
||||
class Value
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :array_value, as: 'arrayValue', class: Google::Apis::FirestoreV1beta1::ArrayValue, decorator: Google::Apis::FirestoreV1beta1::ArrayValue::Representation
|
||||
|
||||
property :boolean_value, as: 'booleanValue'
|
||||
property :bytes_value, :base64 => true, as: 'bytesValue'
|
||||
property :double_value, as: 'doubleValue'
|
||||
property :geo_point_value, as: 'geoPointValue', class: Google::Apis::FirestoreV1beta1::LatLng, decorator: Google::Apis::FirestoreV1beta1::LatLng::Representation
|
||||
|
||||
property :integer_value, :numeric_string => true, as: 'integerValue'
|
||||
property :map_value, as: 'mapValue', class: Google::Apis::FirestoreV1beta1::MapValue, decorator: Google::Apis::FirestoreV1beta1::MapValue::Representation
|
||||
|
||||
property :null_value, as: 'nullValue'
|
||||
property :reference_value, as: 'referenceValue'
|
||||
property :string_value, as: 'stringValue'
|
||||
property :timestamp_value, as: 'timestampValue'
|
||||
end
|
||||
end
|
||||
|
||||
class Write
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :current_document, as: 'currentDocument', class: Google::Apis::FirestoreV1beta1::Precondition, decorator: Google::Apis::FirestoreV1beta1::Precondition::Representation
|
||||
|
||||
property :delete, as: 'delete'
|
||||
property :transform, as: 'transform', class: Google::Apis::FirestoreV1beta1::DocumentTransform, decorator: Google::Apis::FirestoreV1beta1::DocumentTransform::Representation
|
||||
|
||||
property :update, as: 'update', class: Google::Apis::FirestoreV1beta1::Document, decorator: Google::Apis::FirestoreV1beta1::Document::Representation
|
||||
|
||||
property :update_mask, as: 'updateMask', class: Google::Apis::FirestoreV1beta1::DocumentMask, decorator: Google::Apis::FirestoreV1beta1::DocumentMask::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class WriteRequest
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
hash :labels, as: 'labels'
|
||||
property :stream_id, as: 'streamId'
|
||||
property :stream_token, :base64 => true, as: 'streamToken'
|
||||
collection :writes, as: 'writes', class: Google::Apis::FirestoreV1beta1::Write, decorator: Google::Apis::FirestoreV1beta1::Write::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class WriteResponse
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :commit_time, as: 'commitTime'
|
||||
property :stream_id, as: 'streamId'
|
||||
property :stream_token, :base64 => true, as: 'streamToken'
|
||||
collection :write_results, as: 'writeResults', class: Google::Apis::FirestoreV1beta1::WriteResult, decorator: Google::Apis::FirestoreV1beta1::WriteResult::Representation
|
||||
|
||||
end
|
||||
end
|
||||
|
||||
class WriteResult
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
collection :transform_results, as: 'transformResults', class: Google::Apis::FirestoreV1beta1::Value, decorator: Google::Apis::FirestoreV1beta1::Value::Representation
|
||||
|
||||
property :update_time, as: 'updateTime'
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,734 @@
|
||||
# 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 '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 FirestoreV1beta1
|
||||
# Google Cloud Firestore API
|
||||
#
|
||||
#
|
||||
#
|
||||
# @example
|
||||
# require 'google/apis/firestore_v1beta1'
|
||||
#
|
||||
# Firestore = Google::Apis::FirestoreV1beta1 # Alias the module
|
||||
# service = Firestore::FirestoreService.new
|
||||
#
|
||||
# @see https://cloud.google.com/firestore
|
||||
class FirestoreService < Google::Apis::Core::BaseService
|
||||
# @return [String]
|
||||
# API key. Your API key identifies your project and provides you with API access,
|
||||
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
||||
attr_accessor :key
|
||||
|
||||
# @return [String]
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
attr_accessor :quota_user
|
||||
|
||||
def initialize
|
||||
super('https://firestore.googleapis.com/', '')
|
||||
@batch_path = 'batch'
|
||||
end
|
||||
|
||||
# Gets multiple documents.
|
||||
# Documents returned by this method are not guaranteed to be returned in the
|
||||
# same order that they were requested.
|
||||
# @param [String] database
|
||||
# The database name. In the format:
|
||||
# `projects/`project_id`/databases/`database_id``.
|
||||
# @param [Google::Apis::FirestoreV1beta1::BatchGetDocumentsRequest] batch_get_documents_request_object
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::BatchGetDocumentsResponse] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::BatchGetDocumentsResponse]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def batch_get_documents(database, batch_get_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:post, 'v1beta1/{+database}/documents:batchGet', options)
|
||||
command.request_representation = Google::Apis::FirestoreV1beta1::BatchGetDocumentsRequest::Representation
|
||||
command.request_object = batch_get_documents_request_object
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::BatchGetDocumentsResponse::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::BatchGetDocumentsResponse
|
||||
command.params['database'] = database unless database.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Starts a new transaction.
|
||||
# @param [String] database
|
||||
# The database name. In the format:
|
||||
# `projects/`project_id`/databases/`database_id``.
|
||||
# @param [Google::Apis::FirestoreV1beta1::BeginTransactionRequest] begin_transaction_request_object
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::BeginTransactionResponse] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::BeginTransactionResponse]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def begin_document_transaction(database, begin_transaction_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:post, 'v1beta1/{+database}/documents:beginTransaction', options)
|
||||
command.request_representation = Google::Apis::FirestoreV1beta1::BeginTransactionRequest::Representation
|
||||
command.request_object = begin_transaction_request_object
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::BeginTransactionResponse::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::BeginTransactionResponse
|
||||
command.params['database'] = database unless database.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Commits a transaction, while optionally updating documents.
|
||||
# @param [String] database
|
||||
# The database name. In the format:
|
||||
# `projects/`project_id`/databases/`database_id``.
|
||||
# @param [Google::Apis::FirestoreV1beta1::CommitRequest] commit_request_object
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::CommitResponse] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::CommitResponse]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def commit_document(database, commit_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:post, 'v1beta1/{+database}/documents:commit', options)
|
||||
command.request_representation = Google::Apis::FirestoreV1beta1::CommitRequest::Representation
|
||||
command.request_object = commit_request_object
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::CommitResponse::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::CommitResponse
|
||||
command.params['database'] = database unless database.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Creates a new document.
|
||||
# @param [String] parent
|
||||
# The parent resource. For example:
|
||||
# `projects/`project_id`/databases/`database_id`/documents` or
|
||||
# `projects/`project_id`/databases/`database_id`/documents/chatrooms/`
|
||||
# chatroom_id``
|
||||
# @param [String] collection_id
|
||||
# The collection ID, relative to `parent`, to list. For example: `chatrooms`.
|
||||
# @param [Google::Apis::FirestoreV1beta1::Document] document_object
|
||||
# @param [String] document_id
|
||||
# The client-assigned document ID to use for this document.
|
||||
# Optional. If not specified, an ID will be assigned by the service.
|
||||
# @param [Array<String>, String] mask_field_paths
|
||||
# The list of field paths in the mask. See Document.fields for a field
|
||||
# path syntax reference.
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::Document] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::Document]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def create_project_database_document_document(parent, collection_id, document_object = nil, document_id: nil, mask_field_paths: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:post, 'v1beta1/{+parent}/{collectionId}', options)
|
||||
command.request_representation = Google::Apis::FirestoreV1beta1::Document::Representation
|
||||
command.request_object = document_object
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::Document::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::Document
|
||||
command.params['parent'] = parent unless parent.nil?
|
||||
command.params['collectionId'] = collection_id unless collection_id.nil?
|
||||
command.query['documentId'] = document_id unless document_id.nil?
|
||||
command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Deletes a document.
|
||||
# @param [String] name
|
||||
# The resource name of the Document to delete. In the format:
|
||||
# `projects/`project_id`/databases/`database_id`/documents/`document_path``.
|
||||
# @param [Boolean] current_document_exists
|
||||
# When set to `true`, the target document must exist.
|
||||
# When set to `false`, the target document must not exist.
|
||||
# @param [String] current_document_update_time
|
||||
# When set, the target document must exist and have been last updated at
|
||||
# that time.
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::Empty] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::Empty]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def delete_project_database_document(name, current_document_exists: nil, current_document_update_time: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::Empty::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::Empty
|
||||
command.params['name'] = name unless name.nil?
|
||||
command.query['currentDocument.exists'] = current_document_exists unless current_document_exists.nil?
|
||||
command.query['currentDocument.updateTime'] = current_document_update_time unless current_document_update_time.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Gets a single document.
|
||||
# @param [String] name
|
||||
# The resource name of the Document to get. In the format:
|
||||
# `projects/`project_id`/databases/`database_id`/documents/`document_path``.
|
||||
# @param [Array<String>, String] mask_field_paths
|
||||
# The list of field paths in the mask. See Document.fields for a field
|
||||
# path syntax reference.
|
||||
# @param [String] read_time
|
||||
# Reads the version of the document at the given time.
|
||||
# This may not be older than 60 seconds.
|
||||
# @param [String] transaction
|
||||
# Reads the document in a transaction.
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::Document] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::Document]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def get_project_database_document(name, mask_field_paths: nil, read_time: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::Document::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::Document
|
||||
command.params['name'] = name unless name.nil?
|
||||
command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
|
||||
command.query['readTime'] = read_time unless read_time.nil?
|
||||
command.query['transaction'] = transaction unless transaction.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Lists documents.
|
||||
# @param [String] parent
|
||||
# The parent resource name. In the format:
|
||||
# `projects/`project_id`/databases/`database_id`/documents` or
|
||||
# `projects/`project_id`/databases/`database_id`/documents/`document_path``.
|
||||
# For example:
|
||||
# `projects/my-project/databases/my-database/documents` or
|
||||
# `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
|
||||
# @param [String] collection_id
|
||||
# The collection ID, relative to `parent`, to list. For example: `chatrooms`
|
||||
# or `messages`.
|
||||
# @param [Array<String>, String] mask_field_paths
|
||||
# The list of field paths in the mask. See Document.fields for a field
|
||||
# path syntax reference.
|
||||
# @param [String] order_by
|
||||
# The order to sort results by. For example: `priority desc, name`.
|
||||
# @param [Fixnum] page_size
|
||||
# The maximum number of documents to return.
|
||||
# @param [String] page_token
|
||||
# The `next_page_token` value returned from a previous List request, if any.
|
||||
# @param [String] read_time
|
||||
# Reads documents as they were at the given time.
|
||||
# This may not be older than 60 seconds.
|
||||
# @param [Boolean] show_missing
|
||||
# If the list should show missing documents. A missing document is a
|
||||
# document that does not exist but has sub-documents. These documents will
|
||||
# be returned with a key but will not have fields, Document.create_time,
|
||||
# or Document.update_time set.
|
||||
# Requests with `show_missing` may not specify `where` or
|
||||
# `order_by`.
|
||||
# @param [String] transaction
|
||||
# Reads documents in a transaction.
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::ListDocumentsResponse] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::ListDocumentsResponse]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def list_project_database_documents(parent, collection_id, mask_field_paths: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:get, 'v1beta1/{+parent}/{collectionId}', options)
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::ListDocumentsResponse::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::ListDocumentsResponse
|
||||
command.params['parent'] = parent unless parent.nil?
|
||||
command.params['collectionId'] = collection_id unless collection_id.nil?
|
||||
command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
|
||||
command.query['orderBy'] = order_by unless order_by.nil?
|
||||
command.query['pageSize'] = page_size unless page_size.nil?
|
||||
command.query['pageToken'] = page_token unless page_token.nil?
|
||||
command.query['readTime'] = read_time unless read_time.nil?
|
||||
command.query['showMissing'] = show_missing unless show_missing.nil?
|
||||
command.query['transaction'] = transaction unless transaction.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Lists all the collection IDs underneath a document.
|
||||
# @param [String] parent
|
||||
# The parent document. In the format:
|
||||
# `projects/`project_id`/databases/`database_id`/documents/`document_path``.
|
||||
# For example:
|
||||
# `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
|
||||
# @param [Fixnum] page_size
|
||||
# The maximum number of results to return.
|
||||
# @param [String] page_token
|
||||
# A page token. Must be a value from
|
||||
# ListCollectionIdsResponse.
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::ListCollectionIdsResponse] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::ListCollectionIdsResponse]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def list_project_database_document_collection_ids(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:post, 'v1beta1/{+parent}:listCollectionIds', options)
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::ListCollectionIdsResponse::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::ListCollectionIdsResponse
|
||||
command.params['parent'] = parent unless parent.nil?
|
||||
command.query['pageSize'] = page_size unless page_size.nil?
|
||||
command.query['pageToken'] = page_token unless page_token.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Listens to changes.
|
||||
# @param [String] database
|
||||
# The database name. In the format:
|
||||
# `projects/`project_id`/databases/`database_id``.
|
||||
# @param [Google::Apis::FirestoreV1beta1::ListenRequest] listen_request_object
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::ListenResponse] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::ListenResponse]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def listen_document(database, listen_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:post, 'v1beta1/{+database}/documents:listen', options)
|
||||
command.request_representation = Google::Apis::FirestoreV1beta1::ListenRequest::Representation
|
||||
command.request_object = listen_request_object
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::ListenResponse::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::ListenResponse
|
||||
command.params['database'] = database unless database.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Updates or inserts a document.
|
||||
# @param [String] name
|
||||
# The resource name of the document, for example
|
||||
# `projects/`project_id`/databases/`database_id`/documents/`document_path``.
|
||||
# @param [Google::Apis::FirestoreV1beta1::Document] document_object
|
||||
# @param [Boolean] current_document_exists
|
||||
# When set to `true`, the target document must exist.
|
||||
# When set to `false`, the target document must not exist.
|
||||
# @param [String] current_document_update_time
|
||||
# When set, the target document must exist and have been last updated at
|
||||
# that time.
|
||||
# @param [Array<String>, String] mask_field_paths
|
||||
# The list of field paths in the mask. See Document.fields for a field
|
||||
# path syntax reference.
|
||||
# @param [Array<String>, String] update_mask_field_paths
|
||||
# The list of field paths in the mask. See Document.fields for a field
|
||||
# path syntax reference.
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::Document] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::Document]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def patch_project_database_document(name, document_object = nil, current_document_exists: nil, current_document_update_time: nil, mask_field_paths: nil, update_mask_field_paths: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
|
||||
command.request_representation = Google::Apis::FirestoreV1beta1::Document::Representation
|
||||
command.request_object = document_object
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::Document::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::Document
|
||||
command.params['name'] = name unless name.nil?
|
||||
command.query['currentDocument.exists'] = current_document_exists unless current_document_exists.nil?
|
||||
command.query['currentDocument.updateTime'] = current_document_update_time unless current_document_update_time.nil?
|
||||
command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
|
||||
command.query['updateMask.fieldPaths'] = update_mask_field_paths unless update_mask_field_paths.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Rolls back a transaction.
|
||||
# @param [String] database
|
||||
# The database name. In the format:
|
||||
# `projects/`project_id`/databases/`database_id``.
|
||||
# @param [Google::Apis::FirestoreV1beta1::RollbackRequest] rollback_request_object
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::Empty] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::Empty]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def rollback_document(database, rollback_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:post, 'v1beta1/{+database}/documents:rollback', options)
|
||||
command.request_representation = Google::Apis::FirestoreV1beta1::RollbackRequest::Representation
|
||||
command.request_object = rollback_request_object
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::Empty::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::Empty
|
||||
command.params['database'] = database unless database.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Runs a query.
|
||||
# @param [String] parent
|
||||
# The parent resource name. In the format:
|
||||
# `projects/`project_id`/databases/`database_id`/documents` or
|
||||
# `projects/`project_id`/databases/`database_id`/documents/`document_path``.
|
||||
# For example:
|
||||
# `projects/my-project/databases/my-database/documents` or
|
||||
# `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
|
||||
# @param [Google::Apis::FirestoreV1beta1::RunQueryRequest] run_query_request_object
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::RunQueryResponse] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::RunQueryResponse]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def run_document_query(parent, run_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:post, 'v1beta1/{+parent}:runQuery', options)
|
||||
command.request_representation = Google::Apis::FirestoreV1beta1::RunQueryRequest::Representation
|
||||
command.request_object = run_query_request_object
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::RunQueryResponse::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::RunQueryResponse
|
||||
command.params['parent'] = parent unless parent.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Streams batches of document updates and deletes, in order.
|
||||
# @param [String] database
|
||||
# The database name. In the format:
|
||||
# `projects/`project_id`/databases/`database_id``.
|
||||
# This is only required in the first message.
|
||||
# @param [Google::Apis::FirestoreV1beta1::WriteRequest] write_request_object
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::WriteResponse] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::WriteResponse]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def write_document(database, write_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:post, 'v1beta1/{+database}/documents:write', options)
|
||||
command.request_representation = Google::Apis::FirestoreV1beta1::WriteRequest::Representation
|
||||
command.request_object = write_request_object
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::WriteResponse::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::WriteResponse
|
||||
command.params['database'] = database unless database.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Creates the specified index.
|
||||
# A newly created index's initial state is `CREATING`. On completion of the
|
||||
# returned google.longrunning.Operation, the state will be `READY`.
|
||||
# If the index already exists, the call will return an `ALREADY_EXISTS`
|
||||
# status.
|
||||
# During creation, the process could result in an error, in which case the
|
||||
# index will move to the `ERROR` state. The process can be recovered by
|
||||
# fixing the data that caused the error, removing the index with
|
||||
# delete, then re-creating the index with
|
||||
# create.
|
||||
# Indexes with a single field cannot be created.
|
||||
# @param [String] parent
|
||||
# The name of the database this index will apply to. For example:
|
||||
# `projects/`project_id`/databases/`database_id``
|
||||
# @param [Google::Apis::FirestoreV1beta1::Index] index_object
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::Operation] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::Operation]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def create_project_database_index(parent, index_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:post, 'v1beta1/{+parent}/indexes', options)
|
||||
command.request_representation = Google::Apis::FirestoreV1beta1::Index::Representation
|
||||
command.request_object = index_object
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::Operation::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::Operation
|
||||
command.params['parent'] = parent unless parent.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Deletes an index.
|
||||
# @param [String] name
|
||||
# The index name. For example:
|
||||
# `projects/`project_id`/databases/`database_id`/indexes/`index_id``
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::Empty] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::Empty]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def delete_project_database_index(name, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::Empty::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::Empty
|
||||
command.params['name'] = name unless name.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Gets an index.
|
||||
# @param [String] name
|
||||
# The name of the index. For example:
|
||||
# `projects/`project_id`/databases/`database_id`/indexes/`index_id``
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::Index] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::Index]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def get_project_database_index(name, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::Index::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::Index
|
||||
command.params['name'] = name unless name.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Lists the indexes that match the specified filters.
|
||||
# @param [String] parent
|
||||
# The database name. For example:
|
||||
# `projects/`project_id`/databases/`database_id``
|
||||
# @param [String] filter
|
||||
# @param [Fixnum] page_size
|
||||
# The standard List page size.
|
||||
# @param [String] page_token
|
||||
# The standard List page token.
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::FirestoreV1beta1::ListIndexesResponse] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::FirestoreV1beta1::ListIndexesResponse]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def list_project_database_indexes(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:get, 'v1beta1/{+parent}/indexes', options)
|
||||
command.response_representation = Google::Apis::FirestoreV1beta1::ListIndexesResponse::Representation
|
||||
command.response_class = Google::Apis::FirestoreV1beta1::ListIndexesResponse
|
||||
command.params['parent'] = parent unless parent.nil?
|
||||
command.query['filter'] = filter unless filter.nil?
|
||||
command.query['pageSize'] = page_size unless page_size.nil?
|
||||
command.query['pageToken'] = page_token unless page_token.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
protected
|
||||
|
||||
def apply_command_defaults(command)
|
||||
command.query['key'] = key unless key.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -25,7 +25,7 @@ module Google
|
||||
# @see https://developers.google.com/identity-toolkit/v3/
|
||||
module IdentitytoolkitV3
|
||||
VERSION = 'V3'
|
||||
REVISION = '20170828'
|
||||
REVISION = '20170927'
|
||||
|
||||
# View and manage your data across Google Cloud Platform services
|
||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||
|
||||
@@ -69,6 +69,11 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :session_id
|
||||
|
||||
# All sign-in methods this user has used.
|
||||
# Corresponds to the JSON property `signinMethods`
|
||||
# @return [Array<String>]
|
||||
attr_accessor :signin_methods
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
@@ -83,6 +88,7 @@ module Google
|
||||
@provider_id = args[:provider_id] if args.key?(:provider_id)
|
||||
@registered = args[:registered] if args.key?(:registered)
|
||||
@session_id = args[:session_id] if args.key?(:session_id)
|
||||
@signin_methods = args[:signin_methods] if args.key?(:signin_methods)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -137,6 +143,62 @@ module Google
|
||||
end
|
||||
end
|
||||
|
||||
# Response of email signIn.
|
||||
class EmailLinkSigninResponse
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The user's email.
|
||||
# Corresponds to the JSON property `email`
|
||||
# @return [String]
|
||||
attr_accessor :email
|
||||
|
||||
# Expiration time of STS id token in seconds.
|
||||
# Corresponds to the JSON property `expiresIn`
|
||||
# @return [Fixnum]
|
||||
attr_accessor :expires_in
|
||||
|
||||
# The STS id token to login the newly signed in user.
|
||||
# Corresponds to the JSON property `idToken`
|
||||
# @return [String]
|
||||
attr_accessor :id_token
|
||||
|
||||
# Whether the user is new.
|
||||
# Corresponds to the JSON property `isNewUser`
|
||||
# @return [Boolean]
|
||||
attr_accessor :is_new_user
|
||||
alias_method :is_new_user?, :is_new_user
|
||||
|
||||
# The fixed string "identitytoolkit#EmailLinkSigninResponse".
|
||||
# Corresponds to the JSON property `kind`
|
||||
# @return [String]
|
||||
attr_accessor :kind
|
||||
|
||||
# The RP local ID of the user.
|
||||
# Corresponds to the JSON property `localId`
|
||||
# @return [String]
|
||||
attr_accessor :local_id
|
||||
|
||||
# The refresh token for the signed in user.
|
||||
# Corresponds to the JSON property `refreshToken`
|
||||
# @return [String]
|
||||
attr_accessor :refresh_token
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@email = args[:email] if args.key?(:email)
|
||||
@expires_in = args[:expires_in] if args.key?(:expires_in)
|
||||
@id_token = args[:id_token] if args.key?(:id_token)
|
||||
@is_new_user = args[:is_new_user] if args.key?(:is_new_user)
|
||||
@kind = args[:kind] if args.key?(:kind)
|
||||
@local_id = args[:local_id] if args.key?(:local_id)
|
||||
@refresh_token = args[:refresh_token] if args.key?(:refresh_token)
|
||||
end
|
||||
end
|
||||
|
||||
# Template for an email template.
|
||||
class EmailTemplate
|
||||
include Google::Apis::Core::Hashable
|
||||
@@ -451,6 +513,37 @@ module Google
|
||||
end
|
||||
end
|
||||
|
||||
# Request to sign in with email.
|
||||
class IdentitytoolkitRelyingpartyEmailLinkSigninRequest
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
# The email address of the user.
|
||||
# Corresponds to the JSON property `email`
|
||||
# @return [String]
|
||||
attr_accessor :email
|
||||
|
||||
# Token for linking flow.
|
||||
# Corresponds to the JSON property `idToken`
|
||||
# @return [String]
|
||||
attr_accessor :id_token
|
||||
|
||||
# The confirmation code.
|
||||
# Corresponds to the JSON property `oobCode`
|
||||
# @return [String]
|
||||
attr_accessor :oob_code
|
||||
|
||||
def initialize(**args)
|
||||
update!(**args)
|
||||
end
|
||||
|
||||
# Update properties of this object
|
||||
def update!(**args)
|
||||
@email = args[:email] if args.key?(:email)
|
||||
@id_token = args[:id_token] if args.key?(:id_token)
|
||||
@oob_code = args[:oob_code] if args.key?(:oob_code)
|
||||
end
|
||||
end
|
||||
|
||||
# Request to get the account information.
|
||||
class GetAccountInfoRequest
|
||||
include Google::Apis::Core::Hashable
|
||||
|
||||
@@ -40,6 +40,12 @@ module Google
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class EmailLinkSigninResponse
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class EmailTemplate
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
@@ -82,6 +88,12 @@ module Google
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class IdentitytoolkitRelyingpartyEmailLinkSigninRequest
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
include Google::Apis::Core::JsonObjectSupport
|
||||
end
|
||||
|
||||
class GetAccountInfoRequest
|
||||
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||
|
||||
@@ -273,6 +285,7 @@ module Google
|
||||
property :provider_id, as: 'providerId'
|
||||
property :registered, as: 'registered'
|
||||
property :session_id, as: 'sessionId'
|
||||
collection :signin_methods, as: 'signinMethods'
|
||||
end
|
||||
end
|
||||
|
||||
@@ -293,6 +306,19 @@ module Google
|
||||
end
|
||||
end
|
||||
|
||||
class EmailLinkSigninResponse
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :email, as: 'email'
|
||||
property :expires_in, :numeric_string => true, as: 'expiresIn'
|
||||
property :id_token, as: 'idToken'
|
||||
property :is_new_user, as: 'isNewUser'
|
||||
property :kind, as: 'kind'
|
||||
property :local_id, as: 'localId'
|
||||
property :refresh_token, as: 'refreshToken'
|
||||
end
|
||||
end
|
||||
|
||||
class EmailTemplate
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
@@ -371,6 +397,15 @@ module Google
|
||||
end
|
||||
end
|
||||
|
||||
class IdentitytoolkitRelyingpartyEmailLinkSigninRequest
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
property :email, as: 'email'
|
||||
property :id_token, as: 'idToken'
|
||||
property :oob_code, as: 'oobCode'
|
||||
end
|
||||
end
|
||||
|
||||
class GetAccountInfoRequest
|
||||
# @private
|
||||
class Representation < Google::Apis::Core::JsonRepresentation
|
||||
|
||||
@@ -158,6 +158,41 @@ module Google
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Reset password for a user.
|
||||
# @param [Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyEmailLinkSigninRequest] identitytoolkit_relyingparty_email_link_signin_request_object
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# Overrides userIp if both are provided.
|
||||
# @param [String] user_ip
|
||||
# IP address of the site where the request originates. Use this if you want to
|
||||
# enforce per-user limits.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::IdentitytoolkitV3::EmailLinkSigninResponse] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::IdentitytoolkitV3::EmailLinkSigninResponse]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def email_relyingparty_link_signin(identitytoolkit_relyingparty_email_link_signin_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
||||
command = make_simple_command(:post, 'emailLinkSignin', options)
|
||||
command.request_representation = Google::Apis::IdentitytoolkitV3::IdentitytoolkitRelyingpartyEmailLinkSigninRequest::Representation
|
||||
command.request_object = identitytoolkit_relyingparty_email_link_signin_request_object
|
||||
command.response_representation = Google::Apis::IdentitytoolkitV3::EmailLinkSigninResponse::Representation
|
||||
command.response_class = Google::Apis::IdentitytoolkitV3::EmailLinkSigninResponse
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
command.query['userIp'] = user_ip unless user_ip.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Returns the account info.
|
||||
# @param [Google::Apis::IdentitytoolkitV3::GetAccountInfoRequest] get_account_info_request_object
|
||||
# @param [String] fields
|
||||
|
||||
@@ -25,7 +25,7 @@ module Google
|
||||
# @see https://cloud.google.com/ml/
|
||||
module MlV1
|
||||
VERSION = 'V1'
|
||||
REVISION = '20170926'
|
||||
REVISION = '20170928'
|
||||
|
||||
# View and manage your data across Google Cloud Platform services
|
||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||
|
||||
@@ -541,6 +541,59 @@ module Google
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Updates a specific model resource.
|
||||
# Currently the only supported fields to update are `description` and
|
||||
# `default_version.name`.
|
||||
# @param [String] name
|
||||
# Required. The project name.
|
||||
# @param [Google::Apis::MlV1::GoogleCloudMlV1Model] google_cloud_ml_v1__model_object
|
||||
# @param [String] update_mask
|
||||
# Required. Specifies the path, relative to `Model`, of the field to update.
|
||||
# For example, to change the description of a model to "foo" and set its
|
||||
# default version to "version_1", the `update_mask` parameter would be
|
||||
# specified as `description`, `default_version.name`, and the `PATCH`
|
||||
# request body would specify the new value, as follows:
|
||||
# `
|
||||
# "description": "foo",
|
||||
# "defaultVersion": `
|
||||
# "name":"version_1"
|
||||
# `
|
||||
# `
|
||||
# In this example, the model is blindly overwritten since no etag is given.
|
||||
# To adopt etag mechanism, include `etag` field in the mask, and include the
|
||||
# `etag` value in your model resource.
|
||||
# Currently the supported update masks are `description`,
|
||||
# `default_version.name`, `labels`, and `etag`.
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::MlV1::GoogleLongrunningOperation] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::MlV1::GoogleLongrunningOperation]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def patch_project_model(name, google_cloud_ml_v1__model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:patch, 'v1/{+name}', options)
|
||||
command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1Model::Representation
|
||||
command.request_object = google_cloud_ml_v1__model_object
|
||||
command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation
|
||||
command.response_class = Google::Apis::MlV1::GoogleLongrunningOperation
|
||||
command.params['name'] = name unless name.nil?
|
||||
command.query['updateMask'] = update_mask unless update_mask.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Sets the access control policy on the specified resource. Replaces any
|
||||
# existing policy.
|
||||
# @param [String] resource
|
||||
@@ -771,6 +824,55 @@ module Google
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Updates the specified Version resource.
|
||||
# Currently the only supported field to update is `description`.
|
||||
# @param [String] name
|
||||
# Required. The name of the model.
|
||||
# @param [Google::Apis::MlV1::GoogleCloudMlV1Version] google_cloud_ml_v1__version_object
|
||||
# @param [String] update_mask
|
||||
# Required. Specifies the path, relative to `Version`, of the field to
|
||||
# update. Must be present and non-empty.
|
||||
# For example, to change the description of a version to "foo", the
|
||||
# `update_mask` parameter would be specified as `description`, and the
|
||||
# `PATCH` request body would specify the new value, as follows:
|
||||
# `
|
||||
# "description": "foo"
|
||||
# `
|
||||
# In this example, the version is blindly overwritten since no etag is given.
|
||||
# To adopt etag mechanism, include `etag` field in the mask, and include the
|
||||
# `etag` value in your version resource.
|
||||
# Currently the only supported update masks are `description`, `labels`, and
|
||||
# `etag`.
|
||||
# @param [String] fields
|
||||
# Selector specifying which fields to include in a partial response.
|
||||
# @param [String] quota_user
|
||||
# Available to use for quota purposes for server-side applications. Can be any
|
||||
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
||||
# @param [Google::Apis::RequestOptions] options
|
||||
# Request-specific options
|
||||
#
|
||||
# @yield [result, err] Result & error if block supplied
|
||||
# @yieldparam result [Google::Apis::MlV1::GoogleLongrunningOperation] parsed result object
|
||||
# @yieldparam err [StandardError] error object if request failed
|
||||
#
|
||||
# @return [Google::Apis::MlV1::GoogleLongrunningOperation]
|
||||
#
|
||||
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
||||
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
||||
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
||||
def patch_project_model_version(name, google_cloud_ml_v1__version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||
command = make_simple_command(:patch, 'v1/{+name}', options)
|
||||
command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1Version::Representation
|
||||
command.request_object = google_cloud_ml_v1__version_object
|
||||
command.response_representation = Google::Apis::MlV1::GoogleLongrunningOperation::Representation
|
||||
command.response_class = Google::Apis::MlV1::GoogleLongrunningOperation
|
||||
command.params['name'] = name unless name.nil?
|
||||
command.query['updateMask'] = update_mask unless update_mask.nil?
|
||||
command.query['fields'] = fields unless fields.nil?
|
||||
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||||
execute_or_queue_command(command, &block)
|
||||
end
|
||||
|
||||
# Designates a version to be the default for the model.
|
||||
# The default version is used for prediction requests made against the model
|
||||
# that don't specify a version.
|
||||
|
||||
@@ -25,7 +25,7 @@ module Google
|
||||
# @see https://developers.google.com/beacons/proximity/
|
||||
module ProximitybeaconV1beta1
|
||||
VERSION = 'V1beta1'
|
||||
REVISION = '20170815'
|
||||
REVISION = '20171003'
|
||||
|
||||
# View and modify your beacons
|
||||
AUTH_USERLOCATION_BEACON_REGISTRY = 'https://www.googleapis.com/auth/userlocation.beacon.registry'
|
||||
|
||||
@@ -266,6 +266,22 @@ module Google
|
||||
# @return [String]
|
||||
attr_accessor :data
|
||||
|
||||
# The distance away from the beacon at which this attachment should be
|
||||
# delivered to a mobile app.
|
||||
# Setting this to a value greater than zero indicates that the app should
|
||||
# behave as if the beacon is "seen" when the mobile device is less than this
|
||||
# distance away from the beacon.
|
||||
# Different attachments on the same beacon can have different max distances.
|
||||
# Note that even though this value is expressed with fractional meter
|
||||
# precision, real-world behavior is likley to be much less precise than one
|
||||
# meter, due to the nature of current Bluetooth radio technology.
|
||||
# Optional. When not set or zero, the attachment should be delivered at the
|
||||
# beacon's outer limit of detection.
|
||||
# Negative values are invalid and return an error.
|
||||
# Corresponds to the JSON property `maxDistanceMeters`
|
||||
# @return [Float]
|
||||
attr_accessor :max_distance_meters
|
||||
|
||||
# Specifies what kind of attachment this is. Tells a client how to
|
||||
# interpret the `data` field. Format is <var>namespace/type</var>. Namespace
|
||||
# provides type separation between clients. Type describes the type of
|
||||
@@ -284,6 +300,7 @@ module Google
|
||||
@attachment_name = args[:attachment_name] if args.key?(:attachment_name)
|
||||
@creation_time_ms = args[:creation_time_ms] if args.key?(:creation_time_ms)
|
||||
@data = args[:data] if args.key?(:data)
|
||||
@max_distance_meters = args[:max_distance_meters] if args.key?(:max_distance_meters)
|
||||
@namespaced_type = args[:namespaced_type] if args.key?(:namespaced_type)
|
||||
end
|
||||
end
|
||||
|
||||
@@ -191,6 +191,7 @@ module Google
|
||||
property :attachment_name, as: 'attachmentName'
|
||||
property :creation_time_ms, as: 'creationTimeMs'
|
||||
property :data, :base64 => true, as: 'data'
|
||||
property :max_distance_meters, as: 'maxDistanceMeters'
|
||||
property :namespaced_type, as: 'namespacedType'
|
||||
end
|
||||
end
|
||||
|
||||
Reference in new issue
Block a user