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.



629
630
631
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 629

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

Instance Attribute Details

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

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

Returns:



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

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) 


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

def api_endpoint
  @api_endpoint
end

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

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

Returns:



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

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) 


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

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:



428
429
430
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 428

def crypto_key_config
  @crypto_key_config
end

#dataplex_data_lineage_integration_enabled ⇒ Boolean Also known as: dataplex_data_lineage_integration_enabled?

Optional. Option to enable the Dataplex Lineage Integration feature. Corresponds to the JSON property dataplexDataLineageIntegrationEnabled

Returns:

  • (Boolean) 


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

def dataplex_data_lineage_integration_enabled
  @dataplex_data_lineage_integration_enabled
end

#dataproc_service_account ⇒ String

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


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

def 
  @dataproc_service_account
end

#description ⇒ String

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

Returns:

  • (String) 


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

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


452
453
454
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 452

def disabled_reason
  @disabled_reason
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#enable_rbac ⇒ Boolean Also known as: enable_rbac?

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

Returns:

  • (Boolean) 


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

def enable_rbac
  @enable_rbac
end

#enable_stackdriver_logging ⇒ Boolean Also known as: enable_stackdriver_logging?

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

Returns:

  • (Boolean) 


468
469
470
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 468

def enable_stackdriver_logging
  @enable_stackdriver_logging
end

#enable_stackdriver_monitoring ⇒ Boolean Also known as: enable_stackdriver_monitoring?

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

Returns:

  • (Boolean) 


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

def enable_stackdriver_monitoring
  @enable_stackdriver_monitoring
end

#enable_zone_separation ⇒ Boolean Also known as: enable_zone_separation?

Output only. Option to enable granular zone separation. Corresponds to the JSON property enableZoneSeparation

Returns:

  • (Boolean) 


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

def enable_zone_separation
  @enable_zone_separation
end

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

Confirguration of PubSubEventWriter. Corresponds to the JSON property eventPublishConfig

Returns:



486
487
488
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 486

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) 


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

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


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

def labels
  @labels
end

#logging_config ⇒ Google::Apis::DatafusionV1::LoggingConfig

Logging configuration for a Data Fusion instance. Corresponds to the JSON property loggingConfig

Returns:



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

def logging_config
  @logging_config
end

#maintenance_events ⇒ Array<Google::Apis::DatafusionV1::MaintenanceEvent>

Output only. The maintenance events for this instance. Corresponds to the JSON property maintenanceEvents

Returns:



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

def maintenance_events
  @maintenance_events
end

#maintenance_policy ⇒ Google::Apis::DatafusionV1::MaintenancePolicy

Maintenance policy of the instance. Corresponds to the JSON property maintenancePolicy

Returns:



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

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


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

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:



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

def network_config
  @network_config
end

#options ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


536
537
538
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 536

def options
  @options
end

#p4_service_account ⇒ String

Output only. Service agent for the customer project. Corresponds to the JSON property p4ServiceAccount

Returns:

  • (String) 


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

def 
  @p4_service_account
end

#patch_revision ⇒ String

Optional. Current patch revision of the Data Fusion. Corresponds to the JSON property patchRevision

Returns:

  • (String) 


546
547
548
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 546

def patch_revision
  @patch_revision
end

#private_instance ⇒ Boolean Also known as: private_instance?

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


553
554
555
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 553

def private_instance
  @private_instance
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


559
560
561
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 559

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


565
566
567
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 565

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


572
573
574
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 572

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) 


577
578
579
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 577

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) 


582
583
584
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 582

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) 


588
589
590
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 588

def state_message
  @state_message
end

#tags ⇒ Hash<String,String>

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": " marketing" Corresponds to the JSON property tags

Returns:

  • (Hash<String,String>) 


595
596
597
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 595

def tags
  @tags
end

#tenant_project_id ⇒ String

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

Returns:

  • (String) 


600
601
602
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 600

def tenant_project_id
  @tenant_project_id
end

#type ⇒ String

Required. Instance type. Corresponds to the JSON property type

Returns:

  • (String) 


605
606
607
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 605

def type
  @type
end

#update_time ⇒ String

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

Returns:

  • (String) 


610
611
612
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 610

def update_time
  @update_time
end

#version ⇒ String

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

Returns:

  • (String) 


615
616
617
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 615

def version
  @version
end

#workforce_identity_service_endpoint ⇒ String

Output only. Endpoint on which the Data Fusion UI is accessible to third-party users Corresponds to the JSON property workforceIdentityServiceEndpoint

Returns:

  • (String) 


621
622
623
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 621

def workforce_identity_service_endpoint
  @workforce_identity_service_endpoint
end

#zone ⇒ String

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


627
628
629
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 627

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 634

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)
  @dataplex_data_lineage_integration_enabled = args[:dataplex_data_lineage_integration_enabled] if args.key?(:dataplex_data_lineage_integration_enabled)
  @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)
  @enable_zone_separation = args[:enable_zone_separation] if args.key?(:enable_zone_separation)
  @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)
  @logging_config = args[:logging_config] if args.key?(:logging_config)
  @maintenance_events = args[:maintenance_events] if args.key?(:maintenance_events)
  @maintenance_policy = args[:maintenance_policy] if args.key?(:maintenance_policy)
  @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)
  @patch_revision = args[:patch_revision] if args.key?(:patch_revision)
  @private_instance = args[:private_instance] if args.key?(:private_instance)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @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)
  @tags = args[:tags] if args.key?(:tags)
  @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)
  @workforce_identity_service_endpoint = args[:workforce_identity_service_endpoint] if args.key?(:workforce_identity_service_endpoint)
  @zone = args[:zone] if args.key?(:zone)
end