REST Resource: projects.locations.reportConfigs.reports

Resource: Report

Report represents a point-in-time rendering of the ReportConfig results.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "displayName": string,
  "description": string,
  "type": enum (Type),
  "state": enum (State),
  "summary": {
    object (ReportSummary)
  }
}
Fields
name

string

Output only. Name of resource.
createTime

string (Timestamp format)

Output only. Creation timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Last update timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
displayName

string

User-friendly display name. Maximum length is 63 characters.
description

string

Free-text description.
type

enum (Type)

Report type.
state

enum (State)

Report creation state.
summary

object (ReportSummary)

Output only. Summary view of the Report.

Type

Report type.

Enums
TYPE_UNSPECIFIED Default Report type.
TOTAL_COST_OF_OWNERSHIP Total cost of ownership Report type.

State

Report creation state.

Enums
STATE_UNSPECIFIED Default Report creation state.
PENDING Creating Report.
SUCCEEDED Successfully created Report.
FAILED Failed to create Report.

ReportSummary

Describes the Summary view of a Report, which contains aggregated values for all the groups and preference sets included in this Report.

JSON representation 
{
  "allAssetsStats": {
    object (AssetAggregateStats)
  },
  "groupFindings": [
    {
      object (GroupFinding)
    }
  ]
}
Fields
allAssetsStats

object (AssetAggregateStats)

Aggregate statistics for all the assets across all the groups.
groupFindings[]

object (GroupFinding)

Findings for each Group included in this report.

AssetAggregateStats

Aggregate statistics for a collection of assets.

JSON representation 
{
  "totalMemoryBytes": string,
  "totalStorageBytes": string,
  "totalCores": string,
  "totalAssets": string,
  "memoryUtilizationChart": {
    object (UtilizationChartData)
  },
  "storageUtilizationChart": {
    object (UtilizationChartData)
  },
  "operatingSystem": {
    object (ChartData)
  },
  "coreCountHistogram": {
    object (HistogramChartData)
  },
  "memoryBytesHistogram": {
    object (HistogramChartData)
  },
  "storageBytesHistogram": {
    object (HistogramChartData)
  }
}
Fields
totalMemoryBytes

string (int64 format)

Sum of the memory in bytes of all the assets in this collection.
totalStorageBytes

string (int64 format)

Sum of persistent storage in bytes of all the assets in this collection.
totalCores

string (int64 format)

Sum of the CPU core count of all the assets in this collection.
totalAssets

string (int64 format)

Count of the number of unique assets in this collection.
memoryUtilizationChart

object (UtilizationChartData)

Total memory split into Used/Free buckets.
storageUtilizationChart

object (UtilizationChartData)

Total memory split into Used/Free buckets.
operatingSystem

object (ChartData)

Count of assets grouped by Operating System families.
coreCountHistogram

object (HistogramChartData)

Histogram showing a distribution of CPU core counts.
memoryBytesHistogram

object (HistogramChartData)

Histogram showing a distribution of memory sizes.
storageBytesHistogram

object (HistogramChartData)

Histogram showing a distribution of memory sizes.

UtilizationChartData

Utilization Chart is a specific type of visualization which displays a metric classified into "Used" and "Free" buckets.

JSON representation 
{
  "used": string,
  "free": string
}
Fields
used

string (int64 format)

Aggregate value which falls into the "Used" bucket.
free

string (int64 format)

Aggregate value which falls into the "Free" bucket.

ChartData

Describes a collection of data points rendered as a Chart.

JSON representation 
{
  "dataPoints": [
    {
      object (DataPoint)
    }
  ]
}
Fields
dataPoints[]

object (DataPoint)

Each data point in the chart is represented as a name-value pair with the name being the x-axis label, and the value being the y-axis value.

DataPoint

Describes a single data point in the Chart.

JSON representation 
{
  "label": string,
  "value": number
}
Fields
label

string

The X-axis label for this data point.
value

number

The Y-axis value for this data point.

HistogramChartData

A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket.

JSON representation 
{
  "buckets": [
    {
      object (Bucket)
    }
  ]
}
Fields
buckets[]

object (Bucket)

Buckets in the histogram. There will be n+1 buckets matching n lower bounds in the request. The first bucket will be from -infinity to the first bound. Subsequent buckets will be between one bound and the next. The final bucket will be from the final bound to infinity.

Bucket

A histogram bucket with a lower and upper bound, and a count of items with a field value between those bounds. The lower bound is inclusive and the upper bound is exclusive. Lower bound may be -infinity and upper bound may be infinity.

