Class: Google::Apis::DatafusionV1::Instance

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

Overview

Represents a Data Fusion instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



427
428
429
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 427

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

Instance Attribute Details

#accelerators ⇒ Array<Google::Apis::DatafusionV1::Accelerator>

List of accelerators enabled for this CDF instance. Corresponds to the JSON property accelerators

Returns:



284
285
286
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 284

def accelerators
  @accelerators
end

#api_endpoint ⇒ String

Output only. Endpoint on which the REST APIs is accessible. Corresponds to the JSON property apiEndpoint

Returns:

  • (String) 


289
290
291
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 289

def api_endpoint
  @api_endpoint
end

#available_version ⇒ Array<Google::Apis::DatafusionV1::Version>

Available versions that the instance can be upgraded to using UpdateInstanceRequest. Corresponds to the JSON property availableVersion

Returns:



295
296
297
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 295

def available_version
  @available_version
end

#create_time ⇒ String

Output only. The time the instance was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


300
301
302
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 300

def create_time
  @create_time
end

#dataproc_service_account ⇒ String

User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine- grained access control on Dataproc's accesses to cloud resources. Corresponds to the JSON property dataprocServiceAccount

Returns:

  • (String) 


307
308
309
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 307

def 
  @dataproc_service_account
end

#description ⇒ String

A description of this instance. Corresponds to the JSON property description

Returns:

  • (String) 


312
313
314
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 312

def description
  @description
end

#display_name ⇒ String

Display name for an instance. Corresponds to the JSON property displayName

Returns:

  • (String) 


317
318
319
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 317

def display_name
  @display_name
end

#enable_stackdriver_logging ⇒ Boolean Also known as: enable_stackdriver_logging?

Option to enable Stackdriver Logging. Corresponds to the JSON property enableStackdriverLogging

Returns:

  • (Boolean) 


322
323
324
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 322

def enable_stackdriver_logging
  @enable_stackdriver_logging
end

#enable_stackdriver_monitoring ⇒ Boolean Also known as: enable_stackdriver_monitoring?

Option to enable Stackdriver Monitoring. Corresponds to the JSON property enableStackdriverMonitoring

Returns:

  • (Boolean) 


328
329
330
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 328

def enable_stackdriver_monitoring
  @enable_stackdriver_monitoring
end

#gcs_bucket ⇒ String

Output only. Cloud Storage bucket generated by Data Fusion in the customer project. Corresponds to the JSON property gcsBucket

Returns:

  • (String) 


335
336
337
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 335

def gcs_bucket
  @gcs_bucket
end

#labels ⇒ Hash<String,String>

The resource labels for instance to use to annotate any related underlying resources such as GCE VMs. The character '=' is not allowed to be used within the labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


342
343
344
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 342

def labels
  @labels
end

#name ⇒ String

Output only. The name of this instance is in the form of projects/project/ locations/location/instances/instance. Corresponds to the JSON property name

Returns:

  • (String) 


348
349
350
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 348

def name
  @name
end

#network_config ⇒ Google::Apis::DatafusionV1::NetworkConfig

Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. Corresponds to the JSON property networkConfig

Returns:



358
359
360
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 358

def network_config
  @network_config
end

#options ⇒ Hash<String,String>

Map of additional options used to configure the behavior of Data Fusion instance. Corresponds to the JSON property options

Returns:

  • (Hash<String,String>) 


364
365
366
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 364

def options
  @options
end

#p4_service_account ⇒ String

Output only. P4 service account for the customer project. Corresponds to the JSON property p4ServiceAccount

Returns:

  • (String) 


369
370
371
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 369

def 
  @p4_service_account
end

#private_instance ⇒ Boolean Also known as: private_instance?

Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. Corresponds to the JSON property privateInstance

Returns:

  • (Boolean) 


376
377
378
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 376

def private_instance
  @private_instance
end

#service_account ⇒ String

Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


383
384
385
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 383

def 
  @service_account
end

#service_endpoint ⇒ String

Output only. Endpoint on which the Data Fusion UI is accessible. Corresponds to the JSON property serviceEndpoint

Returns:

  • (String) 


388
389
390
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 388

def service_endpoint
  @service_endpoint
end

#state ⇒ String

Output only. The current state of this Data Fusion instance. Corresponds to the JSON property state

Returns:

  • (String) 


393
394
395
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 393

def state
  @state
end

#state_message ⇒ String

Output only. Additional information about the current state of this Data Fusion instance if available. Corresponds to the JSON property stateMessage

Returns:

  • (String) 


399
400
401
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 399

def state_message
  @state_message
end

#tenant_project_id ⇒ String

Output only. The name of the tenant project. Corresponds to the JSON property tenantProjectId

Returns:

  • (String) 


404
405
406
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 404

def tenant_project_id
  @tenant_project_id
end

#type ⇒ String

Required. Instance type. Corresponds to the JSON property type

Returns:

  • (String) 


409
410
411
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 409

def type
  @type
end

#update_time ⇒ String

Output only. The time the instance was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


414
415
416
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 414

def update_time
  @update_time
end

#version ⇒ String

Current version of the Data Fusion. Only specifiable in Update. Corresponds to the JSON property version

Returns:

  • (String) 


419
420
421
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 419

def version
  @version
end

#zone ⇒ String

Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. Corresponds to the JSON property zone

Returns:

  • (String) 


425
426
427
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 425

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'generated/google/apis/datafusion_v1/classes.rb', line 432

def update!(**args)
  @accelerators = args[:accelerators] if args.key?(:accelerators)
  @api_endpoint = args[:api_endpoint] if args.key?(:api_endpoint)
  @available_version = args[:available_version] if args.key?(:available_version)
  @create_time = args[:create_time] if args.key?(:create_time)
  @dataproc_service_account = args[:dataproc_service_account] if args.key?(:dataproc_service_account)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enable_stackdriver_logging = args[:enable_stackdriver_logging] if args.key?(:enable_stackdriver_logging)
  @enable_stackdriver_monitoring = args[:enable_stackdriver_monitoring] if args.key?(:enable_stackdriver_monitoring)
  @gcs_bucket = args[:gcs_bucket] if args.key?(:gcs_bucket)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @network_config = args[:network_config] if args.key?(:network_config)
  @options = args[:options] if args.key?(:options)
  @p4_service_account = args[:p4_service_account] if args.key?(:p4_service_account)
  @private_instance = args[:private_instance] if args.key?(:private_instance)
  @service_account = args[:service_account] if args.key?(:service_account)
  @service_endpoint = args[:service_endpoint] if args.key?(:service_endpoint)
  @state = args[:state] if args.key?(:state)
  @state_message = args[:state_message] if args.key?(:state_message)
  @tenant_project_id = args[:tenant_project_id] if args.key?(:tenant_project_id)
  @type = args[:type] if args.key?(:type)
  @update_time = args[:update_time] if args.key?(:update_time)
  @version = args[:version] if args.key?(:version)
  @zone = args[:zone] if args.key?(:zone)
end