Module: Google::Cloud::Firestore::V1beta1

Defined in:
lib/google/cloud/firestore/v1beta1.rb,
lib/google/cloud/firestore/v1beta1/doc/overview.rb,
lib/google/cloud/firestore/v1beta1/firestore_client.rb

Defined Under Namespace

Classes: FirestoreClient

Class Method Summary collapse

Class Method Details

.new(service_path: nil, port: nil, channel: nil, chan_creds: nil, updater_proc: nil, credentials: nil, scopes: nil, client_config: nil, timeout: nil, lib_name: nil, lib_version: nil) ⇒ Object

The Cloud Firestore service.

This service exposes several types of comparable timestamps:

  • +create_time+ - The time at which a document was created. Changes only when a document is deleted, then re-created. Increases in a strict monotonic fashion.
  • +update_time+ - The time at which a document was last updated. Changes every time a document is modified. Does not change when a write results in no modifications. Increases in a strict monotonic fashion.
  • +read_time+ - The time at which a particular state was observed. Used to denote a consistent snapshot of the database or the time at which a Document was observed to not exist.
  • +commit_time+ - The time at which the writes in a transaction were committed. Any read with an equal or greater +read_time+ is guaranteed to see the effects of the transaction.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) (defaults to: nil) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: nil) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) (defaults to: nil) —

    The default timeout, in seconds, for calls made through this client.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/google/cloud/firestore/v1beta1.rb', line 91

def self.new \
    service_path: nil,
    port: nil,
    channel: nil,
    chan_creds: nil,
    updater_proc: nil,
    credentials: nil,
    scopes: nil,
    client_config: nil,
    timeout: nil,
    lib_name: nil,
    lib_version: nil
  kwargs = {
    service_path: service_path,
    port: port,
    channel: channel,
    chan_creds: chan_creds,
    updater_proc: updater_proc,
    credentials: credentials,
    scopes: scopes,
    client_config: client_config,
    timeout: timeout,
    lib_name: lib_name,
    lib_version: lib_version
  }.select { |_, v| v != nil }
  Google::Cloud::Firestore::V1beta1::FirestoreClient.new(**kwargs)
end