Class: Google::Apis::ConnectorsV1::Connection

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/connectors_v1/classes.rb,
lib/google/apis/connectors_v1/representations.rb,
lib/google/apis/connectors_v1/representations.rb

Overview

Connection represents an instance of connector.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Connection

Returns a new instance of Connection.



532
533
534
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 532

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

Instance Attribute Details

#auth_config ⇒ Google::Apis::ConnectorsV1::AuthConfig

AuthConfig defines details of a authentication type. Corresponds to the JSON property authConfig

Returns:



437
438
439
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 437

def auth_config
  @auth_config
end

#config_variables ⇒ Array<Google::Apis::ConnectorsV1::ConfigVariable>

Optional. Configuration for configuring the connection with an external system. Corresponds to the JSON property configVariables

Returns:



442
443
444
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 442

def config_variables
  @config_variables
end

#connector_version ⇒ String

Required. Connector version on which the connection is created. The format is: projects//locations//providers//connectors//versions/* Only global location is supported for ConnectorVersion resource. Corresponds to the JSON property connectorVersion

Returns:

  • (String) 


449
450
451
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 449

def connector_version
  @connector_version
end

#create_time ⇒ String

Output only. Created time. Corresponds to the JSON property createTime

Returns:

  • (String) 


454
455
456
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 454

def create_time
  @create_time
end

#description ⇒ String

Optional. Description of the resource. Corresponds to the JSON property description

Returns:

  • (String) 


459
460
461
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 459

def description
  @description
end

#destination_configs ⇒ Array<Google::Apis::ConnectorsV1::DestinationConfig>

Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s). Corresponds to the JSON property destinationConfigs

Returns:



465
466
467
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 465

def destination_configs
  @destination_configs
end

#envoy_image_location ⇒ String

Output only. GCR location where the envoy image is stored. formatted like: gcr. io/bucketName/imageName Corresponds to the JSON property envoyImageLocation

Returns:

  • (String) 


471
472
473
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 471

def envoy_image_location
  @envoy_image_location
end

#image_location ⇒ String

Output only. GCR location where the runtime image is stored. formatted like: gcr.io/bucketName/imageName Corresponds to the JSON property imageLocation

Returns:

  • (String) 


477
478
479
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 477

def image_location
  @image_location
end

#labels ⇒ Hash<String,String>

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/ docs/labeling-resources Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


484
485
486
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 484

def labels
  @labels
end

#lock_config ⇒ Google::Apis::ConnectorsV1::LockConfig

Determines whether or no a connection is locked. If locked, a reason must be specified. Corresponds to the JSON property lockConfig

Returns:



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

def lock_config
  @lock_config
end

#name ⇒ String

Output only. Resource name of the Connection. Format: projects/project/ locations/location/connections/connection Corresponds to the JSON property name

Returns:

  • (String) 


496
497
498
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 496

def name
  @name
end

#node_config ⇒ Google::Apis::ConnectorsV1::NodeConfig

Configuration for the connection. Corresponds to the JSON property nodeConfig

Returns:



501
502
503
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 501

def node_config
  @node_config
end

#service_account ⇒ String

Optional. Service account needed for runtime plane to access GCP resources. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


506
507
508
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 506

def 
  @service_account
end

#service_directory ⇒ String

Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e- testing/locations/us-central1/namespaces/istio-system/services/istio- ingressgateway-connectors" Corresponds to the JSON property serviceDirectory

Returns:

  • (String) 


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

def service_directory
  @service_directory
end

#status ⇒ Google::Apis::ConnectorsV1::ConnectionStatus

ConnectionStatus indicates the state of the connection. Corresponds to the JSON property status

Returns:



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

def status
  @status
end

#suspended ⇒ Boolean Also known as: suspended?

Optional. Suspended indicates if a user has suspended a connection or not. Corresponds to the JSON property suspended

Returns:

  • (Boolean) 


524
525
526
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 524

def suspended
  @suspended
end

#update_time ⇒ String

Output only. Updated time. Corresponds to the JSON property updateTime

Returns:

  • (String) 


530
531
532
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 530

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 537

def update!(**args)
  @auth_config = args[:auth_config] if args.key?(:auth_config)
  @config_variables = args[:config_variables] if args.key?(:config_variables)
  @connector_version = args[:connector_version] if args.key?(:connector_version)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @destination_configs = args[:destination_configs] if args.key?(:destination_configs)
  @envoy_image_location = args[:envoy_image_location] if args.key?(:envoy_image_location)
  @image_location = args[:image_location] if args.key?(:image_location)
  @labels = args[:labels] if args.key?(:labels)
  @lock_config = args[:lock_config] if args.key?(:lock_config)
  @name = args[:name] if args.key?(:name)
  @node_config = args[:node_config] if args.key?(:node_config)
  @service_account = args[:service_account] if args.key?(:service_account)
  @service_directory = args[:service_directory] if args.key?(:service_directory)
  @status = args[:status] if args.key?(:status)
  @suspended = args[:suspended] if args.key?(:suspended)
  @update_time = args[:update_time] if args.key?(:update_time)
end