Class: Google::Apis::ContaineranalysisV1alpha1::DocumentOccurrence

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/containeranalysis_v1alpha1/classes.rb,
lib/google/apis/containeranalysis_v1alpha1/representations.rb,
lib/google/apis/containeranalysis_v1alpha1/representations.rb

Overview

DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DocumentOccurrence

Returns a new instance of DocumentOccurrence.



3374
3375
3376
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3374

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard Corresponds to the JSON property createTime

Returns:

  • (String) 


3324
3325
3326
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3324

def create_time
  @create_time
end

#creator_comment ⇒ String

A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields Corresponds to the JSON property creatorComment

Returns:

  • (String) 


3331
3332
3333
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3331

def creator_comment
  @creator_comment
end

#creators ⇒ Array<String>

Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name Corresponds to the JSON property creators

Returns:

  • (Array<String>) 


3337
3338
3339
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3337

def creators
  @creators
end

#document_comment ⇒ String

A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document Corresponds to the JSON property documentComment

Returns:

  • (String) 


3343
3344
3345
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3343

def document_comment
  @document_comment
end

#external_document_refs ⇒ Array<String>

Identify any external SPDX documents referenced within this SPDX document Corresponds to the JSON property externalDocumentRefs

Returns:

  • (Array<String>) 


3348
3349
3350
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3348

def external_document_refs
  @external_document_refs
end

#id ⇒ String

Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally Corresponds to the JSON property id

Returns:

  • (String) 


3354
3355
3356
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3354

def id
  @id
end

#license_list_version ⇒ String

A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created Corresponds to the JSON property licenseListVersion

Returns:

  • (String) 


3360
3361
3362
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3360

def license_list_version
  @license_list_version
end

#namespace ⇒ String

Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘

’ delimiter

Corresponds to the JSON property namespace

Returns:

  • (String) 


3367
3368
3369
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3367

def namespace
  @namespace
end

#title ⇒ String

Identify name of this document as designated by creator Corresponds to the JSON property title

Returns:

  • (String) 


3372
3373
3374
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3372

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3379

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @creator_comment = args[:creator_comment] if args.key?(:creator_comment)
  @creators = args[:creators] if args.key?(:creators)
  @document_comment = args[:document_comment] if args.key?(:document_comment)
  @external_document_refs = args[:external_document_refs] if args.key?(:external_document_refs)
  @id = args[:id] if args.key?(:id)
  @license_list_version = args[:license_list_version] if args.key?(:license_list_version)
  @namespace = args[:namespace] if args.key?(:namespace)
  @title = args[:title] if args.key?(:title)
end