Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1Argon2Parameters

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

Overview

The parameters for Argon2 hashing algorithm.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1Argon2Parameters

Returns a new instance of GoogleCloudIdentitytoolkitV1Argon2Parameters.



69
70
71
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 69

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

Instance Attribute Details

#associated_data ⇒ String

The additional associated data, if provided, is appended to the hash value to provide an additional layer of security. A base64-encoded string if specified via JSON. Corresponds to the JSON property associatedData NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


35
36
37
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 35

def associated_data
  @associated_data
end

#hash_length_bytes ⇒ Fixnum

Required. The desired hash length in bytes. Minimum is 4 and maximum is 1024. Corresponds to the JSON property hashLengthBytes

Returns:

  • (Fixnum) 


40
41
42
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 40

def hash_length_bytes
  @hash_length_bytes
end

#hash_type ⇒ String

Required. Must not be HASH_TYPE_UNSPECIFIED. Corresponds to the JSON property hashType

Returns:

  • (String) 


45
46
47
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 45

def hash_type
  @hash_type
end

#iterations ⇒ Fixnum

Required. The number of iterations to perform. Minimum is 1, maximum is 16. Corresponds to the JSON property iterations

Returns:

  • (Fixnum) 


50
51
52
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 50

def iterations
  @iterations
end

#memory_cost_kib ⇒ Fixnum

Required. The memory cost in kibibytes. Maximum is 32768. Corresponds to the JSON property memoryCostKib

Returns:

  • (Fixnum) 


55
56
57
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 55

def memory_cost_kib
  @memory_cost_kib
end

#parallelism ⇒ Fixnum

Required. The degree of parallelism, also called threads or lanes. Minimum is 1, maximum is 16. Corresponds to the JSON property parallelism

Returns:

  • (Fixnum) 


61
62
63
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 61

def parallelism
  @parallelism
end

#version ⇒ String

The version of the Argon2 algorithm. This defaults to VERSION_13 if not specified. Corresponds to the JSON property version

Returns:

  • (String) 


67
68
69
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 67

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



74
75
76
77
78
79
80
81
82
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 74

def update!(**args)
  @associated_data = args[:associated_data] if args.key?(:associated_data)
  @hash_length_bytes = args[:hash_length_bytes] if args.key?(:hash_length_bytes)
  @hash_type = args[:hash_type] if args.key?(:hash_type)
  @iterations = args[:iterations] if args.key?(:iterations)
  @memory_cost_kib = args[:memory_cost_kib] if args.key?(:memory_cost_kib)
  @parallelism = args[:parallelism] if args.key?(:parallelism)
  @version = args[:version] if args.key?(:version)
end