Artifact

open class Artifact : PropertyOwner

A single artifact. In some cases, this artifact might be nested within another artifact.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
@SerializedName(value = "contents")
@Expose
open var contents: ArtifactContent
Represents the contents of an artifact.
Link copied to clipboard
@SerializedName(value = "description")
@Expose
open var description: Message
Encapsulates a message intended to be read by the end user.
Link copied to clipboard
@SerializedName(value = "encoding")
@Expose
open var encoding: String
Specifies the encoding for an artifact object that refers to a text file.
Link copied to clipboard
@SerializedName(value = "hashes")
@Expose
open var hashes: Hashes
A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.
Link copied to clipboard
@SerializedName(value = "lastModifiedTimeUtc")
@Expose
open var lastModifiedTimeUtc: Instant
The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified.
Link copied to clipboard
@SerializedName(value = "length")
@Expose
open var length: Integer
The length of the artifact in bytes.
Link copied to clipboard
@SerializedName(value = "location")
@Expose
open var location: ArtifactLocation
Specifies the location of an artifact.
Link copied to clipboard
@SerializedName(value = "mimeType")
@Expose
open var mimeType: String
The MIME type (RFC 2045) of the artifact.
Link copied to clipboard
@SerializedName(value = "offset")
@Expose
open var offset: Integer
The offset in bytes of the artifact within its containing artifact.
Link copied to clipboard
@SerializedName(value = "parentIndex")
@Expose
open var parentIndex: Integer
Identifies the index of the immediate parent of the artifact, if this artifact is nested.
Link copied to clipboard
@SerializedName(value = "properties")
@Expose
open var properties: PropertyBag
Key/value pairs that provide additional information about the object.
Link copied to clipboard
@SerializedName(value = "roles")
@Expose
open var roles: Set<Role>
The role or roles played by the artifact in the analysis.
Link copied to clipboard
@SerializedName(value = "sourceLanguage")
@Expose
open var sourceLanguage: String
Specifies the source language for any artifact object that refers to a text file that contains source code.

Functions

Link copied to clipboard
open fun equals(other: Any): Boolean
Link copied to clipboard
abstract fun getProperties(): PropertyBag
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
abstract fun setProperties(<set-?>: PropertyBag)
Link copied to clipboard
open fun toString(): String
Link copied to clipboard
open fun updateProperties(mutator: (in PropertyBag) -> Unit)
Link copied to clipboard
Link copied to clipboard
open fun withDescription(description: Message): Artifact
Link copied to clipboard
open fun withEncoding(encoding: String): Artifact
Link copied to clipboard
open fun withHashes(hashes: Hashes): Artifact
Link copied to clipboard
open fun withLastModifiedTimeUtc(lastModifiedTimeUtc: Instant): Artifact
Link copied to clipboard
open fun withLength(length: Integer): Artifact
Link copied to clipboard
Link copied to clipboard
open fun withMimeType(mimeType: String): Artifact
Link copied to clipboard
open fun withOffset(offset: Integer): Artifact
Link copied to clipboard
open fun withParentIndex(parentIndex: Integer): Artifact
Link copied to clipboard
open fun withProperties(properties: PropertyBag): Artifact
Link copied to clipboard
open fun withRoles(roles: Set<Role>): Artifact
Link copied to clipboard
open fun withSourceLanguage(sourceLanguage: String): Artifact