Class: Google::Apis::ContaineranalysisV1alpha1::FileOccurrence

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

FileOccurrence represents an SPDX File Information section: https://spdx. github.io/spdx-spec/4-file-information/

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FileOccurrence

Returns a new instance of FileOccurrence.



1342
1343
1344
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1342

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

Instance Attribute Details

#attributionsArray<String>

This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts Corresponds to the JSON property attributions

Returns:

  • (Array<String>)


1292
1293
1294
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1292

def attributions
  @attributions
end

#commentString

This field provides a place for the SPDX file creator to record any general comments about the file Corresponds to the JSON property comment

Returns:

  • (String)


1298
1299
1300
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1298

def comment
  @comment
end

#contributorsArray<String>

This field provides a place for the SPDX file creator to record file contributors Corresponds to the JSON property contributors

Returns:

  • (Array<String>)


1304
1305
1306
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1304

def contributors
  @contributors
end

Identify the copyright holder of the file, as well as any dates present Corresponds to the JSON property copyright

Returns:

  • (String)


1309
1310
1311
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1309

def copyright
  @copyright
end

#files_license_infoArray<String>

This field contains the license information actually found in the file, if any Corresponds to the JSON property filesLicenseInfo

Returns:

  • (Array<String>)


1314
1315
1316
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1314

def files_license_info
  @files_license_info
end

#idString

Uniquely identify any element in an SPDX document which may be referenced by other elements Corresponds to the JSON property id

Returns:

  • (String)


1320
1321
1322
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1320

def id
  @id
end

#license_commentsString

This field provides a place for the SPDX file creator to record any relevant background references or analysis that went in to arriving at the Concluded License for a file Corresponds to the JSON property licenseComments

Returns:

  • (String)


1327
1328
1329
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1327

def license_comments
  @license_comments
end

#license_concludedString

This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined Corresponds to the JSON property licenseConcluded

Returns:

  • (String)


1334
1335
1336
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1334

def license_concluded
  @license_concluded
end

#noticeString

This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file Corresponds to the JSON property notice

Returns:

  • (String)


1340
1341
1342
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1340

def notice
  @notice
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1347

def update!(**args)
  @attributions = args[:attributions] if args.key?(:attributions)
  @comment = args[:comment] if args.key?(:comment)
  @contributors = args[:contributors] if args.key?(:contributors)
  @copyright = args[:copyright] if args.key?(:copyright)
  @files_license_info = args[:files_license_info] if args.key?(:files_license_info)
  @id = args[:id] if args.key?(:id)
  @license_comments = args[:license_comments] if args.key?(:license_comments)
  @license_concluded = args[:license_concluded] if args.key?(:license_concluded)
  @notice = args[:notice] if args.key?(:notice)
end