Class: Google::Apis::ContaineranalysisV1beta1::DocumentOccurrence

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DocumentOccurrence

Returns a new instance of DocumentOccurrence.



3254
3255
3256
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3254

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) 


3204
3205
3206
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3204

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) 


3211
3212
3213
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3211

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>) 


3217
3218
3219
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3217

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) 


3223
3224
3225
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3223

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>) 


3228
3229
3230
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3228

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) 


3234
3235
3236
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3234

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) 


3240
3241
3242
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3240

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) 


3247
3248
3249
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3247

def namespace
  @namespace
end

#title ⇒ String

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

Returns:

  • (String) 


3252
3253
3254
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3252

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 3259

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