Class: SBOM::CycloneDX::Record::Commit

Inherits:

Base

• Object
• Base
• SBOM::CycloneDX::Record::Commit

Defined in:

lib/sbom/cyclone_dx/record/commit.rb,
sig/sbom/cyclone_dx/record/commit.rbs

Overview

Schema name: Commit

Constant Summary

Constants inherited from Base

Base::Record

Instance Attribute Summary

Attributes inherited from Base

#errors

Instance Method Summary

• #author ⇒ IdentifiableAction^?
• #author= ⇒ IdentifiableAction^?
• #author? ⇒ Boolean
• #author_valid? ⇒ Boolean
• #committer ⇒ IdentifiableAction^?
• #committer= ⇒ IdentifiableAction^?
• #committer? ⇒ Boolean
• #committer_valid? ⇒ Boolean
• #initialize ⇒ Commit constructor

  A new instance of Commit.

• #message ⇒ String^?
• #message= ⇒ String^?
• #message? ⇒ Boolean
• #message_valid? ⇒ Boolean
• #uid ⇒ String^?
• #uid= ⇒ String^?
• #uid? ⇒ Boolean
• #uid_valid? ⇒ Boolean
• #url ⇒ uri^?
• #url= ⇒ uri^?
• #url? ⇒ Boolean
• #url_valid? ⇒ Boolean

Methods inherited from Base

#<=>, const, custom_validators, fields, #formatted_errors, json_create, json_name, prop, #valid!, #valid?, validate

Methods included from _Klass

#const, #const_names, #create, #create!, #custom_validators, #fields, #json_name, #prop, #prop_names, #validate

Methods included from _Instance

#as_json, #errors, #formatted_errors, #to_json, #valid?

Constructor Details

#initialize ⇒ Commit

Returns a new instance of Commit.

Parameters:

• uid: (String, nil)
• url: (uri, nil)
• author: (IdentifiableAction, nil)
• committer: (IdentifiableAction, nil)
• message: (String, nil)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 5

def initialize: (?uid: String?, ?url: uri?, ?author: IdentifiableAction?, ?committer: IdentifiableAction?, ?message: String?) -> void

Instance Method Details

#author ⇒ IdentifiableAction^?

Returns:

• (IdentifiableAction, nil)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 17

def author: () -> IdentifiableAction?

#author= ⇒ IdentifiableAction^?

Parameters:

• (IdentifiableAction, nil)

Returns:

• (IdentifiableAction, nil)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 18

def author=: (IdentifiableAction?) -> IdentifiableAction?

#author? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 19

def author?: () -> bool

#author_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 20

def author_valid?: () -> bool

#committer ⇒ IdentifiableAction^?

Returns:

• (IdentifiableAction, nil)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 22

def committer: () -> IdentifiableAction?

#committer= ⇒ IdentifiableAction^?

Parameters:

• (IdentifiableAction, nil)

Returns:

• (IdentifiableAction, nil)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 23

def committer=: (IdentifiableAction?) -> IdentifiableAction?

#committer? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 24

def committer?: () -> bool

#committer_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 25

def committer_valid?: () -> bool

#message ⇒ String^?

Returns:

• (String, nil)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 27

def message: () -> String?

#message= ⇒ String^?

Parameters:

• (String, nil)

Returns:

• (String, nil)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 28

def message=: (String?) -> String?

#message? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 29

def message?: () -> bool

#message_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 30

def message_valid?: () -> bool

#uid ⇒ String^?

Returns:

• (String, nil)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 7

def uid: () -> String?

#uid= ⇒ String^?

Parameters:

• (String, nil)

Returns:

• (String, nil)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 8

def uid=: (String?) -> String?

#uid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 9

def uid?: () -> bool

#uid_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 10

def uid_valid?: () -> bool

#url ⇒ uri^?

Returns:

• (uri, nil)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 12

def url: () -> uri?

#url= ⇒ uri^?

Parameters:

• (uri, nil)

Returns:

• (uri, nil)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 13

def url=: (uri?) -> uri?

#url? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 14

def url?: () -> bool

#url_valid? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/sbom/cyclone_dx/record/commit.rbs', line 15

def url_valid?: () -> bool