Developer Connect API - Module Google::Cloud::DeveloperConnect (v2.1.0)

Reference documentation and code samples for the Developer Connect API module Google::Cloud::DeveloperConnect.

Methods

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-developer_connect library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.developer_connect)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.developer_connect

def self.developer_connect(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for DeveloperConnect.

By default, this returns an instance of Google::Cloud::DeveloperConnect::V1::DeveloperConnect::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the DeveloperConnect service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DeveloperConnect service. You can determine whether the method will succeed by calling DeveloperConnect.developer_connect_available?.

About DeveloperConnect

Service describing handlers for resources

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.developer_connect_available?

def self.developer_connect_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the DeveloperConnect service is supported by the current client. If true, you can retrieve a client object by calling DeveloperConnect.developer_connect. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DeveloperConnect service, or if the versioned client gem needs an update to support the DeveloperConnect service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.insights_config_service

def self.insights_config_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for InsightsConfigService.

By default, this returns an instance of Google::Cloud::DeveloperConnect::V1::InsightsConfigService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the InsightsConfigService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the InsightsConfigService service. You can determine whether the method will succeed by calling DeveloperConnect.insights_config_service_available?.

About InsightsConfigService

Creates and manages InsightsConfigs.

The InsightsConfig resource is the core configuration object to capture events from your Software Development Lifecycle. It acts as the central hub for managing how Developer connect understands your application, its runtime environments, and the artifacts deployed within them. A user can create an InsightsConfig, list previously-requested InsightsConfigs or get InsightsConfigs by their ID to determine the status of the InsightsConfig.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.insights_config_service_available?

def self.insights_config_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the InsightsConfigService service is supported by the current client. If true, you can retrieve a client object by calling DeveloperConnect.insights_config_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the InsightsConfigService service, or if the versioned client gem needs an update to support the InsightsConfigService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "2.1.0"