REST Resource: projects.locations.preferenceSets

Resource: PreferenceSet

The preferences that apply to all assets in a given context.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "displayName": string,
  "description": string,
  "virtualMachinePreferences": {
    object (VirtualMachinePreferences)
  }
}
Fields
name

string

Output only. Name of the preference set.
createTime

string (Timestamp format)

Output only. The timestamp when the preference set was created.

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. The timestamp when the preference set was last updated.

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

A description of the preference set.
virtualMachinePreferences

object (VirtualMachinePreferences)

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

VirtualMachinePreferences

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.

JSON representation 
{
  "regionPreferences": {
    object (RegionPreferences)
  },
  "commitmentPlan": enum (CommitmentPlan),
  "sizingOptimizationStrategy": enum (SizingOptimizationStrategy),
  "computeEnginePreferences": {
    object (ComputeEnginePreferences)
  }
}
Fields
regionPreferences

object (RegionPreferences)

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.
commitmentPlan

enum (CommitmentPlan)

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.
sizingOptimizationStrategy

enum (SizingOptimizationStrategy)

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.
computeEnginePreferences

object (ComputeEnginePreferences)

Compute Engine preferences concern insights and recommendations for Compute Engine target.

RegionPreferences

The user preferences relating to target regions.

JSON representation 
{
  "preferredRegions": [
    string
  ]
}
Fields
preferredRegions[]

string

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.

CommitmentPlan

The plan of commitments for VM resource-based committed use discount (CUD).

Enums
COMMITMENT_PLAN_UNSPECIFIED Unspecified commitment plan.
COMMITMENT_PLAN_NONE No commitment plan.
COMMITMENT_PLAN_ONE_YEAR 1 year commitment.
COMMITMENT_PLAN_THREE_YEARS 3 years commitment.

SizingOptimizationStrategy

The sizing optimization strategy preferences of a virtual machine. This strategy, in addition to actual usage data of the virtual machine, can help determine the recommended shape on the target platform.

Enums
SIZING_OPTIMIZATION_STRATEGY_UNSPECIFIED Unspecified (default value).
SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE No optimization applied. Virtual machine sizing matches as closely as possible the machine shape on the source site, not considering any actual performance data.
SIZING_OPTIMIZATION_STRATEGY_MODERATE Virtual machine sizing will match the reported usage and shape, with some slack. This a good value to start with.
SIZING_OPTIMIZATION_STRATEGY_AGGRESSIVE Virtual machine sizing will match the reported usage, with little slack. Using this option can help reduce costs.

ComputeEnginePreferences

The user preferences relating to Compute Engine target platform.

JSON representation 
{
  "persistentDiskType": enum (PersistentDiskType),
  "machinePreferences": {
    object (MachinePreferences)
  },
  "licenseType": enum (LicenseType)
}
Fields
persistentDiskType

enum (PersistentDiskType)

Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data.
machinePreferences

object (MachinePreferences)

Preferences concerning the machine types to consider on Compute Engine.
licenseType

enum (LicenseType)

License type to consider when calculating costs for virtual machine insights and recommendations. If unspecified, costs are calculated based on the default licensing plan.

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.

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.

JSON representation 
{
  "allowedMachineSeries": [
    {
      object (MachineSeries)
    }
  ]
}
Fields
allowedMachineSeries[]

object (MachineSeries)

Compute Engine machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series.

MachineSeries

A Compute Engine machine series.

JSON representation 
{
  "code": string
}
Fields
code

string

Code to identify a Compute Engine machine series. Consult https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison for more details on the available series.

LicenseType

The License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).

Enums
LICENSE_TYPE_UNSPECIFIED Unspecified (default value).
LICENSE_TYPE_DEFAULT Default Google Cloud licensing plan. Licensing is charged per usage. This a good value to start with.
LICENSE_TYPE_BRING_YOUR_OWN_LICENSE Bring-your-own-license (BYOL) plan. User provides the OS license.

Methods

create

 Creates a new preference set in a given project and location.

delete

 Deletes a preference set.

get

 Gets the details of a preference set.

list

 Lists all the preference sets in a given project and location.

patch

 Updates the parameters of a preference set.