Class: Google::Apis::IdentitytoolkitV3::UploadAccountRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/identitytoolkit_v3/classes.rb,
generated/google/apis/identitytoolkit_v3/representations.rb,
generated/google/apis/identitytoolkit_v3/representations.rb

Overview

Request to upload user account in batch.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ UploadAccountRequest

Returns a new instance of UploadAccountRequest



1242
1243
1244
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1242

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allow_overwrite ⇒ Boolean Also known as: allow_overwrite?

Whether allow overwrite existing account when user local_id exists. Corresponds to the JSON property allowOverwrite

Returns:

  • (Boolean) 


1168
1169
1170
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1168

def allow_overwrite
  @allow_overwrite
end

#block_size ⇒ Fixnum

Corresponds to the JSON property blockSize

Returns:

  • (Fixnum) 


1174
1175
1176
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1174

def block_size
  @block_size
end

#cpu_mem_cost ⇒ Fixnum

The following 4 fields are for standard scrypt algorithm. Corresponds to the JSON property cpuMemCost

Returns:

  • (Fixnum) 


1179
1180
1181
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1179

def cpu_mem_cost
  @cpu_mem_cost
end

#delegated_project_number ⇒ Fixnum

GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. Corresponds to the JSON property delegatedProjectNumber

Returns:

  • (Fixnum) 


1185
1186
1187
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1185

def delegated_project_number
  @delegated_project_number
end

#dk_len ⇒ Fixnum

Corresponds to the JSON property dkLen

Returns:

  • (Fixnum) 


1190
1191
1192
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1190

def dk_len
  @dk_len
end

#hash_algorithm ⇒ String

The password hash algorithm. Corresponds to the JSON property hashAlgorithm

Returns:

  • (String) 


1195
1196
1197
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1195

def hash_algorithm
  @hash_algorithm
end

#memory_cost ⇒ Fixnum

Memory cost for hash calculation. Used by scrypt similar algorithms. Corresponds to the JSON property memoryCost

Returns:

  • (Fixnum) 


1200
1201
1202
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1200

def memory_cost
  @memory_cost
end

#parallelization ⇒ Fixnum

Corresponds to the JSON property parallelization

Returns:

  • (Fixnum) 


1205
1206
1207
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1205

def parallelization
  @parallelization
end

#rounds ⇒ Fixnum

Rounds for hash calculation. Used by scrypt and similar algorithms. Corresponds to the JSON property rounds

Returns:

  • (Fixnum) 


1210
1211
1212
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1210

def rounds
  @rounds
end

#salt_separator ⇒ String

The salt separator. Corresponds to the JSON property saltSeparator NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1216
1217
1218
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1216

def salt_separator
  @salt_separator
end

#sanity_check ⇒ Boolean Also known as: sanity_check?

If true, backend will do sanity check(including duplicate email and federated id) when uploading account. Corresponds to the JSON property sanityCheck

Returns:

  • (Boolean) 


1222
1223
1224
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1222

def sanity_check
  @sanity_check
end

#signer_key ⇒ String

The key for to hash the password. Corresponds to the JSON property signerKey NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1229
1230
1231
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1229

def signer_key
  @signer_key
end

#target_project_id ⇒ String

Specify which project (field value is actually project id) to operate. Only used when provided credential. Corresponds to the JSON property targetProjectId

Returns:

  • (String) 


1235
1236
1237
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1235

def target_project_id
  @target_project_id
end

#users ⇒ Array<Google::Apis::IdentitytoolkitV3::UserInfo>

The account info to be stored. Corresponds to the JSON property users

Returns:



1240
1241
1242
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1240

def users
  @users
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1247

def update!(**args)
  @allow_overwrite = args[:allow_overwrite] if args.key?(:allow_overwrite)
  @block_size = args[:block_size] if args.key?(:block_size)
  @cpu_mem_cost = args[:cpu_mem_cost] if args.key?(:cpu_mem_cost)
  @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number)
  @dk_len = args[:dk_len] if args.key?(:dk_len)
  @hash_algorithm = args[:hash_algorithm] if args.key?(:hash_algorithm)
  @memory_cost = args[:memory_cost] if args.key?(:memory_cost)
  @parallelization = args[:parallelization] if args.key?(:parallelization)
  @rounds = args[:rounds] if args.key?(:rounds)
  @salt_separator = args[:salt_separator] if args.key?(:salt_separator)
  @sanity_check = args[:sanity_check] if args.key?(:sanity_check)
  @signer_key = args[:signer_key] if args.key?(:signer_key)
  @target_project_id = args[:target_project_id] if args.key?(:target_project_id)
  @users = args[:users] if args.key?(:users)
end