AssetSummary (Open Connector Framework (OCF) 2.11 API)

java.lang.Object
- org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyElementBase
- - org.odpi.openmetadata.frameworks.connectors.properties.AssetDescriptor
  - - org.odpi.openmetadata.frameworks.connectors.properties.AssetSummary

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AssetDetail
```
public class AssetSummary
extends AssetDescriptor
```
AssetSummary holds asset properties that are used for displaying details of an asset in summary lists or hover text. It includes the following properties:
- type - metadata type information for the asset
- guid - globally unique identifier for the asset
- url - external link for the asset
- qualifiedName - The official (unique) name for the asset. This is often defined by the IT systems management organization and should be used (when available) on audit logs and error messages. (Sourced from qualifiedName from Referenceable - model 0010)
- displayName - A consumable name for the asset. Often a shortened form of the asset's qualifiedName for use on user interfaces and messages. The asset's displayName should be only be used for audit logs and error messages if the qualifiedName is not set. (Sourced from displayName attribute name within Asset - model 0010)
- shortDescription - short description about the asset. (Sourced from assetSummary within ConnectionsToAsset - model 0205)
- description - full description of the asset. (Sourced from attribute description within Asset - model 0010)
- owner - name of the person or organization that owns the asset. (Sourced from classification AssetOwnership or Ownership attached to Asset - model 0445)
- ownerTypeName - name of the element type identifying the person or organization that owns the asset. (Sourced from classification AssetOwnership or Ownership attached to Asset - model 0445)
- ownerPropertyName - name of the property identifying person or organization that owns the asset. (Sourced from classification AssetOwnership or Ownership attached to Asset - model 0445)
- ownerType - type of the the person or organization that owns the asset. (Sourced from classification AssetOwnership attached to Asset - model 0445)
- zoneMembership - list of governance zones assigned to the asset
- classifications - list of classifications assigned to the asset
See Also:

Serialized Form

Field Summary
- Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetDescriptor
  assetBean

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AssetSummary()` Default constructor only for subclasses
	`AssetSummary(Asset assetBean)` Bean constructor - initializes AssetSummary using a bean returned by the REST interface.
	`AssetSummary(AssetSummary templateAssetSummary)` Copy/clone constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AdditionalProperties`	`getAdditionalProperties()` Return the set of additional properties.
`List<AssetClassification>`	`getAssetClassifications()` Return the list of classifications associated with the asset.
`String`	`getDescription()` Returns the stored description property for the asset.
`String`	`getDisplayName()` Returns the stored display name property for the asset.
`Map<String,Object>`	`getExtendedProperties()` Return the set of properties that are specific to the particular type of asset.
`String`	`getGUID()` Return the unique id for the properties object.
`String`	`getLatestChange()` Return a short description of the last change to the asset.
`Map<String,String>`	`getOrigins()` Return the properties that characterize where this asset is from.
`String`	`getOwner()` Returns the name of the owner for this asset.
`String`	`getOwnerPropertyName()` Return the property name that is being used to identify the owner.
`OwnerType`	`getOwnerType()` Deprecated.
`String`	`getOwnerTypeName()` Return the type name of the element representing the owner.
`String`	`getQualifiedName()` Returns the stored qualified name property for the asset.
`String`	`getShortDescription()` Returns the short description of the asset from relationship with Connection.
`AssetElementType`	`getType()` Return the element type properties for this asset.
`String`	`getURL()` Returns the URL to access the properties object in the metadata repository.
`List<String>`	`getZoneMembership()` Return the names of the zones that this asset is a member of.
`String`	`toString()` Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetDescriptor
equals, getAssetBean, getAssetName, getAssetSuperTypeNames, getAssetTypeName, hashCode, setAssetBean

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AssetSummary
```
protected AssetSummary()
```
    Default constructor only for subclasses
  - AssetSummary
