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.



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

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:



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

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) 


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

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:



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

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) 


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

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:



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

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) 


490
491
492
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 490

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) 


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

def 
  @dataproc_service_account
end

#description ⇒ String

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

Returns:

  • (String) 


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

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


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

def disabled_reason
  @disabled_reason
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


525
526
527
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 525

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) 


531
532
533
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 531

def enable_stackdriver_monitoring
  @enable_stackdriver_monitoring
end

#enable_zone_separation ⇒ Boolean Also known as: enable_zone_separation?

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

Returns:

  • (Boolean) 


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

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:



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

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) 


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

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


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

def labels
  @labels
end

#logging_config ⇒ Google::Apis::DatafusionV1beta1::LoggingConfig

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

Returns:



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

def logging_config
  @logging_config
end

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

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

Returns:



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

def maintenance_events
  @maintenance_events
end

#maintenance_policy ⇒ Google::Apis::DatafusionV1beta1::MaintenancePolicy

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

Returns:



571
572
573
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 571

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) 


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

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:



587
588
589
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 587

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


593
594
595
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 593

def options
  @options
end

#p4_service_account ⇒ String

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

Returns:

  • (String) 


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

def 
  @p4_service_account
end

#patch_revision ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


634
635
636
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 634

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) 


639
640
641
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 639

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) 


645
646
647
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 645

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


652
653
654
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 652

def tags
  @tags
end

#tenant_project_id ⇒ String

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

Returns:

  • (String) 


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

def tenant_project_id
  @tenant_project_id
end

#type ⇒ String

Required. Instance type. Corresponds to the JSON property type

Returns:

  • (String) 


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

def type
  @type
end

#update_time ⇒ String

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

Returns:

  • (String) 


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

def update_time
  @update_time
end

#version ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


684
685
686
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 684

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
 
# File 'lib/google/apis/datafusion_v1beta1/classes.rb', line 691

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