grafeas-client 0.3.0 → 0.4.0

data/lib/grafeas/v1/doc/grafeas/v1/grafeas.rb

@@ -1,322 +0,0 @@
-# Copyright 2019 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Grafeas
-  module V1
-    # An instance of an analysis type that has been found on a resource.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     Output only. The name of the occurrence in the form of
-    #     `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
-    # @!attribute [rw] resource_uri
-    #   @return [String]
-    #     Required. Immutable. A URI that represents the resource for which the
-    #     occurrence applies. For example,
-    #     `https://gcr.io/project/image@sha256:123abc` for a Docker image.
-    # @!attribute [rw] note_name
-    #   @return [String]
-    #     Required. Immutable. The analysis note associated with this occurrence, in
-    #     the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be
-    #     used as a filter in list requests.
-    # @!attribute [rw] kind
-    #   @return [Grafeas::V1::NoteKind]
-    #     Output only. This explicitly denotes which of the occurrence details are
-    #     specified. This field can be used as a filter in list requests.
-    # @!attribute [rw] remediation
-    #   @return [String]
-    #     A description of actions that can be taken to remedy the note.
-    # @!attribute [rw] create_time
-    #   @return [Google::Protobuf::Timestamp]
-    #     Output only. The time this occurrence was created.
-    # @!attribute [rw] update_time
-    #   @return [Google::Protobuf::Timestamp]
-    #     Output only. The time this occurrence was last updated.
-    # @!attribute [rw] vulnerability
-    #   @return [Grafeas::V1::VulnerabilityOccurrence]
-    #     Describes a security vulnerability.
-    # @!attribute [rw] build
-    #   @return [Grafeas::V1::BuildOccurrence]
-    #     Describes a verifiable build.
-    # @!attribute [rw] image
-    #   @return [Grafeas::V1::ImageOccurrence]
-    #     Describes how this resource derives from the basis in the associated
-    #     note.
-    # @!attribute [rw] package
-    #   @return [Grafeas::V1::PackageOccurrence]
-    #     Describes the installation of a package on the linked resource.
-    # @!attribute [rw] deployment
-    #   @return [Grafeas::V1::DeploymentOccurrence]
-    #     Describes the deployment of an artifact on a runtime.
-    # @!attribute [rw] discovery
-    #   @return [Grafeas::V1::DiscoveryOccurrence]
-    #     Describes when a resource was discovered.
-    # @!attribute [rw] attestation
-    #   @return [Grafeas::V1::AttestationOccurrence]
-    #     Describes an attestation of an artifact.
-    class Occurrence; end
-
-    # A type of analysis that can be done for a resource.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     Output only. The name of the note in the form of
-    #     `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
-    # @!attribute [rw] short_description
-    #   @return [String]
-    #     A one sentence description of this note.
-    # @!attribute [rw] long_description
-    #   @return [String]
-    #     A detailed description of this note.
-    # @!attribute [rw] kind
-    #   @return [Grafeas::V1::NoteKind]
-    #     Output only. The type of analysis. This field can be used as a filter in
-    #     list requests.
-    # @!attribute [rw] related_url
-    #   @return [Array<Grafeas::V1::RelatedUrl>]
-    #     URLs associated with this note.
-    # @!attribute [rw] expiration_time
-    #   @return [Google::Protobuf::Timestamp]
-    #     Time of expiration for this note. Empty if note does not expire.
-    # @!attribute [rw] create_time
-    #   @return [Google::Protobuf::Timestamp]
-    #     Output only. The time this note was created. This field can be used as a
-    #     filter in list requests.
-    # @!attribute [rw] update_time
-    #   @return [Google::Protobuf::Timestamp]
-    #     Output only. The time this note was last updated. This field can be used as
-    #     a filter in list requests.
-    # @!attribute [rw] related_note_names
-    #   @return [Array<String>]
-    #     Other notes related to this note.
-    # @!attribute [rw] vulnerability
-    #   @return [Grafeas::V1::VulnerabilityNote]
-    #     A note describing a package vulnerability.
-    # @!attribute [rw] build
-    #   @return [Grafeas::V1::BuildNote]
-    #     A note describing build provenance for a verifiable build.
-    # @!attribute [rw] image
-    #   @return [Grafeas::V1::ImageNote]
-    #     A note describing a base image.
-    # @!attribute [rw] package
-    #   @return [Grafeas::V1::PackageNote]
-    #     A note describing a package hosted by various package managers.
-    # @!attribute [rw] deployment
-    #   @return [Grafeas::V1::DeploymentNote]
-    #     A note describing something that can be deployed.
-    # @!attribute [rw] discovery
-    #   @return [Grafeas::V1::DiscoveryNote]
-    #     A note describing the initial analysis of a resource.
-    # @!attribute [rw] attestation
-    #   @return [Grafeas::V1::AttestationNote]
-    #     A note describing an attestation role.
-    class Note; end
-
-    # Request to get an occurrence.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The name of the occurrence in the form of
-    #     `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
-    class GetOccurrenceRequest; end
-
-    # Request to list occurrences.
-    # @!attribute [rw] parent
-    #   @return [String]
-    #     The name of the project to list occurrences for in the form of
-    #     `projects/[PROJECT_ID]`.
-    # @!attribute [rw] filter
-    #   @return [String]
-    #     The filter expression.
-    # @!attribute [rw] page_size
-    #   @return [Integer]
-    #     Number of occurrences to return in the list. Must be positive. Max allowed
-    #     page size is 1000. If not specified, page size defaults to 20.
-    # @!attribute [rw] page_token
-    #   @return [String]
-    #     Token to provide to skip to a particular spot in the list.
-    class ListOccurrencesRequest; end
-
-    # Response for listing occurrences.
-    # @!attribute [rw] occurrences
-    #   @return [Array<Grafeas::V1::Occurrence>]
-    #     The occurrences requested.
-    # @!attribute [rw] next_page_token
-    #   @return [String]
-    #     The next pagination token in the list response. It should be used as
-    #     `page_token` for the following request. An empty value means no more
-    #     results.
-    class ListOccurrencesResponse; end
-
-    # Request to delete a occurrence.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The name of the occurrence in the form of
-    #     `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
-    class DeleteOccurrenceRequest; end
-
-    # Request to create a new occurrence.
-    # @!attribute [rw] parent
-    #   @return [String]
-    #     The name of the project in the form of `projects/[PROJECT_ID]`, under which
-    #     the occurrence is to be created.
-    # @!attribute [rw] occurrence
-    #   @return [Grafeas::V1::Occurrence]
-    #     The occurrence to create.
-    class CreateOccurrenceRequest; end
-
-    # Request to update an occurrence.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The name of the occurrence in the form of
-    #     `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
-    # @!attribute [rw] occurrence
-    #   @return [Grafeas::V1::Occurrence]
-    #     The updated occurrence.
-    # @!attribute [rw] update_mask
-    #   @return [Google::Protobuf::FieldMask]
-    #     The fields to update.
-    class UpdateOccurrenceRequest; end
-
-    # Request to get a note.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The name of the note in the form of
-    #     `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
-    class GetNoteRequest; end
-
-    # Request to get the note to which the specified occurrence is attached.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The name of the occurrence in the form of
-    #     `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
-    class GetOccurrenceNoteRequest; end
-
-    # Request to list notes.
-    # @!attribute [rw] parent
-    #   @return [String]
-    #     The name of the project to list notes for in the form of
-    #     `projects/[PROJECT_ID]`.
-    # @!attribute [rw] filter
-    #   @return [String]
-    #     The filter expression.
-    # @!attribute [rw] page_size
-    #   @return [Integer]
-    #     Number of notes to return in the list. Must be positive. Max allowed page
-    #     size is 1000. If not specified, page size defaults to 20.
-    # @!attribute [rw] page_token
-    #   @return [String]
-    #     Token to provide to skip to a particular spot in the list.
-    class ListNotesRequest; end
-
-    # Response for listing notes.
-    # @!attribute [rw] notes
-    #   @return [Array<Grafeas::V1::Note>]
-    #     The notes requested.
-    # @!attribute [rw] next_page_token
-    #   @return [String]
-    #     The next pagination token in the list response. It should be used as
-    #     `page_token` for the following request. An empty value means no more
-    #     results.
-    class ListNotesResponse; end
-
-    # Request to delete a note.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The name of the note in the form of
-    #     `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
-    class DeleteNoteRequest; end
-
-    # Request to create a new note.
-    # @!attribute [rw] parent
-    #   @return [String]
-    #     The name of the project in the form of `projects/[PROJECT_ID]`, under which
-    #     the note is to be created.
-    # @!attribute [rw] note_id
-    #   @return [String]
-    #     The ID to use for this note.
-    # @!attribute [rw] note
-    #   @return [Grafeas::V1::Note]
-    #     The note to create.
-    class CreateNoteRequest; end
-
-    # Request to update a note.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The name of the note in the form of
-    #     `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
-    # @!attribute [rw] note
-    #   @return [Grafeas::V1::Note]
-    #     The updated note.
-    # @!attribute [rw] update_mask
-    #   @return [Google::Protobuf::FieldMask]
-    #     The fields to update.
-    class UpdateNoteRequest; end
-
-    # Request to list occurrences for a note.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The name of the note to list occurrences for in the form of
-    #     `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
-    # @!attribute [rw] filter
-    #   @return [String]
-    #     The filter expression.
-    # @!attribute [rw] page_size
-    #   @return [Integer]
-    #     Number of occurrences to return in the list.
-    # @!attribute [rw] page_token
-    #   @return [String]
-    #     Token to provide to skip to a particular spot in the list.
-    class ListNoteOccurrencesRequest; end
-
-    # Response for listing occurrences for a note.
-    # @!attribute [rw] occurrences
-    #   @return [Array<Grafeas::V1::Occurrence>]
-    #     The occurrences attached to the specified note.
-    # @!attribute [rw] next_page_token
-    #   @return [String]
-    #     Token to provide to skip to a particular spot in the list.
-    class ListNoteOccurrencesResponse; end
-
-    # Request to create notes in batch.
-    # @!attribute [rw] parent
-    #   @return [String]
-    #     The name of the project in the form of `projects/[PROJECT_ID]`, under which
-    #     the notes are to be created.
-    # @!attribute [rw] notes
-    #   @return [Hash{String => Grafeas::V1::Note}]
-    #     The notes to create. Max allowed length is 1000.
-    class BatchCreateNotesRequest; end
-
-    # Response for creating notes in batch.
-    # @!attribute [rw] notes
-    #   @return [Array<Grafeas::V1::Note>]
-    #     The notes that were created.
-    class BatchCreateNotesResponse; end
-
-    # Request to create occurrences in batch.
-    # @!attribute [rw] parent
-    #   @return [String]
-    #     The name of the project in the form of `projects/[PROJECT_ID]`, under which
-    #     the occurrences are to be created.
-    # @!attribute [rw] occurrences
-    #   @return [Array<Grafeas::V1::Occurrence>]
-    #     The occurrences to create. Max allowed length is 1000.
-    class BatchCreateOccurrencesRequest; end
-
-    # Response for creating occurrences in batch.
-    # @!attribute [rw] occurrences
-    #   @return [Array<Grafeas::V1::Occurrence>]
-    #     The occurrences that were created.
-    class BatchCreateOccurrencesResponse; end
-  end
-end

