Close httplib2 connections.
create(parent, body=None, reportId=None, requestId=None, x__xgafv=None)
Creates a report.
delete(name, requestId=None, x__xgafv=None)
Deletes a Report.
get(name, view=None, x__xgafv=None)
Gets details of a single Report.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists Reports in a given ReportConfig.
Retrieves the next page of results.
close()
Close httplib2 connections.
create(parent, body=None, reportId=None, requestId=None, x__xgafv=None)
Creates a report.
Args:
parent: string, Required. Value for parent. (required)
body: object, The request body.
The object takes the form of:
{ # Report represents a point-in-time rendering of the ReportConfig results.
"createTime": "A String", # Output only. Creation timestamp.
"description": "A String", # Free-text description.
"displayName": "A String", # User-friendly display name. Maximum length is 63 characters.
"name": "A String", # Output only. Name of resource.
"state": "A String", # Report creation state.
"summary": { # Describes the Summary view of a Report, which contains aggregated values for all the groups and preference sets included in this Report. # Output only. Summary view of the Report.
"allAssetsStats": { # Aggregate statistics for a collection of assets. # Aggregate statistics for all the assets across all the groups.
"coreCountHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of logical CPU core counts.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"memoryUtilizationChart": { # Utilization Chart is a specific type of visualization which displays a metric classified into "Used" and "Free" buckets. # Total memory split into Used/Free buckets.
"free": "A String", # Aggregate value which falls into the "Free" bucket.
"used": "A String", # Aggregate value which falls into the "Used" bucket.
},
"operatingSystem": { # Describes a collection of data points rendered as a Chart. # Count of assets grouped by Operating System families.
"dataPoints": [ # 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.
{ # Describes a single data point in the Chart.
"label": "A String", # The X-axis label for this data point.
"value": 3.14, # The Y-axis value for this data point.
},
],
},
"storageBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of storage sizes.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"storageUtilizationChart": { # Utilization Chart is a specific type of visualization which displays a metric classified into "Used" and "Free" buckets. # Total memory split into Used/Free buckets.
"free": "A String", # Aggregate value which falls into the "Free" bucket.
"used": "A String", # Aggregate value which falls into the "Used" bucket.
},
"totalAssets": "A String", # Count of the number of unique assets in this collection.
"totalCores": "A String", # Sum of the CPU core count of all the assets in this collection.
"totalMemoryBytes": "A String", # Sum of the memory in bytes of all the assets in this collection.
"totalStorageBytes": "A String", # Sum of persistent storage in bytes of all the assets in this collection.
},
"groupFindings": [ # Findings for each Group included in this report.
{ # Summary Findings for a specific Group.
"assetAggregateStats": { # Aggregate statistics for a collection of assets. # Summary statistics for all the assets in this group.
"coreCountHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of logical CPU core counts.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"memoryUtilizationChart": { # Utilization Chart is a specific type of visualization which displays a metric classified into "Used" and "Free" buckets. # Total memory split into Used/Free buckets.
"free": "A String", # Aggregate value which falls into the "Free" bucket.
"used": "A String", # Aggregate value which falls into the "Used" bucket.
},
"operatingSystem": { # Describes a collection of data points rendered as a Chart. # Count of assets grouped by Operating System families.
"dataPoints": [ # 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.
{ # Describes a single data point in the Chart.
"label": "A String", # The X-axis label for this data point.
"value": 3.14, # The Y-axis value for this data point.
},
],
},
"storageBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of storage sizes.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"storageUtilizationChart": { # Utilization Chart is a specific type of visualization which displays a metric classified into "Used" and "Free" buckets. # Total memory split into Used/Free buckets.
"free": "A String", # Aggregate value which falls into the "Free" bucket.
"used": "A String", # Aggregate value which falls into the "Used" bucket.
},
"totalAssets": "A String", # Count of the number of unique assets in this collection.
"totalCores": "A String", # Sum of the CPU core count of all the assets in this collection.
"totalMemoryBytes": "A String", # Sum of the memory in bytes of all the assets in this collection.
"totalStorageBytes": "A String", # Sum of persistent storage in bytes of all the assets in this collection.
},
"description": "A String", # Description for the Group.
"displayName": "A String", # Display Name for the Group.
"overlappingAssetCount": "A String", # This field is deprecated, do not rely on it having a value.
"preferenceSetFindings": [ # Findings for each of the PreferenceSets for this group.
{ # Summary Findings for a specific Group/PreferenceSet combination.
"computeEngineFinding": { # A set of findings that applies to assets destined for Compute Engine. # A set of findings that applies to Compute Engine machines in the input.
"allocatedAssetCount": "A String", # Count of assets which were allocated.
"allocatedDiskTypes": [ # Set of disk types allocated to assets.
"A String",
],
"allocatedRegions": [ # Set of regions in which the assets were allocated.
"A String",
],
"machineSeriesAllocations": [ # Distribution of assets based on the Machine Series.
{ # Represents a data point tracking the count of assets allocated for a specific Machine Series.
"allocatedAssetCount": "A String", # Count of assets allocated to this machine series.
"machineSeries": { # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine). # The Machine Series (e.g. "E2", "N2")
"code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing
},
},
],
},
"description": "A String", # Description for the Preference Set.
"displayName": "A String", # Display Name of the Preference Set
"machinePreferences": { # VirtualMachinePreferences enables you to create sets of assumptions, for example, a geographical location and pricing track, for your migrated virtual machines. The set of preferences influence recommendations for migrating virtual machine assets. # A set of preferences that applies to all machines in the context.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"computeEnginePreferences": { # The user preferences relating to Compute Engine target platform. # Compute Engine preferences concern insights and recommendations for Compute Engine target.
"licenseType": "A String", # License type to consider when calculating costs for virtual machine insights and recommendations. If unspecified, costs are calculated based on the default licensing plan.
"machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations. Not all machine types are available in all zones and regions. # Preferences concerning the machine types to consider on Compute Engine.
"allowedMachineSeries": [ # Compute Engine machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series.
{ # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine).
"code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing
},
],
},
"persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data.
},
"regionPreferences": { # The user preferences relating to target regions. # Region preferences for assets using this preference set. If you are unsure which value to set, the migration service API region is often a good value to start with.
"preferredRegions": [ # A list of preferred regions, ordered by the most preferred region first. Set only valid Google Cloud region names. See https://cloud.google.com/compute/docs/regions-zones for available regions.
"A String",
],
},
"sizingOptimizationStrategy": "A String", # Sizing optimization strategy specifies the preferred strategy used when extrapolating usage data to calculate insights and recommendations for a virtual machine. If you are unsure which value to set, a moderate sizing optimization strategy is often a good value to start with.
"soleTenancyPreferences": { # Preferences concerning Sole Tenancy nodes and VMs. # Preferences concerning Sole Tenant nodes and virtual machines.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 2.0 inclusive.
"hostMaintenancePolicy": "A String", # Sole Tenancy nodes maintenance policy.
"nodeTypes": [ # A list of sole tenant node types. An empty list means that all possible node types will be considered.
{ # A Sole Tenant node type.
"nodeName": "A String", # Name of the Sole Tenant node. Consult https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes
},
],
},
"targetProduct": "A String", # Target product for assets using this preference set. Specify either target product or business goal, but not both.
"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment.
"memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0.
"storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0.
},
},
"monthlyCostCompute": { # Represents an amount of money with its currency type. # Compute monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Network Egress monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Licensing monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostOther": { # Represents an amount of money with its currency type. # Miscellaneous monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostStorage": { # Represents an amount of money with its currency type. # Storage monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostTotal": { # Represents an amount of money with its currency type. # Total monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"soleTenantFinding": { # A set of findings that applies to assets destined for Sole-Tenant nodes. # A set of findings that applies to Sole-Tenant machines in the input.
"allocatedAssetCount": "A String", # Count of assets which are allocated
"allocatedRegions": [ # Set of regions in which the assets are allocated
"A String",
],
"nodeAllocations": [ # Set of per-nodetype allocation records
{ # Represents the assets allocated to a specific Sole-Tenant node type.
"allocatedAssetCount": "A String", # Count of assets allocated to these nodes
"node": { # A Sole Tenant node type. # Sole Tenant node type, e.g. "m3-node-128-3904"
"nodeName": "A String", # Name of the Sole Tenant node. Consult https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes
},
"nodeCount": "A String", # Count of this node type to be provisioned
},
],
},
"vmwareEngineFinding": { # A set of findings that applies to assets destined for VMWare Engine. # A set of findings that applies to VMWare machines in the input.
"allocatedAssetCount": "A String", # Count of assets which are allocated
"allocatedRegions": [ # Set of regions in which the assets were allocated
"A String",
],
"nodeAllocations": [ # Set of per-nodetype allocation records
{ # Represents assets allocated to a specific VMWare Node type.
"allocatedAssetCount": "A String", # Count of assets allocated to these nodes
"nodeCount": "A String", # Count of this node type to be provisioned
"vmwareNode": { # A VMWare Engine Node # VMWare node type, e.g. "ve1-standard-72"
"code": "A String", # Code to identify VMware Engine node series, e.g. "ve1-standard-72". Based on the displayName of cloud.google.com/vmware-engine/docs/reference/rest/v1/projects.locations.nodeTypes
},
},
],
},
},
],
},
],
},
"type": "A String", # Report type.
"updateTime": "A String", # Output only. Last update timestamp.
}
reportId: string, Required. User specified id for the report. It will become the last component of the report name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The id must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, requestId=None, x__xgafv=None)
Deletes a Report.
Args:
name: string, Required. Name of the resource. (required)
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, view=None, x__xgafv=None)
Gets details of a single Report.
Args:
name: string, Required. Name of the resource. (required)
view: string, Determines what information to retrieve for the Report.
Allowed values
REPORT_VIEW_UNSPECIFIED - The report view is not specified. The API displays the basic view by default.
REPORT_VIEW_BASIC - The report view includes only basic metadata of the Report. Useful for list views.
REPORT_VIEW_FULL - The report view includes all the metadata of the Report. Useful for preview.
REPORT_VIEW_STANDARD - The report view includes the standard metadata of an report. Useful for detail view.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Report represents a point-in-time rendering of the ReportConfig results.
"createTime": "A String", # Output only. Creation timestamp.
"description": "A String", # Free-text description.
"displayName": "A String", # User-friendly display name. Maximum length is 63 characters.
"name": "A String", # Output only. Name of resource.
"state": "A String", # Report creation state.
"summary": { # Describes the Summary view of a Report, which contains aggregated values for all the groups and preference sets included in this Report. # Output only. Summary view of the Report.
"allAssetsStats": { # Aggregate statistics for a collection of assets. # Aggregate statistics for all the assets across all the groups.
"coreCountHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of logical CPU core counts.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"memoryUtilizationChart": { # Utilization Chart is a specific type of visualization which displays a metric classified into "Used" and "Free" buckets. # Total memory split into Used/Free buckets.
"free": "A String", # Aggregate value which falls into the "Free" bucket.
"used": "A String", # Aggregate value which falls into the "Used" bucket.
},
"operatingSystem": { # Describes a collection of data points rendered as a Chart. # Count of assets grouped by Operating System families.
"dataPoints": [ # 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.
{ # Describes a single data point in the Chart.
"label": "A String", # The X-axis label for this data point.
"value": 3.14, # The Y-axis value for this data point.
},
],
},
"storageBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of storage sizes.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"storageUtilizationChart": { # Utilization Chart is a specific type of visualization which displays a metric classified into "Used" and "Free" buckets. # Total memory split into Used/Free buckets.
"free": "A String", # Aggregate value which falls into the "Free" bucket.
"used": "A String", # Aggregate value which falls into the "Used" bucket.
},
"totalAssets": "A String", # Count of the number of unique assets in this collection.
"totalCores": "A String", # Sum of the CPU core count of all the assets in this collection.
"totalMemoryBytes": "A String", # Sum of the memory in bytes of all the assets in this collection.
"totalStorageBytes": "A String", # Sum of persistent storage in bytes of all the assets in this collection.
},
"groupFindings": [ # Findings for each Group included in this report.
{ # Summary Findings for a specific Group.
"assetAggregateStats": { # Aggregate statistics for a collection of assets. # Summary statistics for all the assets in this group.
"coreCountHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of logical CPU core counts.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"memoryUtilizationChart": { # Utilization Chart is a specific type of visualization which displays a metric classified into "Used" and "Free" buckets. # Total memory split into Used/Free buckets.
"free": "A String", # Aggregate value which falls into the "Free" bucket.
"used": "A String", # Aggregate value which falls into the "Used" bucket.
},
"operatingSystem": { # Describes a collection of data points rendered as a Chart. # Count of assets grouped by Operating System families.
"dataPoints": [ # 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.
{ # Describes a single data point in the Chart.
"label": "A String", # The X-axis label for this data point.
"value": 3.14, # The Y-axis value for this data point.
},
],
},
"storageBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of storage sizes.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"storageUtilizationChart": { # Utilization Chart is a specific type of visualization which displays a metric classified into "Used" and "Free" buckets. # Total memory split into Used/Free buckets.
"free": "A String", # Aggregate value which falls into the "Free" bucket.
"used": "A String", # Aggregate value which falls into the "Used" bucket.
},
"totalAssets": "A String", # Count of the number of unique assets in this collection.
"totalCores": "A String", # Sum of the CPU core count of all the assets in this collection.
"totalMemoryBytes": "A String", # Sum of the memory in bytes of all the assets in this collection.
"totalStorageBytes": "A String", # Sum of persistent storage in bytes of all the assets in this collection.
},
"description": "A String", # Description for the Group.
"displayName": "A String", # Display Name for the Group.
"overlappingAssetCount": "A String", # This field is deprecated, do not rely on it having a value.
"preferenceSetFindings": [ # Findings for each of the PreferenceSets for this group.
{ # Summary Findings for a specific Group/PreferenceSet combination.
"computeEngineFinding": { # A set of findings that applies to assets destined for Compute Engine. # A set of findings that applies to Compute Engine machines in the input.
"allocatedAssetCount": "A String", # Count of assets which were allocated.
"allocatedDiskTypes": [ # Set of disk types allocated to assets.
"A String",
],
"allocatedRegions": [ # Set of regions in which the assets were allocated.
"A String",
],
"machineSeriesAllocations": [ # Distribution of assets based on the Machine Series.
{ # Represents a data point tracking the count of assets allocated for a specific Machine Series.
"allocatedAssetCount": "A String", # Count of assets allocated to this machine series.
"machineSeries": { # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine). # The Machine Series (e.g. "E2", "N2")
"code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing
},
},
],
},
"description": "A String", # Description for the Preference Set.
"displayName": "A String", # Display Name of the Preference Set
"machinePreferences": { # VirtualMachinePreferences enables you to create sets of assumptions, for example, a geographical location and pricing track, for your migrated virtual machines. The set of preferences influence recommendations for migrating virtual machine assets. # A set of preferences that applies to all machines in the context.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"computeEnginePreferences": { # The user preferences relating to Compute Engine target platform. # Compute Engine preferences concern insights and recommendations for Compute Engine target.
"licenseType": "A String", # License type to consider when calculating costs for virtual machine insights and recommendations. If unspecified, costs are calculated based on the default licensing plan.
"machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations. Not all machine types are available in all zones and regions. # Preferences concerning the machine types to consider on Compute Engine.
"allowedMachineSeries": [ # Compute Engine machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series.
{ # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine).
"code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing
},
],
},
"persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data.
},
"regionPreferences": { # The user preferences relating to target regions. # Region preferences for assets using this preference set. If you are unsure which value to set, the migration service API region is often a good value to start with.
"preferredRegions": [ # A list of preferred regions, ordered by the most preferred region first. Set only valid Google Cloud region names. See https://cloud.google.com/compute/docs/regions-zones for available regions.
"A String",
],
},
"sizingOptimizationStrategy": "A String", # Sizing optimization strategy specifies the preferred strategy used when extrapolating usage data to calculate insights and recommendations for a virtual machine. If you are unsure which value to set, a moderate sizing optimization strategy is often a good value to start with.
"soleTenancyPreferences": { # Preferences concerning Sole Tenancy nodes and VMs. # Preferences concerning Sole Tenant nodes and virtual machines.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 2.0 inclusive.
"hostMaintenancePolicy": "A String", # Sole Tenancy nodes maintenance policy.
"nodeTypes": [ # A list of sole tenant node types. An empty list means that all possible node types will be considered.
{ # A Sole Tenant node type.
"nodeName": "A String", # Name of the Sole Tenant node. Consult https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes
},
],
},
"targetProduct": "A String", # Target product for assets using this preference set. Specify either target product or business goal, but not both.
"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment.
"memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0.
"storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0.
},
},
"monthlyCostCompute": { # Represents an amount of money with its currency type. # Compute monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Network Egress monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Licensing monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostOther": { # Represents an amount of money with its currency type. # Miscellaneous monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostStorage": { # Represents an amount of money with its currency type. # Storage monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostTotal": { # Represents an amount of money with its currency type. # Total monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"soleTenantFinding": { # A set of findings that applies to assets destined for Sole-Tenant nodes. # A set of findings that applies to Sole-Tenant machines in the input.
"allocatedAssetCount": "A String", # Count of assets which are allocated
"allocatedRegions": [ # Set of regions in which the assets are allocated
"A String",
],
"nodeAllocations": [ # Set of per-nodetype allocation records
{ # Represents the assets allocated to a specific Sole-Tenant node type.
"allocatedAssetCount": "A String", # Count of assets allocated to these nodes
"node": { # A Sole Tenant node type. # Sole Tenant node type, e.g. "m3-node-128-3904"
"nodeName": "A String", # Name of the Sole Tenant node. Consult https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes
},
"nodeCount": "A String", # Count of this node type to be provisioned
},
],
},
"vmwareEngineFinding": { # A set of findings that applies to assets destined for VMWare Engine. # A set of findings that applies to VMWare machines in the input.
"allocatedAssetCount": "A String", # Count of assets which are allocated
"allocatedRegions": [ # Set of regions in which the assets were allocated
"A String",
],
"nodeAllocations": [ # Set of per-nodetype allocation records
{ # Represents assets allocated to a specific VMWare Node type.
"allocatedAssetCount": "A String", # Count of assets allocated to these nodes
"nodeCount": "A String", # Count of this node type to be provisioned
"vmwareNode": { # A VMWare Engine Node # VMWare node type, e.g. "ve1-standard-72"
"code": "A String", # Code to identify VMware Engine node series, e.g. "ve1-standard-72". Based on the displayName of cloud.google.com/vmware-engine/docs/reference/rest/v1/projects.locations.nodeTypes
},
},
],
},
},
],
},
],
},
"type": "A String", # Report type.
"updateTime": "A String", # Output only. Last update timestamp.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists Reports in a given ReportConfig.
Args:
parent: string, Required. Parent value for `ListReportsRequest`. (required)
filter: string, Filtering results.
orderBy: string, Field to sort by. See https://google.aip.dev/132#ordering for more details.
pageSize: integer, Requested page size. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default value.
pageToken: string, A token identifying a page of results that the server should return.
view: string, Determines what information to retrieve for each Report.
Allowed values
REPORT_VIEW_UNSPECIFIED - The report view is not specified. The API displays the basic view by default.
REPORT_VIEW_BASIC - The report view includes only basic metadata of the Report. Useful for list views.
REPORT_VIEW_FULL - The report view includes all the metadata of the Report. Useful for preview.
REPORT_VIEW_STANDARD - The report view includes the standard metadata of an report. Useful for detail view.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for listing Reports.
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"reports": [ # The list of Reports.
{ # Report represents a point-in-time rendering of the ReportConfig results.
"createTime": "A String", # Output only. Creation timestamp.
"description": "A String", # Free-text description.
"displayName": "A String", # User-friendly display name. Maximum length is 63 characters.
"name": "A String", # Output only. Name of resource.
"state": "A String", # Report creation state.
"summary": { # Describes the Summary view of a Report, which contains aggregated values for all the groups and preference sets included in this Report. # Output only. Summary view of the Report.
"allAssetsStats": { # Aggregate statistics for a collection of assets. # Aggregate statistics for all the assets across all the groups.
"coreCountHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of logical CPU core counts.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"memoryUtilizationChart": { # Utilization Chart is a specific type of visualization which displays a metric classified into "Used" and "Free" buckets. # Total memory split into Used/Free buckets.
"free": "A String", # Aggregate value which falls into the "Free" bucket.
"used": "A String", # Aggregate value which falls into the "Used" bucket.
},
"operatingSystem": { # Describes a collection of data points rendered as a Chart. # Count of assets grouped by Operating System families.
"dataPoints": [ # 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.
{ # Describes a single data point in the Chart.
"label": "A String", # The X-axis label for this data point.
"value": 3.14, # The Y-axis value for this data point.
},
],
},
"storageBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of storage sizes.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"storageUtilizationChart": { # Utilization Chart is a specific type of visualization which displays a metric classified into "Used" and "Free" buckets. # Total memory split into Used/Free buckets.
"free": "A String", # Aggregate value which falls into the "Free" bucket.
"used": "A String", # Aggregate value which falls into the "Used" bucket.
},
"totalAssets": "A String", # Count of the number of unique assets in this collection.
"totalCores": "A String", # Sum of the CPU core count of all the assets in this collection.
"totalMemoryBytes": "A String", # Sum of the memory in bytes of all the assets in this collection.
"totalStorageBytes": "A String", # Sum of persistent storage in bytes of all the assets in this collection.
},
"groupFindings": [ # Findings for each Group included in this report.
{ # Summary Findings for a specific Group.
"assetAggregateStats": { # Aggregate statistics for a collection of assets. # Summary statistics for all the assets in this group.
"coreCountHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of logical CPU core counts.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"memoryBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of memory sizes.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"memoryUtilizationChart": { # Utilization Chart is a specific type of visualization which displays a metric classified into "Used" and "Free" buckets. # Total memory split into Used/Free buckets.
"free": "A String", # Aggregate value which falls into the "Free" bucket.
"used": "A String", # Aggregate value which falls into the "Used" bucket.
},
"operatingSystem": { # Describes a collection of data points rendered as a Chart. # Count of assets grouped by Operating System families.
"dataPoints": [ # 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.
{ # Describes a single data point in the Chart.
"label": "A String", # The X-axis label for this data point.
"value": 3.14, # The Y-axis value for this data point.
},
],
},
"storageBytesHistogram": { # A Histogram Chart shows a distribution of values into buckets, showing a count of values which fall into a bucket. # Histogram showing a distribution of storage sizes.
"buckets": [ # 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.
{ # 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.
"count": "A String", # Count of items in the bucket.
"lowerBound": "A String", # Lower bound - inclusive.
"upperBound": "A String", # Upper bound - exclusive.
},
],
},
"storageUtilizationChart": { # Utilization Chart is a specific type of visualization which displays a metric classified into "Used" and "Free" buckets. # Total memory split into Used/Free buckets.
"free": "A String", # Aggregate value which falls into the "Free" bucket.
"used": "A String", # Aggregate value which falls into the "Used" bucket.
},
"totalAssets": "A String", # Count of the number of unique assets in this collection.
"totalCores": "A String", # Sum of the CPU core count of all the assets in this collection.
"totalMemoryBytes": "A String", # Sum of the memory in bytes of all the assets in this collection.
"totalStorageBytes": "A String", # Sum of persistent storage in bytes of all the assets in this collection.
},
"description": "A String", # Description for the Group.
"displayName": "A String", # Display Name for the Group.
"overlappingAssetCount": "A String", # This field is deprecated, do not rely on it having a value.
"preferenceSetFindings": [ # Findings for each of the PreferenceSets for this group.
{ # Summary Findings for a specific Group/PreferenceSet combination.
"computeEngineFinding": { # A set of findings that applies to assets destined for Compute Engine. # A set of findings that applies to Compute Engine machines in the input.
"allocatedAssetCount": "A String", # Count of assets which were allocated.
"allocatedDiskTypes": [ # Set of disk types allocated to assets.
"A String",
],
"allocatedRegions": [ # Set of regions in which the assets were allocated.
"A String",
],
"machineSeriesAllocations": [ # Distribution of assets based on the Machine Series.
{ # Represents a data point tracking the count of assets allocated for a specific Machine Series.
"allocatedAssetCount": "A String", # Count of assets allocated to this machine series.
"machineSeries": { # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine). # The Machine Series (e.g. "E2", "N2")
"code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing
},
},
],
},
"description": "A String", # Description for the Preference Set.
"displayName": "A String", # Display Name of the Preference Set
"machinePreferences": { # VirtualMachinePreferences enables you to create sets of assumptions, for example, a geographical location and pricing track, for your migrated virtual machines. The set of preferences influence recommendations for migrating virtual machine assets. # A set of preferences that applies to all machines in the context.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"computeEnginePreferences": { # The user preferences relating to Compute Engine target platform. # Compute Engine preferences concern insights and recommendations for Compute Engine target.
"licenseType": "A String", # License type to consider when calculating costs for virtual machine insights and recommendations. If unspecified, costs are calculated based on the default licensing plan.
"machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations. Not all machine types are available in all zones and regions. # Preferences concerning the machine types to consider on Compute Engine.
"allowedMachineSeries": [ # Compute Engine machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series.
{ # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine).
"code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing
},
],
},
"persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data.
},
"regionPreferences": { # The user preferences relating to target regions. # Region preferences for assets using this preference set. If you are unsure which value to set, the migration service API region is often a good value to start with.
"preferredRegions": [ # A list of preferred regions, ordered by the most preferred region first. Set only valid Google Cloud region names. See https://cloud.google.com/compute/docs/regions-zones for available regions.
"A String",
],
},
"sizingOptimizationStrategy": "A String", # Sizing optimization strategy specifies the preferred strategy used when extrapolating usage data to calculate insights and recommendations for a virtual machine. If you are unsure which value to set, a moderate sizing optimization strategy is often a good value to start with.
"soleTenancyPreferences": { # Preferences concerning Sole Tenancy nodes and VMs. # Preferences concerning Sole Tenant nodes and virtual machines.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 2.0 inclusive.
"hostMaintenancePolicy": "A String", # Sole Tenancy nodes maintenance policy.
"nodeTypes": [ # A list of sole tenant node types. An empty list means that all possible node types will be considered.
{ # A Sole Tenant node type.
"nodeName": "A String", # Name of the Sole Tenant node. Consult https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes
},
],
},
"targetProduct": "A String", # Target product for assets using this preference set. Specify either target product or business goal, but not both.
"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine.
"commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with.
"cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment.
"memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0.
"storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0.
},
},
"monthlyCostCompute": { # Represents an amount of money with its currency type. # Compute monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Network Egress monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Licensing monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostOther": { # Represents an amount of money with its currency type. # Miscellaneous monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostStorage": { # Represents an amount of money with its currency type. # Storage monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"monthlyCostTotal": { # Represents an amount of money with its currency type. # Total monthly cost for this preference set.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # 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.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"soleTenantFinding": { # A set of findings that applies to assets destined for Sole-Tenant nodes. # A set of findings that applies to Sole-Tenant machines in the input.
"allocatedAssetCount": "A String", # Count of assets which are allocated
"allocatedRegions": [ # Set of regions in which the assets are allocated
"A String",
],
"nodeAllocations": [ # Set of per-nodetype allocation records
{ # Represents the assets allocated to a specific Sole-Tenant node type.
"allocatedAssetCount": "A String", # Count of assets allocated to these nodes
"node": { # A Sole Tenant node type. # Sole Tenant node type, e.g. "m3-node-128-3904"
"nodeName": "A String", # Name of the Sole Tenant node. Consult https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes
},
"nodeCount": "A String", # Count of this node type to be provisioned
},
],
},
"vmwareEngineFinding": { # A set of findings that applies to assets destined for VMWare Engine. # A set of findings that applies to VMWare machines in the input.
"allocatedAssetCount": "A String", # Count of assets which are allocated
"allocatedRegions": [ # Set of regions in which the assets were allocated
"A String",
],
"nodeAllocations": [ # Set of per-nodetype allocation records
{ # Represents assets allocated to a specific VMWare Node type.
"allocatedAssetCount": "A String", # Count of assets allocated to these nodes
"nodeCount": "A String", # Count of this node type to be provisioned
"vmwareNode": { # A VMWare Engine Node # VMWare node type, e.g. "ve1-standard-72"
"code": "A String", # Code to identify VMware Engine node series, e.g. "ve1-standard-72". Based on the displayName of cloud.google.com/vmware-engine/docs/reference/rest/v1/projects.locations.nodeTypes
},
},
],
},
},
],
},
],
},
"type": "A String", # Report type.
"updateTime": "A String", # Output only. Last update timestamp.
},
],
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.