Connectors V1 API - Class Google::Cloud::Connectors::V1::Connectors::Rest::ServiceStub (v0.1.1)

Version latest

• 0.1.1 (latest)
• 0.1.0

Reference documentation and code samples for the Connectors V1 API class Google::Cloud::Connectors::V1::Connectors::Rest::ServiceStub.

REST service stub for the Connectors service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

• Object

Methods

#create_connection

def create_connection(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_connection REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::CreateConnectionRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_connection

def delete_connection(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_connection REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::DeleteConnectionRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#get_connection

def get_connection(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Connectors::V1::Connection

Baseline implementation for the get_connection REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::GetConnectionRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Connectors::V1::Connection)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Connectors::V1::Connection) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_connection_schema_metadata

def get_connection_schema_metadata(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Connectors::V1::ConnectionSchemaMetadata

Baseline implementation for the get_connection_schema_metadata REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::GetConnectionSchemaMetadataRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Connectors::V1::ConnectionSchemaMetadata)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Connectors::V1::ConnectionSchemaMetadata) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_connector

def get_connector(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Connectors::V1::Connector

Baseline implementation for the get_connector REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::GetConnectorRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Connectors::V1::Connector)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Connectors::V1::Connector) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_connector_version

def get_connector_version(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Connectors::V1::ConnectorVersion

Baseline implementation for the get_connector_version REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::GetConnectorVersionRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Connectors::V1::ConnectorVersion)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Connectors::V1::ConnectorVersion) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_global_settings

def get_global_settings(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Connectors::V1::Settings

Baseline implementation for the get_global_settings REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::GetGlobalSettingsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Connectors::V1::Settings)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Connectors::V1::Settings) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_provider

def get_provider(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Connectors::V1::Provider

Baseline implementation for the get_provider REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::GetProviderRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Connectors::V1::Provider)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Connectors::V1::Provider) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_runtime_config

def get_runtime_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Connectors::V1::RuntimeConfig

Baseline implementation for the get_runtime_config REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::GetRuntimeConfigRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Connectors::V1::RuntimeConfig)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Connectors::V1::RuntimeConfig) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

• (ServiceStub) — a new instance of ServiceStub

#list_connections

def list_connections(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Connectors::V1::ListConnectionsResponse

Baseline implementation for the list_connections REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::ListConnectionsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Connectors::V1::ListConnectionsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Connectors::V1::ListConnectionsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_connector_versions

def list_connector_versions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Connectors::V1::ListConnectorVersionsResponse

Baseline implementation for the list_connector_versions REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::ListConnectorVersionsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Connectors::V1::ListConnectorVersionsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Connectors::V1::ListConnectorVersionsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_connectors

def list_connectors(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Connectors::V1::ListConnectorsResponse

Baseline implementation for the list_connectors REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::ListConnectorsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Connectors::V1::ListConnectorsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Connectors::V1::ListConnectorsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_providers

def list_providers(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Connectors::V1::ListProvidersResponse

Baseline implementation for the list_providers REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::ListProvidersRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Connectors::V1::ListProvidersResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Connectors::V1::ListProvidersResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_runtime_action_schemas

def list_runtime_action_schemas(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Connectors::V1::ListRuntimeActionSchemasResponse

Baseline implementation for the list_runtime_action_schemas REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::ListRuntimeActionSchemasRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Connectors::V1::ListRuntimeActionSchemasResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Connectors::V1::ListRuntimeActionSchemasResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_runtime_entity_schemas

def list_runtime_entity_schemas(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Connectors::V1::ListRuntimeEntitySchemasResponse

Baseline implementation for the list_runtime_entity_schemas REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::ListRuntimeEntitySchemasRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Connectors::V1::ListRuntimeEntitySchemasResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Connectors::V1::ListRuntimeEntitySchemasResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#refresh_connection_schema_metadata

def refresh_connection_schema_metadata(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the refresh_connection_schema_metadata REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::RefreshConnectionSchemaMetadataRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_connection

def update_connection(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_connection REST call

Parameters

• request_pb (::Google::Cloud::Connectors::V1::UpdateConnectionRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)