Class: Grafeas::V1::AttestationNote

Inherits:
Object
  • Object
show all
Defined in:
lib/grafeas/v1/doc/grafeas/v1/attestation.rb

Overview

Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one Authority for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project.

Defined Under Namespace

Classes: Hint

Instance Attribute Summary collapse

Instance Attribute Details

#hint ⇒ Grafeas::V1::AttestationNote::Hint

Returns Hint hints at the purpose of the attestation authority.

Returns:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/grafeas/v1/doc/grafeas/v1/attestation.rb', line 29

class AttestationNote
  # This submessage provides human-readable hints about the purpose of the
  # authority. Because the name of a note acts as its resource reference, it is
  # important to disambiguate the canonical name of the Note (which might be a
  # UUID for security purposes) from "readable" names more suitable for debug
  # output. Note that these hints should not be used to look up authorities in
  # security sensitive contexts, such as when looking up attestations to
  # verify.
  # @!attribute [rw] human_readable_name
  #   @return [String]
  #     Required. The human readable name of this attestation authority, for
  #     example "qa".
  class Hint; end
end