data/lib/grafeas/v1/doc/grafeas/v1/image.rb

@@ -1,79 +0,0 @@
-# Copyright 2019 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Grafeas
-  module V1
-    # Layer holds metadata specific to a layer of a Docker image.
-    # @!attribute [rw] directive
-    #   @return [String]
-    #     Required. The recovered Dockerfile directive used to construct this layer.
-    #     See https://docs.docker.com/engine/reference/builder/ for more information.
-    # @!attribute [rw] arguments
-    #   @return [String]
-    #     The recovered arguments to the Dockerfile directive.
-    class Layer; end
-
-    # A set of properties that uniquely identify a given Docker image.
-    # @!attribute [rw] v1_name
-    #   @return [String]
-    #     Required. The layer ID of the final layer in the Docker image's v1
-    #     representation.
-    # @!attribute [rw] v2_blob
-    #   @return [Array<String>]
-    #     Required. The ordered list of v2 blobs that represent a given image.
-    # @!attribute [rw] v2_name
-    #   @return [String]
-    #     Output only. The name of the image's v2 blobs computed via:
-    #       [bottom] := v2_blob[bottom]
-    #       [N] := sha256(v2_blob[N] + " " + v2_name[N+1])
-    #     Only the name of the final blob is kept.
-    class Fingerprint; end
-
-    # Basis describes the base image portion (Note) of the DockerImage
-    # relationship. Linked occurrences are derived from this or an equivalent image
-    # via:
-    #   FROM <Basis.resource_url>
-    # Or an equivalent reference, e.g., a tag of the resource_url.
-    # @!attribute [rw] resource_url
-    #   @return [String]
-    #     Required. Immutable. The resource_url for the resource representing the
-    #     basis of associated occurrence images.
-    # @!attribute [rw] fingerprint
-    #   @return [Grafeas::V1::Fingerprint]
-    #     Required. Immutable. The fingerprint of the base image.
-    class ImageNote; end
-
-    # Details of the derived image portion of the DockerImage relationship. This
-    # image would be produced from a Dockerfile with FROM <DockerImage.Basis in
-    # attached Note>.
-    # @!attribute [rw] fingerprint
-    #   @return [Grafeas::V1::Fingerprint]
-    #     Required. The fingerprint of the derived image.
-    # @!attribute [rw] distance
-    #   @return [Integer]
-    #     Output only. The number of layers by which this image differs from the
-    #     associated image basis.
-    # @!attribute [rw] layer_info
-    #   @return [Array<Grafeas::V1::Layer>]
-    #     This contains layer-specific metadata, if populated it has length
-    #     "distance" and is ordered with [distance] being the layer immediately
-    #     following the base image and [1] being the final layer.
-    # @!attribute [rw] base_resource_url
-    #   @return [String]
-    #     Output only. This contains the base image URL for the derived image
-    #     occurrence.
-    class ImageOccurrence; end
-  end
-end

