Class: OCI::TenantManagerControlPlane::Models::CreateSenderInvitationDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb

Overview

The parameters for creating a sender invitation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSenderInvitationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :recipient_tenancy_id (String) —

    The value to assign to the #recipient_tenancy_id property

  • :recipient_email_address (String) —

    The value to assign to the #recipient_email_address property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :subjects (Array<OCI::TenantManagerControlPlane::Models::InvitationSubject>) —

    The value to assign to the #subjects property

  • :features (Array<String>) —

    The value to assign to the #features property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 93

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.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.recipient_tenancy_id = attributes[:'recipientTenancyId'] if attributes[:'recipientTenancyId']

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

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

  self.recipient_email_address = attributes[:'recipientEmailAddress'] if attributes[:'recipientEmailAddress']

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] OCID of the sender tenancy.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 13

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


45
46
47
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 45

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-created name to describe the invitation. Avoid entering confidential information.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 25

def display_name
  @display_name
end

#features ⇒ Array<String>

List of features that the invitation is being sent for. Each feature would create one link, of that type.

Returns:

  • (Array<String>) 


33
34
35
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 33

def features
  @features
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


39
40
41
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 39

def freeform_tags
  @freeform_tags
end

#recipient_email_address ⇒ String

Email address of the recipient.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 21

def recipient_email_address
  @recipient_email_address
end

#recipient_tenancy_id ⇒ String

[Required] OCID of the recipient tenancy.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 17

def recipient_tenancy_id
  @recipient_tenancy_id
end

#subjects ⇒ Array<OCI::TenantManagerControlPlane::Models::InvitationSubject>

The list of subjects this invitation contains.

Returns:

  • (Array<OCI::TenantManagerControlPlane::Models::InvitationSubject>) 


29
30
31
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 29

def subjects
  @subjects
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 48

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'recipient_tenancy_id': :'recipientTenancyId',
    'recipient_email_address': :'recipientEmailAddress',
    'display_name': :'displayName',
    'subjects': :'subjects',
    'features': :'features',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 64

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'recipient_tenancy_id': :'String',
    'recipient_email_address': :'String',
    'display_name': :'String',
    'subjects': :'Array<OCI::TenantManagerControlPlane::Models::InvitationSubject>',
    'features': :'Array<String>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 147

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    recipient_tenancy_id == other.recipient_tenancy_id &&
    recipient_email_address == other.recipient_email_address &&
    display_name == other.display_name &&
    subjects == other.subjects &&
    features == other.features &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 184

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


164
165
166
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 164

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



173
174
175
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 173

def hash
  [compartment_id, recipient_tenancy_id, recipient_email_address, display_name, subjects, features, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 217

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



211
212
213
 
# File 'lib/oci/tenant_manager_control_plane/models/create_sender_invitation_details.rb', line 211

def to_s
  to_hash.to_s
end