Module: Grafeas::V1

Defined in:
lib/grafeas/v1.rb,
lib/grafeas/v1/credentials.rb,
lib/grafeas/v1/grafeas_client.rb,
lib/grafeas/v1/doc/grafeas/v1/cvss.rb,
lib/grafeas/v1/doc/grafeas/v1/build.rb,
lib/grafeas/v1/doc/grafeas/v1/image.rb,
lib/grafeas/v1/doc/grafeas/v1/common.rb,
lib/grafeas/v1/doc/grafeas/v1/grafeas.rb,
lib/grafeas/v1/doc/grafeas/v1/package.rb,
lib/grafeas/v1/doc/grafeas/v1/upgrade.rb,
lib/grafeas/v1/doc/grafeas/v1/discovery.rb,
lib/grafeas/v1/doc/grafeas/v1/deployment.rb,
lib/grafeas/v1/doc/grafeas/v1/provenance.rb,
lib/grafeas/v1/doc/grafeas/v1/attestation.rb,
lib/grafeas/v1/doc/grafeas/v1/vulnerability.rb

Overview

Ruby Client for Container Analysis API (Alpha)

Container Analysis API: An implementation of the Grafeas API, which stores, and enables querying and retrieval of critical metadata about all of your software artifacts.

Quick Start

In order to use this library, you first need to go through the following steps:

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Container Analysis API.
  4. Setup Authentication.

Installation

$ gem install grafeas

Next Steps

Enabling Logging

To enable logging for this library, set the logger for the underlying gRPC library. The logger that you set may be a Ruby stdlib Logger as shown below, or a Google::Cloud::Logging::Logger that will write logs to Stackdriver Logging. See grpc/logconfig.rb and the gRPC spec_helper.rb for additional information.

Configuring a Ruby stdlib logger:

require "logger"

module MyLogger
  LOGGER = Logger.new $stderr, level: Logger::WARN
  def logger
    LOGGER
  end
end

# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
module GRPC
  extend MyLogger
end

Defined Under Namespace

Modules: Architecture, NoteKind, Severity Classes: AliasContext, Artifact, AttestationNote, AttestationOccurrence, BatchCreateNotesRequest, BatchCreateNotesResponse, BatchCreateOccurrencesRequest, BatchCreateOccurrencesResponse, BuildNote, BuildOccurrence, BuildProvenance, CVSSv3, CloudRepoSourceContext, Command, CreateNoteRequest, CreateOccurrenceRequest, Credentials, DeleteNoteRequest, DeleteOccurrenceRequest, DeploymentNote, DeploymentOccurrence, DiscoveryNote, DiscoveryOccurrence, Distribution, FileHashes, Fingerprint, GerritSourceContext, GetNoteRequest, GetOccurrenceNoteRequest, GetOccurrenceRequest, GitSourceContext, GrafeasClient, Hash, ImageNote, ImageOccurrence, Layer, ListNoteOccurrencesRequest, ListNoteOccurrencesResponse, ListNotesRequest, ListNotesResponse, ListOccurrencesRequest, ListOccurrencesResponse, Location, Note, Occurrence, PackageNote, PackageOccurrence, ProjectRepoId, RelatedUrl, RepoId, Signature, Source, SourceContext, UpdateNoteRequest, UpdateOccurrenceRequest, UpgradeDistribution, UpgradeNote, UpgradeOccurrence, Version, VulnerabilityNote, VulnerabilityOccurrence, WindowsUpdate

Class Method Summary collapse

Class Method Details

.new(credentials: nil, scopes: nil, client_config: nil, timeout: nil, metadata: nil, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: nil) ⇒ Object

Grafeas API.

Retrieves analysis results of Cloud components such as Docker container images.

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:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) (defaults to: nil) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: nil) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) (defaults to: nil) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) (defaults to: nil) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • service_address (String) (defaults to: nil) —

    Override for the service hostname, or nil to leave as the default.

  • service_port (Integer) (defaults to: nil) —

    Override for the service port, or nil to leave as the default.

  • exception_transformer (Proc) (defaults to: nil) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/grafeas/v1.rb', line 129

def self.new \
    credentials: nil,
    scopes: nil,
    client_config: nil,
    timeout: nil,
    metadata: nil,
    service_address: nil,
    service_port: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: nil
  kwargs = {
    credentials: credentials,
    scopes: scopes,
    client_config: client_config,
    timeout: timeout,
    metadata: metadata,
    exception_transformer: exception_transformer,
    lib_name: lib_name,
    service_address: service_address,
    service_port: service_port,
    lib_version: lib_version
  }.select { |_, v| v != nil }
  Grafeas::V1::GrafeasClient.new(**kwargs)
end