Class: OCI::Bds::Models::CreateBdsApiKeyDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/bds/models/create_bds_api_key_details.rb

Overview

API key created on user's behalf.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateBdsApiKeyDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :user_id (String) —

    The value to assign to the #user_id property

  • :passphrase (String) —

    The value to assign to the #passphrase property

  • :default_region (String) —

    The value to assign to the #default_region property

  • :key_alias (String) —

    The value to assign to the #key_alias property



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/bds/models/create_bds_api_key_details.rb', line 65

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.user_id = attributes[:'userId'] if attributes[:'userId']

  raise 'You cannot provide both :userId and :user_id' if attributes.key?(:'userId') && attributes.key?(:'user_id')

  self.user_id = attributes[:'user_id'] if attributes[:'user_id']

  self.passphrase = attributes[:'passphrase'] if attributes[:'passphrase']

  self.default_region = attributes[:'defaultRegion'] if attributes[:'defaultRegion']

  raise 'You cannot provide both :defaultRegion and :default_region' if attributes.key?(:'defaultRegion') && attributes.key?(:'default_region')

  self.default_region = attributes[:'default_region'] if attributes[:'default_region']

  self.key_alias = attributes[:'keyAlias'] if attributes[:'keyAlias']

  raise 'You cannot provide both :keyAlias and :key_alias' if attributes.key?(:'keyAlias') && attributes.key?(:'key_alias')

  self.key_alias = attributes[:'key_alias'] if attributes[:'key_alias']
end

Instance Attribute Details

#default_region ⇒ String

The name of the region to establish the Object Storage endpoint. See docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/Region/ for additional information.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/bds/models/create_bds_api_key_details.rb', line 23

def default_region
  @default_region
end

#key_alias ⇒ String

[Required] User friendly identifier used to uniquely differentiate between different API keys associated with this Big Data Service cluster. Only ASCII alphanumeric characters with no spaces allowed.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/bds/models/create_bds_api_key_details.rb', line 29

def key_alias
  @key_alias
end

#passphrase ⇒ String

[Required] Base64 passphrase used to secure the private key which will be created on user behalf.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/bds/models/create_bds_api_key_details.rb', line 17

def passphrase
  @passphrase
end

#user_id ⇒ String

[Required] The OCID of the user for whom this new generated API key pair will be created.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/bds/models/create_bds_api_key_details.rb', line 13

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/bds/models/create_bds_api_key_details.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'user_id': :'userId',
    'passphrase': :'passphrase',
    'default_region': :'defaultRegion',
    'key_alias': :'keyAlias'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/bds/models/create_bds_api_key_details.rb', line 44

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'user_id': :'String',
    'passphrase': :'String',
    'default_region': :'String',
    'key_alias': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/bds/models/create_bds_api_key_details.rb', line 99

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    user_id == other.user_id &&
    passphrase == other.passphrase &&
    default_region == other.default_region &&
    key_alias == other.key_alias
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/bds/models/create_bds_api_key_details.rb', line 132

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


112
113
114
 
# File 'lib/oci/bds/models/create_bds_api_key_details.rb', line 112

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



121
122
123
 
# File 'lib/oci/bds/models/create_bds_api_key_details.rb', line 121

def hash
  [user_id, passphrase, default_region, key_alias].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/bds/models/create_bds_api_key_details.rb', line 165

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



159
160
161
 
# File 'lib/oci/bds/models/create_bds_api_key_details.rb', line 159

def to_s
  to_hash.to_s
end