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.



624
625
626
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 624

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:



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

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) 


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

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:



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

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) 


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

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:



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

def crypto_key_config
  @crypto_key_config
end

#dataplex_data_lineage_integration_enabled ⇒ Boolean Also known as: dataplex_data_lineage_integration_enabled?

Optional. Reserved for future use. Corresponds to the JSON property dataplexDataLineageIntegrationEnabled

Returns:

  • (Boolean) 


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

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


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

def 
  @dataproc_service_account
end

#description ⇒ String

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

Returns:

  • (String) 


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

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


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

def disabled_reason
  @disabled_reason
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

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) 


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

def enable_stackdriver_monitoring
  @enable_stackdriver_monitoring
end

#enable_zone_separation ⇒ Boolean Also known as: enable_zone_separation?

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

Returns:

  • (Boolean) 


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

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:



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

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) 


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

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


522
523
524
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 522

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) 


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

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:



538
539
540
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 538

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


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

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) 


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

def 
  @p4_service_account
end

#patch_revision ⇒ String

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

Returns:

  • (String) 


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

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


561
562
563
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 561

def private_instance
  @private_instance
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


567
568
569
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 567

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) 


574
575
576
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 574

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) 


579
580
581
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 579

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) 


584
585
586
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 584

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) 


590
591
592
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 590

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) 


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

def tenant_project_id
  @tenant_project_id
end

#type ⇒ String

Required. Instance type. Corresponds to the JSON property type

Returns:

  • (String) 


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

def type
  @type
end

#update_time ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

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


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

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



629
630
631
632
633
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
 
# File 'lib/google/apis/datafusion_v1/classes.rb', line 629

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