io.cdap.cdap.api.artifact

Class ArtifactSummary

java.lang.Object

io.cdap.cdap.api.artifact.ArtifactSummary

Direct Known Subclasses:

ArtifactInfo

@Beta
public class ArtifactSummary
extends Object

Represents an artifact returned by /artifacts and /artifacts/{artifact-name}.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name
protected ArtifactScope	scope
protected String	version

Constructor Summary

Constructors

Constructor and Description
ArtifactSummary(String name, String version)
ArtifactSummary(String name, String version, ArtifactScope scope)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static ArtifactSummary	from(ArtifactId artifactId)
String	getName() get the name of the artifact
ArtifactScope	getScope() get the scope of the artifact
String	getVersion() get the version of artifact
int	hashCode()
String	toString()
void	validate() Validate that the artifact fields are valid.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

name

protected final String name

version

protected final String version

scope

protected final ArtifactScope scope

Constructor Detail

ArtifactSummary

public ArtifactSummary(String name,
                       String version)

ArtifactSummary

public ArtifactSummary(String name,
                       String version,
                       ArtifactScope scope)

Method Detail

from

public static ArtifactSummary from(ArtifactId artifactId)

getName

public String getName()

get the name of the artifact

Returns:

name of the artifact

getVersion

public String getVersion()

get the version of artifact

Returns:

artifact version

getScope

public ArtifactScope getScope()

get the scope of the artifact

Returns:

artifact scope

validate

public void validate()

Validate that the artifact fields are valid. Should be called when this object is created through deserializing user input.

Throws:

IllegalArgumentException - if the artifact summary is invalid

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object