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.



1540
1541
1542
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1540

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


1490
1491
1492
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1490

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)


1496
1497
1498
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1496

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


1502
1503
1504
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1502

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)


1507
1508
1509
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1507

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


1512
1513
1514
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1512

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)


1518
1519
1520
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1518

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)


1525
1526
1527
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1525

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)


1532
1533
1534
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1532

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)


1538
1539
1540
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1538

def notice
  @notice
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1545

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