```
public AssetSummary(Asset assetBean)
```
    Bean constructor - initializes AssetSummary using a bean returned by the REST interface.
    
    Parameters:
    
    assetBean - asset properties bean
  - AssetSummary
```
public AssetSummary(AssetSummary templateAssetSummary)
```
    Copy/clone constructor. Note, this is a deep copy
    
    Parameters:
    
    templateAssetSummary - template values for asset summary
- Method Detail
  - getType
```
public AssetElementType getType()
```
    Return the element type properties for this asset. These values are set up by the metadata repository and define details to the metadata entity used to represent this element.
    
    Returns:
    
    AssetElementType type information.
  - getGUID
```
public String getGUID()
```
    Return the unique id for the properties object. Null means no guid is assigned.
    
    Returns:
    
    String unique id
  - getURL
```
public String getURL()
```
    Returns the URL to access the properties object in the metadata repository. If no url is available then null is returned.
    
    Returns:
    
    String URL
  - getQualifiedName
```
public String getQualifiedName()
```
    Returns the stored qualified name property for the asset. If no qualified name is provided then null is returned.
    
    Returns:
    
    qualifiedName
  - getDisplayName
```
public String getDisplayName()
```
    Returns the stored display name property for the asset. If no display name is available then null is returned.
    
    Returns:
    
    displayName
  - getShortDescription
```
public String getShortDescription()
```
    Returns the short description of the asset from relationship with Connection.
    
    Returns:
    
    shortDescription String
  - getDescription
```
public String getDescription()
```
    Returns the stored description property for the asset. If no description is provided then null is returned.
    
    Returns:
    
    description String
  - getOwner
```
public String getOwner()
```
    Returns the name of the owner for this asset.
    
    Returns:
    
    owner String
  - getOwnerType
```
@Deprecated
public OwnerType getOwnerType()
```
    Deprecated.
    
    Return the type of owner stored in the owner property.
    
    Returns:
    
    OwnerType enum
  - getOwnerTypeName
```
public String getOwnerTypeName()
```
    Return the type name of the element representing the owner.
    
    Returns:
    
    type name String
  - getOwnerPropertyName
```
public String getOwnerPropertyName()
```
    Return the property name that is being used to identify the owner.
    
    Returns:
    
    property name String
  - getZoneMembership
```
public List<String> getZoneMembership()
```
    Return the names of the zones that this asset is a member of.
    
    Returns:
    
    list of zone names
  - getAssetClassifications
```
public List<AssetClassification> getAssetClassifications()
```
    Return the list of classifications associated with the asset.
    
    Returns:
    
    list of classifications
  - getOrigins
```
public Map<String,String> getOrigins()
```
    Return the properties that characterize where this asset is from.
    
    Returns:
    
    map of name value pairs, all strings
  - getLatestChange
```
public String getLatestChange()
```
    Return a short description of the last change to the asset.
    
    Returns:
    
    string description
  - getExtendedProperties
```
public Map<String,Object> getExtendedProperties()
```
    Return the set of properties that are specific to the particular type of asset. The caller is given their own copy of the property object. The properties are named entityName.attributeName. The values are all strings.
    
    Returns:
    
    asset properties using the name of attributes from the model.
  - getAdditionalProperties
```
public AdditionalProperties getAdditionalProperties()
```
    Return the set of additional properties.
    
    Returns:
    
    AdditionalProperties object.
  - toString
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    print out of variables in a JSON-style

Class AssetSummary

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetDescriptor

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetDescriptor

Methods inherited from class java.lang.Object

Constructor Detail

AssetSummary

AssetSummary

AssetSummary

Method Detail

getType

getGUID

getURL

getQualifiedName

getDisplayName

getShortDescription

getDescription

getOwner

getOwnerType

getOwnerTypeName

getOwnerPropertyName

getZoneMembership

getAssetClassifications

getOrigins

getLatestChange

getExtendedProperties

getAdditionalProperties

toString