REST Resource: projects.locations.assets

Resource: Asset

An asset represents a resource in your environment. Asset types include virtual machines and databases.

JSON representation 
{
  "name": string,
  "title": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "attributes": {
    string: string,
    ...
  },
  "insightList": {
    object (InsightList)
  },
  "performanceData": {
    object (AssetPerformanceData)
  },
  "sources": [
    string
  ],
  "assignedGroups": [
    string
  ],
  "hidden": boolean,
  "hideReason": string,
  "hideTime": string,

  // Union field AssetInfo can be only one of the following:
  "virtualMachineDetails": {
    object (VirtualMachineDetails)
  }
  // End of list of possible types for union field AssetInfo.

  // Union field AssetDetails can be only one of the following:
  "machineDetails": {
    object (MachineDetails)
  },
  "databaseDeploymentDetails": {
    object (DatabaseDeploymentDetails)
  },
  "databaseDetails": {
    object (DatabaseDetails)
  }
  // End of list of possible types for union field AssetDetails.
}
Fields
name

string

Output only. The full name of the asset.
title

string

Output only. Server generated human readable name of the asset.
createTime

string (Timestamp format)

Output only. The timestamp when the asset was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The timestamp when the asset was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Labels as key value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
attributes

map (key: string, value: string)

Generic asset attributes.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
insightList

object (InsightList)

Output only. The list of insights associated with the asset.
performanceData

object (AssetPerformanceData)

Performance data for the asset.
sources[]

string

Output only. The list of sources contributing to the asset.
assignedGroups[]

string

Output only. The list of groups that the asset is assigned to.
hidden

boolean

Optional. Indicates if the asset is hidden.
hideReason

string

Optional. An optional reason for marking this asset as hidden.
hideTime

string (Timestamp format)

Output only. The timestamp when the asset was marked as hidden.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Union field AssetInfo. The internal information of an asset. Only one field can be specified with different attributes based on the type of the asset. AssetInfo can be only one of the following:
virtualMachineDetails

object (VirtualMachineDetails)

Output only. Asset information specific for virtual machines.
Union field AssetDetails. The internal information of an asset. Only one field can be specified with different attributes based on the type of the asset. AssetDetails can be only one of the following:
machineDetails

object (MachineDetails)

Output only. Asset information specific for virtual machines.
databaseDeploymentDetails

object (DatabaseDeploymentDetails)

Output only. Asset information specific for database deployments.
databaseDetails

object (DatabaseDetails)

Output only. Asset information specific for logical databases.

InsightList

Message containing insights list.

JSON representation 
{
  "insights": [
    {
      object (Insight)
    }
  ],
  "updateTime": string
}
Fields
insights[]

object (Insight)

Output only. Insights of the list.
updateTime

string (Timestamp format)

Output only. Update timestamp.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Insight

An insight about an asset.

JSON representation 
{

  // Union field insight can be only one of the following:
  "migrationInsight": {
    object (MigrationInsight)
  },
  "genericInsight": {
    object (GenericInsight)
  },
  "softwareInsight": {
    object (SoftwareInsight)
  }
  // End of list of possible types for union field insight.
}
Fields

Union field insight.

insight can be only one of the following:
migrationInsight

object (MigrationInsight)

Output only. An insight about potential migrations for an asset.
genericInsight

object (GenericInsight)

Output only. A generic insight about an asset.
softwareInsight

object (SoftwareInsight)

Output only. An insight regarding software detected on an asset.

MigrationInsight

An insight about potential migrations for an asset.

JSON representation 
{
  "fit": {
    object (FitDescriptor)
  },
  "issues": [
    {
      object (Issue)
    }
  ],

  // Union field migration_target can be only one of the following:
  "computeEngineTarget": {
    object (ComputeEngineMigrationTarget)
  },
  "vmwareEngineTarget": {
    object (VmwareEngineMigrationTarget)
  },
  "gkeTarget": {
    object (GoogleKubernetesEngineMigrationTarget)
  },
  "cloudDatabaseTarget": {
    object (CloudDatabaseMigrationTarget)
  },
  "computeEngineSoleTenantTarget": {
    object (ComputeEngineSoleTenantMigrationTarget)
  }
  // End of list of possible types for union field migration_target.
}
Fields
fit

