Module: Google::Cloud::DeveloperConnect

Defined in:
lib/google/cloud/developer_connect.rb,
lib/google/cloud/developer_connect/version.rb

Constant Summary collapse

VERSION = 
"2.1.0"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.developer_connect| ... } ⇒ ::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:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



224
225
226
227
228
 
# File 'lib/google/cloud/developer_connect.rb', line 224

def self.configure
  yield ::Google::Cloud.configure.developer_connect if block_given?

  ::Google::Cloud.configure.developer_connect
end

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



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/cloud/developer_connect.rb', line 75

def self.developer_connect version: :v1, transport: :grpc, &block
  require "google/cloud/developer_connect/#{version.to_s.downcase}"

  package_name = Google::Cloud::DeveloperConnect
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::DeveloperConnect.const_get(package_name).const_get(:DeveloperConnect)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/google/cloud/developer_connect.rb', line 99

def self.developer_connect_available? version: :v1, transport: :grpc
  require "google/cloud/developer_connect/#{version.to_s.downcase}"
  package_name = Google::Cloud::DeveloperConnect
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::DeveloperConnect.const_get package_name
  return false unless service_module.const_defined? :DeveloperConnect
  service_module = service_module.const_get :DeveloperConnect
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

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



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/google/cloud/developer_connect.rb', line 153

def self.insights_config_service version: :v1, transport: :grpc, &block
  require "google/cloud/developer_connect/#{version.to_s.downcase}"

  package_name = Google::Cloud::DeveloperConnect
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::DeveloperConnect.const_get(package_name).const_get(:InsightsConfigService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/google/cloud/developer_connect.rb', line 177

def self.insights_config_service_available? version: :v1, transport: :grpc
  require "google/cloud/developer_connect/#{version.to_s.downcase}"
  package_name = Google::Cloud::DeveloperConnect
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::DeveloperConnect.const_get package_name
  return false unless service_module.const_defined? :InsightsConfigService
  service_module = service_module.const_get :InsightsConfigService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end