Class: Google::Apis::DatafusionV1beta1::Instance

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



562
563
564
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 562

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

Instance Attribute Details

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

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

Returns:



401
402
403
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 401

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) 


406
407
408
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 406

def api_endpoint
  @api_endpoint
end

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

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

Returns:



412
413
414
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 412

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) 


417
418
419
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 417

def create_time
  @create_time
end

#crypto_key_config ⇒ Google::Apis::DatafusionV1beta1::CryptoKeyConfig

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

Returns:



423
424
425
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 423

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) 


430
431
432
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 430

def 
  @dataproc_service_account
end

#description ⇒ String

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

Returns:

  • (String) 


435
436
437
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 435

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


441
442
443
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 441

def disabled_reason
  @disabled_reason
end

#display_name ⇒ String

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

Returns:

  • (String) 


446
447
448
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 446

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) 


451
452
453
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 451

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) 


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

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) 


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

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) 


470
471
472
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 470

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


477
478
479
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 477

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) 


483
484
485
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 483

def name
  @name
end

#network_config ⇒ Google::Apis::DatafusionV1beta1::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:



493
494
495
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 493

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


499
500
501
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 499

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) 


504
505
506
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 504

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) 


511
512
513
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 511

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) 


518
519
520
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 518

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) 


523
524
525
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 523

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) 


528
529
530
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 528

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) 


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

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) 


539
540
541
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 539

def tenant_project_id
  @tenant_project_id
end

#type ⇒ String

Required. Instance type. Corresponds to the JSON property type

Returns:

  • (String) 


544
545
546
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 544

def type
  @type
end

#update_time ⇒ String

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

Returns:

  • (String) 


549
550
551
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 549

def update_time
  @update_time
end

#version ⇒ String

Current version of Data Fusion. Corresponds to the JSON property version

Returns:

  • (String) 


554
555
556
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 554

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) 


560
561
562
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 560

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 567

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