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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datafusion_v1/classes.rb,
lib/google/apis/datafusion_v1/representations.rb,
lib/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.



542
543
544
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 542

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:



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

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) 


381
382
383
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 381

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:



387
388
389
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 387

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) 


392
393
394
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 392

def create_time
  @create_time
end

#crypto_key_config ⇒ Google::Apis::DatafusionV1::CryptoKeyConfig

The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. Corresponds to the JSON property cryptoKeyConfig

Returns:



398
399
400
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 398

def crypto_key_config
  @crypto_key_config
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) 


405
406
407
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 405

def 
  @dataproc_service_account
end

#description ⇒ String

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

Returns:

  • (String) 


410
411
412
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 410

def description
  @description
end

#disabled_reason ⇒ Array<String>

Output only. If the instance state is DISABLED, the reason for disabling the instance. Corresponds to the JSON property disabledReason

Returns:

  • (Array<String>) 


416
417
418
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 416

def disabled_reason
  @disabled_reason
end

#display_name ⇒ String

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

Returns:

  • (String) 


421
422
423
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 421

def display_name
  @display_name
end

#enable_rbac ⇒ Boolean Also known as: enable_rbac?

Option to enable granular role-based access control. Corresponds to the JSON property enableRbac

Returns:

  • (Boolean) 


426
427
428
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 426

def enable_rbac
  @enable_rbac
end

#enable_stackdriver_logging ⇒ Boolean Also known as: enable_stackdriver_logging?

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

Returns:

  • (Boolean) 


432
433
434
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 432

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) 


438
439
440
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 438

def enable_stackdriver_monitoring
  @enable_stackdriver_monitoring
end

#event_publish_config ⇒ Google::Apis::DatafusionV1::EventPublishConfig

Confirguration of PubSubEventWriter. Corresponds to the JSON property eventPublishConfig

Returns:



444
445
446
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 444

def event_publish_config
  @event_publish_config
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) 


450
451
452
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 450

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 Compute Engine VMs. The character '=' is not allowed to be used within the labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


457
458
459
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 457

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) 


463
464
465
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 463

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:



473
474
475
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 473

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>) 


479
480
481
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 479

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) 


484
485
486
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 484

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) 


491
492
493
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 491

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) 


498
499
500
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 498

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) 


503
504
505
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 503

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) 


508
509
510
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 508

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) 


514
515
516
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 514

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) 


519
520
521
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 519

def tenant_project_id
  @tenant_project_id
end

#type ⇒ String

Required. Instance type. Corresponds to the JSON property type

Returns:

  • (String) 


524
525
526
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 524

def type
  @type
end

#update_time ⇒ String

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

Returns:

  • (String) 


529
530
531
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 529

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) 


534
535
536
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 534

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) 


540
541
542
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 540

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 547

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)
  @crypto_key_config = args[:crypto_key_config] if args.key?(:crypto_key_config)
  @dataproc_service_account = args[:dataproc_service_account] if args.key?(:dataproc_service_account)
  @description = args[:description] if args.key?(:description)
  @disabled_reason = args[:disabled_reason] if args.key?(:disabled_reason)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enable_rbac = args[:enable_rbac] if args.key?(:enable_rbac)
  @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)
  @event_publish_config = args[:event_publish_config] if args.key?(:event_publish_config)
  @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