Class: OCI::DataIntegration::Models::CreateWorkspaceDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_integration/models/create_workspace_details.rb

Overview

The information needed to create a new workspace.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateWorkspaceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :vcn_id (String) —

    The value to assign to the #vcn_id property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :dns_server_ip (String) —

    The value to assign to the #dns_server_ip property

  • :dns_server_zone (String) —

    The value to assign to the #dns_server_zone 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

  • :description (String) —

    The value to assign to the #description property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :is_private_network_enabled (BOOLEAN) —

    The value to assign to the #is_private_network_enabled property

  • :registry_id (String) —

    The value to assign to the #registry_id property

  • :endpoint_id (String) —

    The value to assign to the #endpoint_id property

  • :registry_name (String) —

    The value to assign to the #registry_name property

  • :registry_compartment_id (String) —

    The value to assign to the #registry_compartment_id property

  • :endpoint_name (String) —

    The value to assign to the #endpoint_name property

  • :endpoint_compartment_id (String) —

    The value to assign to the #endpoint_compartment_id property

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

    The value to assign to the #workspace_properties property



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 156

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

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

  self.dns_server_ip = attributes[:'dnsServerIp'] if attributes[:'dnsServerIp']

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

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

  self.dns_server_zone = attributes[:'dnsServerZone'] if attributes[:'dnsServerZone']

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

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

  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']

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

  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.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.is_private_network_enabled = attributes[:'isPrivateNetworkEnabled'] unless attributes[:'isPrivateNetworkEnabled'].nil?
  self.is_private_network_enabled = false if is_private_network_enabled.nil? && !attributes.key?(:'isPrivateNetworkEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_private_network_enabled = attributes[:'is_private_network_enabled'] unless attributes[:'is_private_network_enabled'].nil?
  self.is_private_network_enabled = false if is_private_network_enabled.nil? && !attributes.key?(:'isPrivateNetworkEnabled') && !attributes.key?(:'is_private_network_enabled') # rubocop:disable Style/StringLiterals

  self.registry_id = attributes[:'registryId'] if attributes[:'registryId']

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

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

  self.endpoint_id = attributes[:'endpointId'] if attributes[:'endpointId']

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

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

  self.registry_name = attributes[:'registryName'] if attributes[:'registryName']

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

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

  self.registry_compartment_id = attributes[:'registryCompartmentId'] if attributes[:'registryCompartmentId']

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

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

  self.endpoint_name = attributes[:'endpointName'] if attributes[:'endpointName']

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

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

  self.endpoint_compartment_id = attributes[:'endpointCompartmentId'] if attributes[:'endpointCompartmentId']

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

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

  self.workspace_properties = attributes[:'workspaceProperties'] if attributes[:'workspaceProperties']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the workspace.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 49

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. See Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


37
38
39
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 37

def defined_tags
  @defined_tags
end

#description ⇒ String

A user defined description for the workspace.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 41

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 45

def display_name
  @display_name
end

#dns_server_ip ⇒ String

The IP of the custom DNS.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 21

def dns_server_ip
  @dns_server_ip
end

#dns_server_zone ⇒ String

The DNS zone of the custom DNS to use to resolve names.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 25

def dns_server_zone
  @dns_server_zone
end

#endpoint_compartment_id ⇒ String

DCMS PRivate Endpoint Compartment Identifier

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 77

def endpoint_compartment_id
  @endpoint_compartment_id
end

#endpoint_id ⇒ String

DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 61

def endpoint_id
  @endpoint_id
end

#endpoint_name ⇒ String

DCMS Private Endpoint Name

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 73

def endpoint_name
  @endpoint_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


31
32
33
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 31

def freeform_tags
  @freeform_tags
end

#is_private_network_enabled ⇒ BOOLEAN

Specifies whether the private network connection is enabled or disabled.

Returns:

  • (BOOLEAN) 


53
54
55
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 53

def is_private_network_enabled
  @is_private_network_enabled
end

#registry_compartment_id ⇒ String

DCMS Data Asset Registry Compartment Identifier

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 69

def registry_compartment_id
  @registry_compartment_id
end

#registry_id ⇒ String

DCMS Data Asset Registry ID to which the workspace is associated

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 57

def registry_id
  @registry_id
end

#registry_name ⇒ String

DCMS Data Asset Registry display name

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 65

def registry_name
  @registry_name
end

#subnet_id ⇒ String

The OCID of the subnet for customer connected databases.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 17

def subnet_id
  @subnet_id
end

#vcn_id ⇒ String

The OCID of the VCN the subnet is in.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 13

def vcn_id
  @vcn_id
end

#workspace_properties ⇒ Hash<String, String>

Key-values pairs of workspace for storing properties on the workspace.

Returns:

  • (Hash<String, String>) 


81
82
83
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 81

def workspace_properties
  @workspace_properties
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 84

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'vcn_id': :'vcnId',
    'subnet_id': :'subnetId',
    'dns_server_ip': :'dnsServerIp',
    'dns_server_zone': :'dnsServerZone',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'description': :'description',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'is_private_network_enabled': :'isPrivateNetworkEnabled',
    'registry_id': :'registryId',
    'endpoint_id': :'endpointId',
    'registry_name': :'registryName',
    'registry_compartment_id': :'registryCompartmentId',
    'endpoint_name': :'endpointName',
    'endpoint_compartment_id': :'endpointCompartmentId',
    'workspace_properties': :'workspaceProperties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 109

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'vcn_id': :'String',
    'subnet_id': :'String',
    'dns_server_ip': :'String',
    'dns_server_zone': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'description': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'is_private_network_enabled': :'BOOLEAN',
    'registry_id': :'String',
    'endpoint_id': :'String',
    'registry_name': :'String',
    'registry_compartment_id': :'String',
    'endpoint_name': :'String',
    'endpoint_compartment_id': :'String',
    'workspace_properties': :'Hash<String, 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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 270

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

  self.class == other.class &&
    vcn_id == other.vcn_id &&
    subnet_id == other.subnet_id &&
    dns_server_ip == other.dns_server_ip &&
    dns_server_zone == other.dns_server_zone &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    description == other.description &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    is_private_network_enabled == other.is_private_network_enabled &&
    registry_id == other.registry_id &&
    endpoint_id == other.endpoint_id &&
    registry_name == other.registry_name &&
    registry_compartment_id == other.registry_compartment_id &&
    endpoint_name == other.endpoint_name &&
    endpoint_compartment_id == other.endpoint_compartment_id &&
    workspace_properties == other.workspace_properties
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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 316

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


296
297
298
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 296

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



305
306
307
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 305

def hash
  [vcn_id, subnet_id, dns_server_ip, dns_server_zone, freeform_tags, defined_tags, description, display_name, compartment_id, is_private_network_enabled, registry_id, endpoint_id, registry_name, registry_compartment_id, endpoint_name, endpoint_compartment_id, workspace_properties].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



349
350
351
352
353
354
355
356
357
358
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 349

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



343
344
345
 
# File 'lib/oci/data_integration/models/create_workspace_details.rb', line 343

def to_s
  to_hash.to_s
end