data/lib/grafeas/v1/doc/grafeas/v1/package.rb

@@ -1,125 +0,0 @@
-# Copyright 2019 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Grafeas
-  module V1
-    # This represents a particular channel of distribution for a given package.
-    # E.g., Debian's jessie-backports dpkg mirror.
-    # @!attribute [rw] cpe_uri
-    #   @return [String]
-    #     Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/)
-    #     denoting the package manager version distributing a package.
-    # @!attribute [rw] architecture
-    #   @return [Grafeas::V1::Architecture]
-    #     The CPU architecture for which packages in this distribution channel were
-    #     built.
-    # @!attribute [rw] latest_version
-    #   @return [Grafeas::V1::Version]
-    #     The latest available version of this package in this distribution channel.
-    # @!attribute [rw] maintainer
-    #   @return [String]
-    #     A freeform string denoting the maintainer of this package.
-    # @!attribute [rw] url
-    #   @return [String]
-    #     The distribution channel-specific homepage for this package.
-    # @!attribute [rw] description
-    #   @return [String]
-    #     The distribution channel-specific description of this package.
-    class Distribution; end
-
-    # An occurrence of a particular package installation found within a system's
-    # filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.
-    # @!attribute [rw] cpe_uri
-    #   @return [String]
-    #     Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/)
-    #     denoting the package manager version distributing a package.
-    # @!attribute [rw] version
-    #   @return [Grafeas::V1::Version]
-    #     The version installed at this location.
-    # @!attribute [rw] path
-    #   @return [String]
-    #     The path from which we gathered that this package/version is installed.
-    class Location; end
-
-    # This represents a particular package that is distributed over various
-    # channels. E.g., glibc (aka libc6) is distributed by many, at various
-    # versions.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     Required. Immutable. The name of the package.
-    # @!attribute [rw] distribution
-    #   @return [Array<Grafeas::V1::Distribution>]
-    #     The various channels by which a package is distributed.
-    class PackageNote; end
-
-    # Details on how a particular software package was installed on a system.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     Output only. The name of the installed package.
-    # @!attribute [rw] location
-    #   @return [Array<Grafeas::V1::Location>]
-    #     Required. All of the places within the filesystem versions of this package
-    #     have been found.
-    class PackageOccurrence; end
-
-    # Version contains structured information about the version of a package.
-    # @!attribute [rw] epoch
-    #   @return [Integer]
-    #     Used to correct mistakes in the version numbering scheme.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     Required only when version kind is NORMAL. The main part of the version
-    #     name.
-    # @!attribute [rw] revision
-    #   @return [String]
-    #     The iteration of the package build from the above version.
-    # @!attribute [rw] kind
-    #   @return [Grafeas::V1::Version::VersionKind]
-    #     Required. Distinguishes between sentinel MIN/MAX versions and normal
-    #     versions.
-    # @!attribute [rw] full_name
-    #   @return [String]
-    #     Human readable version string. This string is of the form
-    #     <epoch>:<name>-<revision> and is only set when kind is NORMAL.
-    class Version
-      # Whether this is an ordinary package version or a sentinel MIN/MAX version.
-      module VersionKind
-        # Unknown.
-        VERSION_KIND_UNSPECIFIED = 0
-
-        # A standard package version.
-        NORMAL = 1
-
-        # A special version representing negative infinity.
-        MINIMUM = 2
-
-        # A special version representing positive infinity.
-        MAXIMUM = 3
-      end
-    end
-
-    # Instruction set architectures supported by various package managers.
-    module Architecture
-      # Unknown architecture.
-      ARCHITECTURE_UNSPECIFIED = 0
-
-      # X86 architecture.
-      X86 = 1
-
-      # X64 architecture.
-      X64 = 2
-    end
-  end
-end