object (FitDescriptor)

Output only. Description of how well the asset this insight is associated with fits the proposed migration.
issues[]

object (Issue)

Output only. Issues associated with this migration.
Union field migration_target. A target for the migration. migration_target can be only one of the following:
computeEngineTarget

object (ComputeEngineMigrationTarget)

Output only. A Google Compute Engine target.
vmwareEngineTarget

object (VmwareEngineMigrationTarget)

Output only. A VMWare Engine target.
gkeTarget

object (GoogleKubernetesEngineMigrationTarget)

Output only. A Google Kubernetes Engine target.
cloudDatabaseTarget

object (CloudDatabaseMigrationTarget)

Output only. A Cloud database migration target.
computeEngineSoleTenantTarget

object (ComputeEngineSoleTenantMigrationTarget)

Output only. A Google Compute Engine Sole Tenant target.

FitDescriptor

Describes the fit level of an asset for migration to a specific target.

JSON representation 
{
  "fitLevel": enum (FitLevel)
}
Fields
fitLevel

enum (FitLevel)

Output only. Fit level.

FitLevel

Fit level.

Enums
FIT_LEVEL_UNSPECIFIED Not enough information.
FIT Fit.
NO_FIT No Fit.
REQUIRES_EFFORT Fit with effort.

ComputeEngineMigrationTarget

Compute engine migration target.

JSON representation 
{
  "shape": {
    object (ComputeEngineShapeDescriptor)
  }
}
Fields
shape

object (ComputeEngineShapeDescriptor)

Description of the suggested shape for the migration target.

ComputeEngineShapeDescriptor

Compute Engine target shape descriptor.

JSON representation 
{
  "memoryMb": integer,
  "physicalCoreCount": integer,
  "logicalCoreCount": integer,
  "series": string,
  "machineType": string,
  "storage": [
    {
      object (ComputeStorageDescriptor)
    }
  ],
  "smtEnabled": boolean
}
Fields
memoryMb

integer

Output only. Memory in mebibytes.
physicalCoreCount

integer

Output only. Number of physical cores.
logicalCoreCount

integer

Output only. Number of logical cores.
series

string

Output only. Compute Engine machine series.
machineType

string

Output only. Compute Engine machine type.
storage[]

object (ComputeStorageDescriptor)

Output only. Compute Engine storage. Never empty.
smtEnabled

boolean

