Reference documentation and code samples for the Connectors V1 API class Google::Cloud::Connectors::V1::Connection.
Connection represents an instance of connector.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#auth_config
def auth_config() -> ::Google::Cloud::Connectors::V1::AuthConfig
Returns
- (::Google::Cloud::Connectors::V1::AuthConfig) — Optional. Configuration for establishing the connection's authentication with an external system.
#auth_config=
def auth_config=(value) -> ::Google::Cloud::Connectors::V1::AuthConfig
Parameter
- value (::Google::Cloud::Connectors::V1::AuthConfig) — Optional. Configuration for establishing the connection's authentication with an external system.
Returns
- (::Google::Cloud::Connectors::V1::AuthConfig) — Optional. Configuration for establishing the connection's authentication with an external system.
#config_variables
def config_variables() -> ::Array<::Google::Cloud::Connectors::V1::ConfigVariable>
Returns
- (::Array<::Google::Cloud::Connectors::V1::ConfigVariable>) — Optional. Configuration for configuring the connection with an external system.
#config_variables=
def config_variables=(value) -> ::Array<::Google::Cloud::Connectors::V1::ConfigVariable>
Parameter
- value (::Array<::Google::Cloud::Connectors::V1::ConfigVariable>) — Optional. Configuration for configuring the connection with an external system.
Returns
- (::Array<::Google::Cloud::Connectors::V1::ConfigVariable>) — Optional. Configuration for configuring the connection with an external system.
#connector_version
def connector_version() -> ::String
Returns
- (::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.
#connector_version=
def connector_version=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Created time.
#description
def description() -> ::String
Returns
- (::String) — Optional. Description of the resource.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. Description of the resource.
Returns
- (::String) — Optional. Description of the resource.
#destination_configs
def destination_configs() -> ::Array<::Google::Cloud::Connectors::V1::DestinationConfig>
Returns
- (::Array<::Google::Cloud::Connectors::V1::DestinationConfig>) — Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
#destination_configs=
def destination_configs=(value) -> ::Array<::Google::Cloud::Connectors::V1::DestinationConfig>
Parameter
- value (::Array<::Google::Cloud::Connectors::V1::DestinationConfig>) — Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
Returns
- (::Array<::Google::Cloud::Connectors::V1::DestinationConfig>) — Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
#envoy_image_location
def envoy_image_location() -> ::String
Returns
- (::String) — Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
#image_location
def image_location() -> ::String
Returns
- (::String) — Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::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
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::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
Returns
- (::Google::Protobuf::Map{::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
#lock_config
def lock_config() -> ::Google::Cloud::Connectors::V1::LockConfig
Returns
- (::Google::Cloud::Connectors::V1::LockConfig) — Optional. Configuration that indicates whether or not the Connection can be edited.
#lock_config=
def lock_config=(value) -> ::Google::Cloud::Connectors::V1::LockConfig
Parameter
- value (::Google::Cloud::Connectors::V1::LockConfig) — Optional. Configuration that indicates whether or not the Connection can be edited.
Returns
- (::Google::Cloud::Connectors::V1::LockConfig) — Optional. Configuration that indicates whether or not the Connection can be edited.
#name
def name() -> ::String
Returns
- (::String) — Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
#node_config
def node_config() -> ::Google::Cloud::Connectors::V1::NodeConfig
Returns
- (::Google::Cloud::Connectors::V1::NodeConfig) — Optional. Node configuration for the connection.
#node_config=
def node_config=(value) -> ::Google::Cloud::Connectors::V1::NodeConfig
Parameter
- value (::Google::Cloud::Connectors::V1::NodeConfig) — Optional. Node configuration for the connection.
Returns
- (::Google::Cloud::Connectors::V1::NodeConfig) — Optional. Node configuration for the connection.
#service_account
def service_account() -> ::String
Returns
- (::String) — Optional. Service account needed for runtime plane to access GCP resources.
#service_account=
def service_account=(value) -> ::String
Parameter
- value (::String) — Optional. Service account needed for runtime plane to access GCP resources.
Returns
- (::String) — Optional. Service account needed for runtime plane to access GCP resources.
#service_directory
def service_directory() -> ::String
Returns
- (::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"
#ssl_config
def ssl_config() -> ::Google::Cloud::Connectors::V1::SslConfig
Returns
- (::Google::Cloud::Connectors::V1::SslConfig) — Optional. Ssl config of a connection
#ssl_config=
def ssl_config=(value) -> ::Google::Cloud::Connectors::V1::SslConfig
Parameter
- value (::Google::Cloud::Connectors::V1::SslConfig) — Optional. Ssl config of a connection
Returns
- (::Google::Cloud::Connectors::V1::SslConfig) — Optional. Ssl config of a connection
#status
def status() -> ::Google::Cloud::Connectors::V1::ConnectionStatus
Returns
- (::Google::Cloud::Connectors::V1::ConnectionStatus) — Output only. Current status of the connection.
#suspended
def suspended() -> ::Boolean
Returns
- (::Boolean) — Optional. Suspended indicates if a user has suspended a connection or not.
#suspended=
def suspended=(value) -> ::Boolean
Parameter
- value (::Boolean) — Optional. Suspended indicates if a user has suspended a connection or not.
Returns
- (::Boolean) — Optional. Suspended indicates if a user has suspended a connection or not.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Updated time.