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.



700
701
702
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 700

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:



544
545
546
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 544

def auth_config
  @auth_config
end

#billing_config ⇒ Google::Apis::ConnectorsV1::BillingConfig

Billing config for the connection. Corresponds to the JSON property billingConfig

Returns:



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

def billing_config
  @billing_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:



554
555
556
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 554

def config_variables
  @config_variables
end

#connection_revision ⇒ Fixnum

Output only. Connection revision. This field is only updated when the connection is created or updated by User. Corresponds to the JSON property connectionRevision

Returns:

  • (Fixnum) 


560
561
562
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 560

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


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

def connector_version
  @connector_version
end

#connector_version_infra_config ⇒ Google::Apis::ConnectorsV1::ConnectorVersionInfraConfig

This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version Corresponds to the JSON property connectorVersionInfraConfig

Returns:



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

def connector_version_infra_config
  @connector_version_infra_config
end

#connector_version_launch_stage ⇒ String

Output only. Flag to mark the version indicating the launch stage. Corresponds to the JSON property connectorVersionLaunchStage

Returns:

  • (String) 


578
579
580
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 578

def connector_version_launch_stage
  @connector_version_launch_stage
end

#create_time ⇒ String

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

Returns:

  • (String) 


583
584
585
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 583

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


588
589
590
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 588

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:



594
595
596
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 594

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) 


600
601
602
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 600

def envoy_image_location
  @envoy_image_location
end

#eventing_config ⇒ Google::Apis::ConnectorsV1::EventingConfig

Eventing Configuration of a connection Corresponds to the JSON property eventingConfig

Returns:



605
606
607
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 605

def eventing_config
  @eventing_config
end

#eventing_enablement_type ⇒ String

Optional. Eventing enablement type. Will be nil if eventing is not enabled. Corresponds to the JSON property eventingEnablementType

Returns:

  • (String) 


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

def eventing_enablement_type
  @eventing_enablement_type
end

#eventing_runtime_data ⇒ Google::Apis::ConnectorsV1::EventingRuntimeData

Eventing runtime data has the details related to eventing managed by the system. Corresponds to the JSON property eventingRuntimeData

Returns:



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

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


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

def image_location
  @image_location
end

#is_trusted_tester ⇒ Boolean Also known as: is_trusted_tester?

Output only. Is trusted tester program enabled for the project. Corresponds to the JSON property isTrustedTester

Returns:

  • (Boolean) 


627
628
629
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 627

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


635
636
637
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 635

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:



641
642
643
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 641

def lock_config
  @lock_config
end

#log_config ⇒ Google::Apis::ConnectorsV1::ConnectorsLogConfig

Log configuration for the connection. Corresponds to the JSON property logConfig

Returns:



646
647
648
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 646

def log_config
  @log_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) 


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

def name
  @name
end

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

Node configuration for the connection. Corresponds to the JSON property nodeConfig

Returns:



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

def node_config
  @node_config
end

#service_account ⇒ String

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

Returns:

  • (String) 


663
664
665
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 663

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) 


671
672
673
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 671

def service_directory
  @service_directory
end

#ssl_config ⇒ Google::Apis::ConnectorsV1::SslConfig

SSL Configuration of a connection Corresponds to the JSON property sslConfig

Returns:



676
677
678
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 676

def ssl_config
  @ssl_config
end

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

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

Returns:



681
682
683
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 681

def status
  @status
end

#subscription_type ⇒ String

Output only. This subscription type enum states the subscription type of the project. Corresponds to the JSON property subscriptionType

Returns:

  • (String) 


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

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


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

def suspended
  @suspended
end

#update_time ⇒ String

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

Returns:

  • (String) 


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

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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
732
733
734
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 705

def update!(**args)
  @auth_config = args[:auth_config] if args.key?(:auth_config)
  @billing_config = args[:billing_config] if args.key?(:billing_config)
  @config_variables = args[:config_variables] if args.key?(:config_variables)
  @connection_revision = args[:connection_revision] if args.key?(:connection_revision)
  @connector_version = args[:connector_version] if args.key?(:connector_version)
  @connector_version_infra_config = args[:connector_version_infra_config] if args.key?(:connector_version_infra_config)
  @connector_version_launch_stage = args[:connector_version_launch_stage] if args.key?(:connector_version_launch_stage)
  @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)
  @eventing_config = args[:eventing_config] if args.key?(:eventing_config)
  @eventing_enablement_type = args[:eventing_enablement_type] if args.key?(:eventing_enablement_type)
  @eventing_runtime_data = args[:eventing_runtime_data] if args.key?(:eventing_runtime_data)
  @image_location = args[:image_location] if args.key?(:image_location)
  @is_trusted_tester = args[:is_trusted_tester] if args.key?(:is_trusted_tester)
  @labels = args[:labels] if args.key?(:labels)
  @lock_config = args[:lock_config] if args.key?(:lock_config)
  @log_config = args[:log_config] if args.key?(:log_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)
  @ssl_config = args[:ssl_config] if args.key?(:ssl_config)
  @status = args[:status] if args.key?(:status)
  @subscription_type = args[:subscription_type] if args.key?(:subscription_type)
  @suspended = args[:suspended] if args.key?(:suspended)
  @update_time = args[:update_time] if args.key?(:update_time)
end