Output only. Whether simultaneous multithreading is enabled (see https://cloud.google.com/compute/docs/instances/set-threads-per-core).

ComputeStorageDescriptor

Compute Engine storage option descriptor.

JSON representation 
{
  "type": enum (PersistentDiskType),
  "sizeGb": integer
}
Fields
type

enum (PersistentDiskType)

Output only. Disk type backing the storage.
sizeGb

integer

Disk size in GiB.

VmwareEngineMigrationTarget

This type has no fields.

VMWare engine migration target.

GoogleKubernetesEngineMigrationTarget

This type has no fields.

GKE migration target.

CloudDatabaseMigrationTarget

Cloud database migration target.

JSON representation 
{

  // Union field shape can be only one of the following:
  "cloudSqlShape": {
    object (CloudSqlForSqlServerShape)
  },
  "cloudSqlForMysqlShape": {
    object (CloudSqlForMySqlShape)
  },
  "cloudSqlForPostgresqlShape": {
    object (CloudSqlForPostgreSqlShape)
  }
  // End of list of possible types for union field shape.
}
Fields
Union field shape. Proposed shape of the database after migration. An empty shape represents the migration target on insights when there is no suggested shape. shape can be only one of the following:
cloudSqlShape

object (CloudSqlForSqlServerShape)

Cloud SQL for SQL Server database shape.
cloudSqlForMysqlShape

object (CloudSqlForMySqlShape)

Cloud SQL for MySQL database shape.
cloudSqlForPostgresqlShape

object (CloudSqlForPostgreSqlShape)

Cloud SQL for PostgreSQL database shape.

CloudSqlForSqlServerShape

Cloud SQL for SQL Server database shape.

JSON representation 
{
  "logicalCoreCount": integer,
  "memoryMb": integer,
  "storage": {
    object (ComputeStorageDescriptor)
  },
  "backupStorageGb": integer,
  "egressGbPerMonth": string,
  "version": enum (SqlServerVersion),
  "zoneAvailability": enum (CloudSqlZoneAvailability),
  "edition": enum (CloudSqlEdition),
  "smtEnabled": boolean
}
Fields
logicalCoreCount

integer

Output only. Number of logical cores.
memoryMb

integer

Output only. Predicted amount of memory in MiB.
storage

object (ComputeStorageDescriptor)

Output only. Predicted storage shape.
backupStorageGb

integer

Output only. Predicted backup storage size in GiB.
egressGbPerMonth

string (int64 format)

Output only. Predicted Network Out traffic GiB per month.
version

enum (SqlServerVersion)

Output only. Microsoft SQL Server version to be used on the Cloud SQL for SQL server instance.
zoneAvailability

enum (CloudSqlZoneAvailability)

Output only. Cloud SQL zone availability.
edition

enum (CloudSqlEdition)

Output only. Cloud SQL edition.
smtEnabled

boolean

Output only. Whether simultaneous multithreading is enabled (see https://cloud.google.com/sql/docs/sqlserver/create-instance#smt-create-instance).

SqlServerVersion

Microsoft SQL Server version that is used on a Cloud SQL for SQL server instance.

Enums
SQL_SERVER_VERSION_UNSPECIFIED Unspecified SQL Server version.
SQL_SERVER_VERSION_2017_EXPRESS The database version is SQL Server 2017 Express.
SQL_SERVER_VERSION_2017_WEB The database version is SQL Server 2017 Web.
SQL_SERVER_VERSION_2017_STANDARD The database version is SQL Server 2017 Standard.
SQL_SERVER_VERSION_2017_ENTERPRISE The database version is SQL Server 2017 Enterprise.
SQL_SERVER_VERSION_2019_EXPRESS The database version is SQL Server 2019 Express.
SQL_SERVER_VERSION_2019_WEB The database version is SQL Server 2019 Web.
SQL_SERVER_VERSION_2019_STANDARD The database version is SQL Server 2019 Standard.
SQL_SERVER_VERSION_2019_ENTERPRISE The database version is SQL Server 2019 Enterprise.
SQL_SERVER_VERSION_2022_EXPRESS The database version is SQL Server 2022 Express.
SQL_SERVER_VERSION_2022_WEB The database version is SQL Server 2022 Web.
SQL_SERVER_VERSION_2022_STANDARD The database version is SQL Server 2022 Standard.
SQL_SERVER_VERSION_2022_ENTERPRISE The database version is SQL Server 2022 Enterprise.

CloudSqlForMySqlShape

Cloud SQL for MySQL database shape.

JSON representation 
{
  "logicalCoreCount": integer,
  "memoryMb": integer,
  "storage": {
    object (ComputeStorageDescriptor)
  },
  "backupStorageGb": integer,
  "egressGbPerMonth": string,
  "zoneAvailability": enum (CloudSqlZoneAvailability),
  "edition": enum (CloudSqlEdition),
  "version": enum (MySqlVersion)
}
Fields
logicalCoreCount

integer

Output only. Number of logical cores.
memoryMb

integer

Output only. Predicted amount of memory in MiB.
storage

object (ComputeStorageDescriptor)

Output only. Predicted storage shape.
backupStorageGb

integer

Output only. Predicted backup storage size in GiB.
egressGbPerMonth

string (int64 format)

Output only. Predicted Network Out traffic GiB per month.
zoneAvailability

enum (CloudSqlZoneAvailability)

Output only. Cloud SQL zone availability.
edition

enum (CloudSqlEdition)

Output only. Cloud SQL edition.
version

enum (MySqlVersion)

Output only. MySQL version to be used on the Cloud SQL for MySQL instance.

MySqlVersion

MySQL version that is used on a Cloud SQL for MySQL instance.

Enums
MY_SQL_VERSION_UNSPECIFIED Unspecified MySQL version.
MY_SQL_VERSION_5_6 MySQL 5.6.
MY_SQL_VERSION_5_7 MySQL 5.7.
MY_SQL_VERSION_8_0 MySQL 8.0.

CloudSqlForPostgreSqlShape

Cloud SQL for PostgreSQL database shape.

JSON representation 
{
  "logicalCoreCount": integer,
  "memoryMb": integer,
  "storage": {
    object (ComputeStorageDescriptor)
  },
  "backupStorageGb": integer,
  "egressGbPerMonth": string,
  "zoneAvailability": enum (CloudSqlZoneAvailability),
  "edition": enum (CloudSqlEdition),
  "version": enum (PostgreSqlVersion)
}
Fields
logicalCoreCount

integer

Output only. Number of logical cores.
memoryMb

integer

Output only. Predicted amount of memory in MiB.
storage

object (ComputeStorageDescriptor)

Output only. Predicted storage shape.
backupStorageGb

integer

Output only. Predicted backup storage size in GiB.
egressGbPerMonth

string (int64 format)

Output only. Predicted Network Out traffic GiB per month.
zoneAvailability

enum (CloudSqlZoneAvailability)

Output only. Cloud SQL zone availability.
edition

enum (CloudSqlEdition)

Output only. Cloud SQL edition.
version

enum (PostgreSqlVersion)

Output only. PostgreSql version to be used on the Cloud SQL for PostgreSql instance.

PostgreSqlVersion

PostgreSql version that is used on a Cloud SQL for PostgreSQL instance.

Enums
POSTGRESQL_VERSION_UNSPECIFIED Unspecified PostgreSQL version.
POSTGRESQL_VERSION_9_6 PostgreSQL 9.6.
POSTGRESQL_VERSION_10 PostgreSQL 10
POSTGRESQL_VERSION_11 PostgreSQL 11
POSTGRESQL_VERSION_12 PostgreSQL 12
POSTGRESQL_VERSION_13 PostgreSQL 13
POSTGRESQL_VERSION_14 PostgreSQL 14
POSTGRESQL_VERSION_15 PostgreSQL 15

ComputeEngineSoleTenantMigrationTarget

This type has no fields.

Compute engine sole tenant migration target.

Issue

An issue associated with a migration.

JSON representation 
{
  "issueCode": string,
  "description": string,

  // Union field details can be only one of the following:
  "compatibilityIssue": {
    object (CompatibilityIssue)
  }
  // End of list of possible types for union field details.
}
Fields
issueCode

string

Output only. Unique identifier for this issue type.
description

string

Output only. English description of the issue.
Union field details. Details about the issue. details can be only one of the following:
compatibilityIssue

object (CompatibilityIssue)

Output only. Details about a compatibility issue.

CompatibilityIssue

Details about a compatibility issue.

JSON representation 
{
  "category": enum (Category),
  "associatedObjectType": enum (ObjectType),
  "associatedObject": string,
  "associatedValue": string
}
Fields
category

enum (Category)

Output only. Category of this compatibility issue.
associatedObjectType

enum (ObjectType)

Output only. Type of object associated with this migration compatibility issue.
associatedObject

string

Output only. Name of the object associated with this compatibility issue relative to the relevant asset. Does not represent a fully qualified resource name and is not intended for programmatic use.
associatedValue

string

Output only. A string representation of actual value associated with this issue. Some values may contain aggregated information, such as a flag name and the actual value assigned to it.

Category

Categories of migration compatibility issues. This enum is expected to be expanded as needed.

Enums
CATEGORY_UNSPECIFIED An unspecified compatibility category.
DATABASE_FLAG Database flag compatibility category.
DATABASE_FEATURE Database feature compatibility category.

ObjectType

Types of objects that can be associated with migration compatibility issues. This enum is expected to be expanded as needed.

Enums
OBJECT_TYPE_UNSPECIFIED An unspecified object type.
DATABASE_DEPLOYMENT A database deployment object type.
DATABASE A logical database object type.
SCHEMA A schema object type.

GenericInsight

A generic insight about an asset.

JSON representation 
{
  "messageId": string,
  "defaultMessage": string,
  "additionalInformation": [
    string
  ]
}
Fields
messageId

string (int64 format)

Output only. Represents a globally unique message id for this insight, can be used for localization purposes, in case message_code is not yet known by the client use defaultMessage instead.
defaultMessage

string

Output only. In case message_code is not yet known by the client defaultMessage will be the message to be used instead. Text can contain md file style links.
additionalInformation[]

string

Output only. Additional information about the insight, each entry can be a logical entry and must make sense if it is displayed with line breaks between each entry. Text can contain md style links.

SoftwareInsight

An insight regarding software detected on an asset.

JSON representation 
{
  "detectedSoftware": {
    object (DetectedSoftware)
  }
}
Fields
detectedSoftware

object (DetectedSoftware)

Output only. Information about the detected software.

DetectedSoftware

Information about software detected on an asset.

JSON representation 
{
  "softwareName": string,
  "softwareFamily": string
}
Fields
softwareName

string

Output only. Software's name.
softwareFamily

string

Output only. Software family of the detected software, e.g. Database, SAP family.

AssetPerformanceData

Performance data for an asset.

JSON representation 
{
  "dailyResourceUsageAggregations": [
    {
      object (DailyResourceUsageAggregation)
    }
  ]
}
Fields
dailyResourceUsageAggregations[]

object (DailyResourceUsageAggregation)

Daily resource usage aggregations. Contains all of the data available for an asset, up to the last 420 days. Aggregations are sorted from oldest to most recent.

DailyResourceUsageAggregation

Usage data aggregation for a single day.

JSON representation 
{
  "date": {
    object (Date)
  },
  "cpu": {
    object (CPU)
  },
  "memory": {
    object (Memory)
  },
  "network": {
    object (Network)
  },
  "disk": {
    object (Disk)
  }
}
Fields
date

object (Date)

Aggregation date. Day boundaries are at midnight UTC.
cpu

object (CPU)

CPU usage.
memory

object (Memory)

Memory usage.
network

object (Network)

Network usage.
disk

object (Disk)

Disk usage.

CPU

Statistical aggregation of CPU usage.

JSON representation 
{
  "utilizationPercentage": {
    object (Stats)
  }
}
Fields
utilizationPercentage

object (Stats)

CPU utilization percentage.

Stats

Statistical aggregation of samples for a single resource usage.

JSON representation 
{
  "average": number,
  "median": number,
  "ninteyFifthPercentile": number,
  "peak": number
}
Fields
average

number

Average usage value.
median

number

Median usage value.
ninteyFifthPercentile

number

95th percentile usage value.
peak

number

Peak usage value.

Memory

Statistical aggregation of memory usage.

JSON representation 
{
  "utilizationPercentage": {
    object (Stats)
  }
}
Fields
utilizationPercentage

object (Stats)

Memory utilization percentage.

Network

Statistical aggregation of network usage.

JSON representation 
{
  "ingressBps": {
    object (Stats)
  },
  "egressBps": {
    object (Stats)
  }
}
Fields
ingressBps

object (Stats)

Network ingress in B/s.
egressBps

object (Stats)

Network egress in B/s.

Disk

Statistical aggregation of disk usage.

JSON representation 
{
  "iops": {
    object (Stats)
  },
  "readIops": {
    object (Stats)
  },
  "writeIops": {
    object (Stats)
  }
}
Fields
iops

object (Stats)

Disk I/O operations per second.
readIops

object (Stats)

Disk read I/O operations per second.
writeIops

object (Stats)

Disk write I/O operations per second.

Methods

aggregateValues

 Aggregates the requested fields based on provided function.

batchDelete

 Deletes list of Assets.

batchUpdate

 Updates the parameters of a list of assets.

delete

 Deletes an asset.

get

 Gets the details of an asset.

list

 Lists all the assets in a given project and location.

patch

 Updates the parameters of an asset.

reportAssetFrames

 Reports a set of frames.