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.



712
713
714
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 712

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:



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

def auth_config
  @auth_config
end

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

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

Returns:



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

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:



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

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) 


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

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) 


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

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:



585
586
587
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 585

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) 


590
591
592
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 590

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) 


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

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


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

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:



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

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) 


612
613
614
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 612

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:



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

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) 


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

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:



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

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) 


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

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) 


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

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


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

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:



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

def lock_config
  @lock_config
end

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

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

Returns:



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

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) 


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

def name
  @name
end

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

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

Returns:



669
670
671
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 669

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) 


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

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) 


683
684
685
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 683

def service_directory
  @service_directory
end

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

SSL Configuration of a connection Corresponds to the JSON property sslConfig

Returns:



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

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:



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

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) 


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

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) 


704
705
706
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 704

def suspended
  @suspended
end

#update_time ⇒ String

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

Returns:

  • (String) 


710
711
712
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 710

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 717

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