JSON representation 
{
  "lowerBound": string,
  "upperBound": string,
  "count": string
}
Fields
lowerBound

string (int64 format)

Lower bound - inclusive.
upperBound

string (int64 format)

Upper bound - exclusive.
count

string (int64 format)

Count of items in the bucket.

GroupFinding

Summary Findings for a specific Group.

JSON representation 
{
  "displayName": string,
  "description": string,
  "assetAggregateStats": {
    object (AssetAggregateStats)
  },
  "overlappingAssetCount": string,
  "preferenceSetFindings": [
    {
      object (GroupPreferenceSetFinding)
    }
  ]
}
Fields
displayName

string

Display Name for the Group.
description

string

Description for the Group.
assetAggregateStats

object (AssetAggregateStats)

Summary statistics for all the assets in this group.
overlappingAssetCount

string (int64 format)

Count of the number of assets in this group which are also included in another group within the same report.
preferenceSetFindings[]

object (GroupPreferenceSetFinding)

Findings for each of the PreferenceSets for this group.

GroupPreferenceSetFinding

Summary Findings for a specific Group/PreferenceSet combination.

JSON representation 
{
  "displayName": string,
  "description": string,
  "machinePreferences": {
    object (VirtualMachinePreferences)
  },
  "monthlyCostTotal": {
    object (Money)
  },
  "monthlyCostCompute": {
    object (Money)
  },
  "monthlyCostOsLicense": {
    object (Money)
  },
  "monthlyCostNetworkEgress": {
    object (Money)
  },
  "monthlyCostStorage": {
    object (Money)
  },
  "monthlyCostOther": {
    object (Money)
  },
  "computeEngineFinding": {
    object (ComputeEngineFinding)
  }
}
Fields
displayName

string

Display Name of the Preference Set
description

string

Description for the Preference Set.
machinePreferences

object (VirtualMachinePreferences)

A set of preferences that applies to all machines in the context.
monthlyCostTotal

object (Money)

Total monthly cost for this preference set.
monthlyCostCompute

object (Money)

Compute monthly cost for this preference set.
monthlyCostOsLicense

object (Money)

Licensing monthly cost for this preference set.
monthlyCostNetworkEgress

object (Money)

Network Egress monthly cost for this preference set.
monthlyCostStorage

object (Money)

Storage monthly cost for this preference set.
monthlyCostOther

object (Money)

Miscellaneous monthly cost for this preference set.
computeEngineFinding

object (ComputeEngineFinding)

A set of findings that applies to Compute Engine machines in the input.

Money

Represents an amount of money with its currency type.

JSON representation 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Fields
currencyCode

string

The three-letter currency code defined in ISO 4217.
units

string (int64 format)

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.
nanos

integer

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

ComputeEngineFinding

A set of findings that applies to assets destined for Compute Engine.

JSON representation 
{
  "allocatedRegions": [
    string
  ],
  "allocatedAssetCount": string,
  "machineSeriesAllocations": [
    {
      object (MachineSeriesAllocation)
    }
  ],
  "allocatedDiskTypes": [
    enum (PersistentDiskType)
  ]
}
Fields
allocatedRegions[]

string

Set of regions in which the assets were allocated.
allocatedAssetCount

string (int64 format)

Count of assets which were allocated.
machineSeriesAllocations[]

object (MachineSeriesAllocation)

Distribution of assets based on the Machine Series.
allocatedDiskTypes[]

enum (PersistentDiskType)

Set of disk types allocated to assets.

MachineSeriesAllocation

Represents a data point tracking the count of assets allocated for a specific Machine Series.

JSON representation 
{
  "machineSeries": {
    object (MachineSeries)
  },
  "allocatedAssetCount": string
}
Fields
machineSeries

object (MachineSeries)

The Machine Series (e.g. "E2", "N2")
allocatedAssetCount

string (int64 format)

Count of assets allocated to this machine series.

PersistentDiskType

The persistent disk (PD) types of Compute Engine virtual machines.

Enums
PERSISTENT_DISK_TYPE_UNSPECIFIED Unspecified (default value). Selecting this value allows the system to use any disk type according to reported usage. This a good value to start with.
PERSISTENT_DISK_TYPE_STANDARD Standard HDD Persistent Disk.
PERSISTENT_DISK_TYPE_BALANCED Balanced Persistent Disk.
PERSISTENT_DISK_TYPE_SSD SSD Persistent Disk.

Methods

create

 Creates a report.

delete

 Deletes a Report.

get

 Gets details of a single Report.

list

 Lists Reports in a given ReportConfig.