Reference documentation and code samples for the Chronicle V1 API class Google::Backstory::Asset.
Information about a compute asset such as a workstation, laptop, phone, virtual desktop, or VM.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#asset_id
def asset_id() -> ::String
Returns
- (::String) — The asset ID. Value must contain the ':' character. For example, cs:abcdd23434. This field can be used as an entity indicator for asset entities.
#asset_id=
def asset_id=(value) -> ::String
Parameter
- value (::String) — The asset ID. Value must contain the ':' character. For example, cs:abcdd23434. This field can be used as an entity indicator for asset entities.
Returns
- (::String) — The asset ID. Value must contain the ':' character. For example, cs:abcdd23434. This field can be used as an entity indicator for asset entities.
#attribute
def attribute() -> ::Google::Backstory::Attribute
Returns
- (::Google::Backstory::Attribute) — Generic entity metadata attributes of the asset.
#attribute=
def attribute=(value) -> ::Google::Backstory::Attribute
Parameter
- value (::Google::Backstory::Attribute) — Generic entity metadata attributes of the asset.
Returns
- (::Google::Backstory::Attribute) — Generic entity metadata attributes of the asset.
#category
def category() -> ::String
Returns
- (::String) — The category of the asset (e.g. "End User Asset", "Workstation", "Server").
#category=
def category=(value) -> ::String
Parameter
- value (::String) — The category of the asset (e.g. "End User Asset", "Workstation", "Server").
Returns
- (::String) — The category of the asset (e.g. "End User Asset", "Workstation", "Server").
#creation_time
def creation_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Time the asset was created or provisioned. Deprecate: creation_time should be populated in Attribute as generic metadata.
#creation_time=
def creation_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Time the asset was created or provisioned. Deprecate: creation_time should be populated in Attribute as generic metadata.
Returns
- (::Google::Protobuf::Timestamp) — Time the asset was created or provisioned. Deprecate: creation_time should be populated in Attribute as generic metadata.
#deployment_status
def deployment_status() -> ::Google::Backstory::Asset::DeploymentStatus
Returns
- (::Google::Backstory::Asset::DeploymentStatus) — The deployment status of the asset for device lifecycle purposes.
#deployment_status=
def deployment_status=(value) -> ::Google::Backstory::Asset::DeploymentStatus
Parameter
- value (::Google::Backstory::Asset::DeploymentStatus) — The deployment status of the asset for device lifecycle purposes.
Returns
- (::Google::Backstory::Asset::DeploymentStatus) — The deployment status of the asset for device lifecycle purposes.
#first_discover_time
def first_discover_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Time the asset was first discovered (by asset management/discoverability software).
#first_discover_time=
def first_discover_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Time the asset was first discovered (by asset management/discoverability software).
Returns
- (::Google::Protobuf::Timestamp) — Time the asset was first discovered (by asset management/discoverability software).
#first_seen_time
def first_seen_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — The first observed time for an asset. The value is calculated on the basis of the first time the identifier was observed.
#first_seen_time=
def first_seen_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — The first observed time for an asset. The value is calculated on the basis of the first time the identifier was observed.
Returns
- (::Google::Protobuf::Timestamp) — The first observed time for an asset. The value is calculated on the basis of the first time the identifier was observed.
#hardware
def hardware() -> ::Array<::Google::Backstory::Hardware>
Returns
- (::Array<::Google::Backstory::Hardware>) — The asset hardware specifications.
#hardware=
def hardware=(value) -> ::Array<::Google::Backstory::Hardware>
Parameter
- value (::Array<::Google::Backstory::Hardware>) — The asset hardware specifications.
Returns
- (::Array<::Google::Backstory::Hardware>) — The asset hardware specifications.
#hostname
def hostname() -> ::String
Returns
- (::String) — Asset hostname or domain name field. This field can be used as an entity indicator for asset entities.
#hostname=
def hostname=(value) -> ::String
Parameter
- value (::String) — Asset hostname or domain name field. This field can be used as an entity indicator for asset entities.
Returns
- (::String) — Asset hostname or domain name field. This field can be used as an entity indicator for asset entities.
#ip
def ip() -> ::Array<::String>
Returns
- (::Array<::String>) — A list of IP addresses associated with an asset. This field can be used as an entity indicator for asset entities.
#ip=
def ip=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — A list of IP addresses associated with an asset. This field can be used as an entity indicator for asset entities.
Returns
- (::Array<::String>) — A list of IP addresses associated with an asset. This field can be used as an entity indicator for asset entities.
#labels
def labels() -> ::Array<::Google::Backstory::Label>
Returns
- (::Array<::Google::Backstory::Label>) — Metadata labels for the asset. Deprecated: labels should be populated in Attribute as generic metadata.
#labels=
def labels=(value) -> ::Array<::Google::Backstory::Label>
Parameter
- value (::Array<::Google::Backstory::Label>) — Metadata labels for the asset. Deprecated: labels should be populated in Attribute as generic metadata.
Returns
- (::Array<::Google::Backstory::Label>) — Metadata labels for the asset. Deprecated: labels should be populated in Attribute as generic metadata.
#last_boot_time
def last_boot_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Time the asset was last boot started.
#last_boot_time=
def last_boot_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Time the asset was last boot started.
Returns
- (::Google::Protobuf::Timestamp) — Time the asset was last boot started.
#last_discover_time
def last_discover_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Time the asset was last discovered (by asset management/discoverability software).
#last_discover_time=
def last_discover_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Time the asset was last discovered (by asset management/discoverability software).
Returns
- (::Google::Protobuf::Timestamp) — Time the asset was last discovered (by asset management/discoverability software).
#location
def location() -> ::Google::Backstory::Location
Returns
- (::Google::Backstory::Location) — Location of the asset.
#location=
def location=(value) -> ::Google::Backstory::Location
Parameter
- value (::Google::Backstory::Location) — Location of the asset.
Returns
- (::Google::Backstory::Location) — Location of the asset.
#mac
def mac() -> ::Array<::String>
Returns
- (::Array<::String>) — List of MAC addresses associated with an asset. This field can be used as an entity indicator for asset entities.
#mac=
def mac=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — List of MAC addresses associated with an asset. This field can be used as an entity indicator for asset entities.
Returns
- (::Array<::String>) — List of MAC addresses associated with an asset. This field can be used as an entity indicator for asset entities.
#nat_ip
def nat_ip() -> ::Array<::String>
Returns
- (::Array<::String>) — List of NAT IP addresses associated with an asset.
#nat_ip=
def nat_ip=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — List of NAT IP addresses associated with an asset.
Returns
- (::Array<::String>) — List of NAT IP addresses associated with an asset.
#network_domain
def network_domain() -> ::String
Returns
- (::String) — The network domain of the asset (e.g. "corp.acme.com")
#network_domain=
def network_domain=(value) -> ::String
Parameter
- value (::String) — The network domain of the asset (e.g. "corp.acme.com")
Returns
- (::String) — The network domain of the asset (e.g. "corp.acme.com")
#platform_software
def platform_software() -> ::Google::Backstory::PlatformSoftware
Returns
- (::Google::Backstory::PlatformSoftware) — The asset operating system platform software.
#platform_software=
def platform_software=(value) -> ::Google::Backstory::PlatformSoftware
Parameter
- value (::Google::Backstory::PlatformSoftware) — The asset operating system platform software.
Returns
- (::Google::Backstory::PlatformSoftware) — The asset operating system platform software.
#product_object_id
def product_object_id() -> ::String
Returns
- (::String) — A vendor-specific identifier to uniquely identify the entity (a GUID or similar). This field can be used as an entity indicator for asset entities.
#product_object_id=
def product_object_id=(value) -> ::String
Parameter
- value (::String) — A vendor-specific identifier to uniquely identify the entity (a GUID or similar). This field can be used as an entity indicator for asset entities.
Returns
- (::String) — A vendor-specific identifier to uniquely identify the entity (a GUID or similar). This field can be used as an entity indicator for asset entities.
#software
def software() -> ::Array<::Google::Backstory::Software>
Returns
- (::Array<::Google::Backstory::Software>) — The asset software details.
#software=
def software=(value) -> ::Array<::Google::Backstory::Software>
Parameter
- value (::Array<::Google::Backstory::Software>) — The asset software details.
Returns
- (::Array<::Google::Backstory::Software>) — The asset software details.
#system_last_update_time
def system_last_update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Time the asset system or OS was last updated. For all other operations that are not system updates (such as resizing a VM), use Attribute.last_update_time.
#system_last_update_time=
def system_last_update_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Time the asset system or OS was last updated. For all other operations that are not system updates (such as resizing a VM), use Attribute.last_update_time.
Returns
- (::Google::Protobuf::Timestamp) — Time the asset system or OS was last updated. For all other operations that are not system updates (such as resizing a VM), use Attribute.last_update_time.
#type
def type() -> ::Google::Backstory::Asset::AssetType
Returns
- (::Google::Backstory::Asset::AssetType) — The type of the asset (e.g. workstation or laptop or server).
#type=
def type=(value) -> ::Google::Backstory::Asset::AssetType
Parameter
- value (::Google::Backstory::Asset::AssetType) — The type of the asset (e.g. workstation or laptop or server).
Returns
- (::Google::Backstory::Asset::AssetType) — The type of the asset (e.g. workstation or laptop or server).
#vulnerabilities
def vulnerabilities() -> ::Array<::Google::Backstory::Vulnerability>
Returns
- (::Array<::Google::Backstory::Vulnerability>) — Vulnerabilities discovered on asset.
#vulnerabilities=
def vulnerabilities=(value) -> ::Array<::Google::Backstory::Vulnerability>
Parameter
- value (::Array<::Google::Backstory::Vulnerability>) — Vulnerabilities discovered on asset.
Returns
- (::Array<::Google::Backstory::Vulnerability>) — Vulnerabilities discovered on asset.
#wmi_persistence_item
def wmi_persistence_item() -> ::Google::Backstory::WmiPersistenceItem
Returns
- (::Google::Backstory::WmiPersistenceItem) — Information about a WMI persistence item.
#wmi_persistence_item=
def wmi_persistence_item=(value) -> ::Google::Backstory::WmiPersistenceItem
Parameter
- value (::Google::Backstory::WmiPersistenceItem) — Information about a WMI persistence item.
Returns
- (::Google::Backstory::WmiPersistenceItem) — Information about a WMI persistence item.