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.



446
447
448
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 446

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

Instance Attribute Details

#api_endpoint ⇒ String

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

Returns:

  • (String) 


326
327
328
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 326

def api_endpoint
  @api_endpoint
end

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

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

Returns:



332
333
334
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 332

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) 


337
338
339
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 337

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


342
343
344
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 342

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


347
348
349
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 347

def display_name
  @display_name
end

#enable_stackdriver_logging ⇒ Boolean Also known as: enable_stackdriver_logging?

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

Returns:

  • (Boolean) 


352
353
354
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 352

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) 


358
359
360
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 358

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


365
366
367
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 365

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


372
373
374
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 372

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) 


378
379
380
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 378

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:



388
389
390
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 388

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


394
395
396
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 394

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


401
402
403
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 401

def private_instance
  @private_instance
end

#service_account ⇒ String

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

Returns:

  • (String) 


408
409
410
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 408

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) 


413
414
415
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 413

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) 


418
419
420
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 418

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) 


424
425
426
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 424

def state_message
  @state_message
end

#type ⇒ String

Required. Instance type. Corresponds to the JSON property type

Returns:

  • (String) 


429
430
431
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 429

def type
  @type
end

#update_time ⇒ String

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

Returns:

  • (String) 


434
435
436
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 434

def update_time
  @update_time
end

#version ⇒ String

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

Returns:

  • (String) 


439
440
441
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 439

def version
  @version
end

#zone ⇒ String

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

Returns:

  • (String) 


444
445
446
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 444

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'generated/google/apis/datafusion_v1beta1/classes.rb', line 451

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