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.



706
707
708
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 706

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

Instance Attribute Details

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

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

Returns:



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

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) 


516
517
518
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 516

def api_endpoint
  @api_endpoint
end

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

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

Returns:



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

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) 


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

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:



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

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) 


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

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) 


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

def 
  @dataproc_service_account
end

#description ⇒ String

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

Returns:

  • (String) 


551
552
553
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 551

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


557
558
559
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 557

def disabled_reason
  @disabled_reason
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


573
574
575
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 573

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) 


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

def enable_stackdriver_monitoring
  @enable_stackdriver_monitoring
end

#enable_zone_separation ⇒ Boolean Also known as: enable_zone_separation?

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

Returns:

  • (Boolean) 


585
586
587
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 585

def enable_zone_separation
  @enable_zone_separation
end

#event_publish_config ⇒ Google::Apis::DatafusionV1beta1::EventPublishConfig

Confirguration of PubSubEventWriter. Corresponds to the JSON property eventPublishConfig

Returns:



591
592
593
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 591

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) 


597
598
599
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 597

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


604
605
606
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 604

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) 


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

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:



620
621
622
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 620

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


626
627
628
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 626

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) 


631
632
633
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 631

def 
  @p4_service_account
end

#patch_revision ⇒ String

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

Returns:

  • (String) 


636
637
638
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 636

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) 


643
644
645
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 643

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) 


649
650
651
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 649

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) 


656
657
658
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 656

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) 


661
662
663
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 661

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) 


666
667
668
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 666

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) 


672
673
674
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 672

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) 


677
678
679
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 677

def tenant_project_id
  @tenant_project_id
end

#type ⇒ String

Required. Instance type. Corresponds to the JSON property type

Returns:

  • (String) 


682
683
684
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 682

def type
  @type
end

#update_time ⇒ String

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

Returns:

  • (String) 


687
688
689
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 687

def update_time
  @update_time
end

#version ⇒ String

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

Returns:

  • (String) 


692
693
694
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 692

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) 


698
699
700
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 698

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) 


704
705
706
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 704

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 711

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