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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/datafusion_v1beta1/classes.rb,
generated/google/apis/datafusion_v1beta1/representations.rb,
generated/google/apis/datafusion_v1beta1/representations.rb

Overview

Represents a Data Fusion instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance



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

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

Instance Attribute Details

#api_endpointString

Output only. Endpoint on which the REST APIs is accessible. Corresponds to the JSON property apiEndpoint

Returns:

  • (String)


473
474
475
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 473

def api_endpoint
  @api_endpoint
end

#available_versionArray<Google::Apis::DatafusionV1beta1::Version>

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



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

def available_version
  @available_version
end

#create_timeString

Output only. The time the instance was created. Corresponds to the JSON property createTime

Returns:

  • (String)


484
485
486
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 484

def create_time
  @create_time
end

#descriptionString

An optional description of this instance. Corresponds to the JSON property description

Returns:

  • (String)


489
490
491
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 489

def description
  @description
end

#display_nameString

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

Returns:

  • (String)


494
495
496
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 494

def display_name
  @display_name
end

#enable_stackdriver_loggingBoolean Also known as: enable_stackdriver_logging?

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

Returns:

  • (Boolean)


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

def enable_stackdriver_logging
  @enable_stackdriver_logging
end

#enable_stackdriver_monitoringBoolean Also known as: enable_stackdriver_monitoring?

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

Returns:

  • (Boolean)


505
506
507
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 505

def enable_stackdriver_monitoring
  @enable_stackdriver_monitoring
end

#labelsHash<String,String>

The resource labels for instance to use to annotate any related underlying resources such as GCE VMs. The character '=' is not allowed to be used within the labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)


513
514
515
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 513

def labels
  @labels
end

#nameString

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)


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

def name
  @name
end

#network_configGoogle::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



529
530
531
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 529

def network_config
  @network_config
end

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


535
536
537
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 535

def options
  @options
end

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


542
543
544
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 542

def private_instance
  @private_instance
end

#service_accountString

Output only. Service account which will be used to access resources in the customer project." Corresponds to the JSON property serviceAccount

Returns:

  • (String)


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

def 
  @service_account
end

#service_endpointString

Output only. Endpoint on which the Data Fusion UI is accessible. Corresponds to the JSON property serviceEndpoint

Returns:

  • (String)


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

def service_endpoint
  @service_endpoint
end

#stateString

Output only. The current state of this Data Fusion instance. Corresponds to the JSON property state

Returns:

  • (String)


559
560
561
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 559

def state
  @state
end

#state_messageString

Output only. Additional information about the current state of this Data Fusion instance if available. Corresponds to the JSON property stateMessage

Returns:

  • (String)


565
566
567
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 565

def state_message
  @state_message
end

#typeString

Required. Instance type. Corresponds to the JSON property type

Returns:

  • (String)


570
571
572
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 570

def type
  @type
end

#update_timeString

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

Returns:

  • (String)


575
576
577
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 575

def update_time
  @update_time
end

#versionString

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

Returns:

  • (String)


580
581
582
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 580

def version
  @version
end

#zoneString

Name of the zone in which the Data Fusion instance will be created. Corresponds to the JSON property zone

Returns:

  • (String)


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

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 592

def update!(**args)
  @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)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @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)
  @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)
  @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)
  @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