grafeas 0.3.1 → 1.0.0

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

@@ -1,64 +0,0 @@
-# Copyright 2020 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 artifact that can be deployed in some runtime.
-    # @!attribute [rw] resource_uri
-    #   @return [Array<String>]
-    #     Required. Resource URI for the artifact being deployed.
-    class DeploymentNote; end
-
-    # The period during which some deployable was active in a runtime.
-    # @!attribute [rw] user_email
-    #   @return [String]
-    #     Identity of the user that triggered this deployment.
-    # @!attribute [rw] deploy_time
-    #   @return [Google::Protobuf::Timestamp]
-    #     Required. Beginning of the lifetime of this deployment.
-    # @!attribute [rw] undeploy_time
-    #   @return [Google::Protobuf::Timestamp]
-    #     End of the lifetime of this deployment.
-    # @!attribute [rw] config
-    #   @return [String]
-    #     Configuration used to create this deployment.
-    # @!attribute [rw] address
-    #   @return [String]
-    #     Address of the runtime element hosting this deployment.
-    # @!attribute [rw] resource_uri
-    #   @return [Array<String>]
-    #     Output only. Resource URI for the artifact being deployed taken from
-    #     the deployable field with the same name.
-    # @!attribute [rw] platform
-    #   @return [Grafeas::V1::DeploymentOccurrence::Platform]
-    #     Platform hosting this deployment.
-    class DeploymentOccurrence
-      # Types of platforms.
-      module Platform
-        # Unknown.
-        PLATFORM_UNSPECIFIED = 0
-
-        # Google Container Engine.
-        GKE = 1
-
-        # Google App Engine: Flexible Environment.
-        FLEX = 2
-
-        # Custom user-defined platform.
-        CUSTOM = 3
-      end
-    end
-  end
-end

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

@@ -1,82 +0,0 @@
-# Copyright 2020 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
-    # A note that indicates a type of analysis a provider would perform. This note
-    # exists in a provider's project. A `Discovery` occurrence is created in a
-    # consumer's project at the start of analysis.
-    # @!attribute [rw] analysis_kind
-    #   @return [Grafeas::V1::NoteKind]
-    #     Required. Immutable. The kind of analysis that is handled by this
-    #     discovery.
-    class DiscoveryNote; end
-
-    # Provides information about the analysis status of a discovered resource.
-    # @!attribute [rw] continuous_analysis
-    #   @return [Grafeas::V1::DiscoveryOccurrence::ContinuousAnalysis]
-    #     Whether the resource is continuously analyzed.
-    # @!attribute [rw] analysis_status
-    #   @return [Grafeas::V1::DiscoveryOccurrence::AnalysisStatus]
-    #     The status of discovery for the resource.
-    # @!attribute [rw] analysis_status_error
-    #   @return [Google::Rpc::Status]
-    #     When an error is encountered this will contain a LocalizedMessage under
-    #     details to show to the user. The LocalizedMessage is output only and
-    #     populated by the API.
-    # @!attribute [rw] cpe
-    #   @return [String]
-    #     The CPE of the resource being scanned.
-    # @!attribute [rw] last_scan_time
-    #   @return [Google::Protobuf::Timestamp]
-    #     The last time this resource was scanned.
-    class DiscoveryOccurrence
-      # Analysis status for a resource. Currently for initial analysis only (not
-      # updated in continuous analysis).
-      module AnalysisStatus
-        # Unknown.
-        ANALYSIS_STATUS_UNSPECIFIED = 0
-
-        # Resource is known but no action has been taken yet.
-        PENDING = 1
-
-        # Resource is being analyzed.
-        SCANNING = 2
-
-        # Analysis has finished successfully.
-        FINISHED_SUCCESS = 3
-
-        # Analysis has finished unsuccessfully, the analysis itself is in a bad
-        # state.
-        FINISHED_FAILED = 4
-
-        # The resource is known not to be supported
-        FINISHED_UNSUPPORTED = 5
-      end
-
-      # Whether the resource is continuously analyzed.
-      module ContinuousAnalysis
-        # Unknown.
-        CONTINUOUS_ANALYSIS_UNSPECIFIED = 0
-
-        # The resource is continuously analyzed.
-        ACTIVE = 1
-
-        # The resource is ignored for continuous analysis.
-        INACTIVE = 2
-      end
-    end
-  end
-end

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

@@ -1,328 +0,0 @@
-# Copyright 2020 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.
-    # @!attribute [rw] upgrade
-    #   @return [Grafeas::V1::UpgradeOccurrence]
-    #     Describes an available package upgrade on the linked resource.
-    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.
-    # @!attribute [rw] upgrade
-    #   @return [Grafeas::V1::UpgradeNote]
-    #     A note describing available package upgrades.
-    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 an 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