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.



926
927
928
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 926

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

Instance Attribute Details

#async_operations_enabled ⇒ Boolean Also known as: async_operations_enabled?

Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API. Corresponds to the JSON property asyncOperationsEnabled

Returns:

  • (Boolean) 


745
746
747
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 745

def async_operations_enabled
  @async_operations_enabled
end

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

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

Returns:



751
752
753
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 751

def auth_config
  @auth_config
end

#auth_override_enabled ⇒ Boolean Also known as: auth_override_enabled?

Optional. Auth override enabled for the connection. If Auth Override is enabled, Connection allows the backend service auth to be overridden in the entities/actions API. Corresponds to the JSON property authOverrideEnabled

Returns:

  • (Boolean) 


758
759
760
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 758

def auth_override_enabled
  @auth_override_enabled
end

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

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

Returns:



764
765
766
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 764

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:



769
770
771
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 769

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) 


775
776
777
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 775

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) 


782
783
784
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 782

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:



788
789
790
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 788

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) 


793
794
795
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 793

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) 


798
799
800
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 798

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


803
804
805
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 803

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:



809
810
811
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 809

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) 


815
816
817
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 815

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:



820
821
822
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 820

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) 


825
826
827
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 825

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:



831
832
833
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 831

def eventing_runtime_data
  @eventing_runtime_data
end

#host ⇒ String

Output only. The name of the Hostname of the Service Directory service with TLS. Corresponds to the JSON property host

Returns:

  • (String) 


837
838
839
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 837

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


843
844
845
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 843

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) 


848
849
850
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 848

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


856
857
858
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 856

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:



862
863
864
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 862

def lock_config
  @lock_config
end

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

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

Returns:



867
868
869
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 867

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) 


873
874
875
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 873

def name
  @name
end

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

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

Returns:



878
879
880
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 878

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) 


884
885
886
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 884

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) 


892
893
894
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 892

def service_directory
  @service_directory
end

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

SSL Configuration of a connection Corresponds to the JSON property sslConfig

Returns:



897
898
899
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 897

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:



902
903
904
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 902

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) 


908
909
910
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 908

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) 


913
914
915
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 913

def suspended
  @suspended
end

#tls_service_directory ⇒ String

Output only. The name of the Service Directory service with TLS. Corresponds to the JSON property tlsServiceDirectory

Returns:

  • (String) 


919
920
921
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 919

def tls_service_directory
  @tls_service_directory
end

#update_time ⇒ String

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

Returns:

  • (String) 


924
925
926
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 924

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 931

def update!(**args)
  @async_operations_enabled = args[:async_operations_enabled] if args.key?(:async_operations_enabled)
  @auth_config = args[:auth_config] if args.key?(:auth_config)
  @auth_override_enabled = args[:auth_override_enabled] if args.key?(:auth_override_enabled)
  @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)
  @host = args[:host] if args.key?(:host)
  @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)
  @tls_service_directory = args[:tls_service_directory] if args.key?(:tls_service_directory)
  @update_time = args[:update_time] if args.key?(:update_time)
end