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.



3216
3217
3218
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3216

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) 


3166
3167
3168
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3166

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) 


3173
3174
3175
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3173

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


3179
3180
3181
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3179

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) 


3185
3186
3187
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3185

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


3190
3191
3192
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3190

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) 


3196
3197
3198
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3196

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) 


3202
3203
3204
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3202

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) 


3209
3210
3211
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3209

def namespace
  @namespace
end

#title ⇒ String

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

Returns:

  • (String) 


3214
3215
3216
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3214

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 3221

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