Module: Google::Cloud::ContainerAnalysis

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

Constant Summary collapse

VERSION = 
"1.5.2"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.container_analysis| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-container_analysis 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



149
150
151
152
153
 
# File 'lib/google/cloud/container_analysis.rb', line 149

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

  ::Google::Cloud.configure.container_analysis
end

.container_analysis(version: :v1, &block) ⇒ ::Object

Create a new client object for ContainerAnalysis.

By default, this returns an instance of Google::Cloud::ContainerAnalysis::V1::ContainerAnalysis::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 ContainerAnalysis service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

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

About ContainerAnalysis

Retrieves analysis results of Cloud components such as Docker container images. The Container Analysis API is an implementation of the Grafeas API.

Analysis results are stored as a series of occurrences. An Occurrence contains information about a specific analysis instance on a resource. An occurrence refers to a Note. A note contains details describing the analysis and is generally stored in a separate project, called a Provider. Multiple occurrences can refer to the same note.

For example, an SSL vulnerability could affect multiple images. In this case, there would be one note for the vulnerability and an occurrence for each image with the vulnerability referring to that note.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (::Object) —

    A client object for the specified version.



84
85
86
87
88
89
90
91
92
93
 
# File 'lib/google/cloud/container_analysis.rb', line 84

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

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

.container_analysis_available?(version: :v1) ⇒ boolean

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

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (boolean) —

    Whether the service is available.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/cloud/container_analysis.rb', line 106

def self.container_analysis_available? version: :v1
  require "google/cloud/container_analysis/#{version.to_s.downcase}"
  package_name = Google::Cloud::ContainerAnalysis
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::ContainerAnalysis.const_get package_name
  return false unless service_module.const_defined? :ContainerAnalysis
  service_module = service_module.const_get :ContainerAnalysis
  service_module.const_defined? :Client
rescue ::LoadError
  false
end