Show / Hide Table of Contents

Class Scheduling

Sets the scheduling options for an Instance.

Inheritance
object
Scheduling
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Compute.alpha.Data
Assembly: Google.Apis.Compute.alpha.dll
Syntax
public class Scheduling : IDirectResponseSchema

Properties

AutomaticRestart

Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

Declaration
[JsonProperty("automaticRestart")]
public virtual bool? AutomaticRestart { get; set; }
Property Value
Type Description
bool?

AvailabilityDomain

Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.

Declaration
[JsonProperty("availabilityDomain")]
public virtual int? AvailabilityDomain { get; set; }
Property Value
Type Description
int?

CurrentCpus

Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type.

Declaration
[JsonProperty("currentCpus")]
public virtual int? CurrentCpus { get; set; }
Property Value
Type Description
int?

CurrentMemoryMb

Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type.

Declaration
[JsonProperty("currentMemoryMb")]
public virtual long? CurrentMemoryMb { get; set; }
Property Value
Type Description
long?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

GracefulShutdown

Declaration
[JsonProperty("gracefulShutdown")]
public virtual SchedulingGracefulShutdown GracefulShutdown { get; set; }
Property Value
Type Description
SchedulingGracefulShutdown

HostErrorTimeoutSeconds

Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.

Declaration
[JsonProperty("hostErrorTimeoutSeconds")]
public virtual int? HostErrorTimeoutSeconds { get; set; }
Property Value
Type Description
int?

InstanceTerminationAction

Specifies the termination action for the instance.

Declaration
[JsonProperty("instanceTerminationAction")]
public virtual string InstanceTerminationAction { get; set; }
Property Value
Type Description
string

LatencyTolerant

Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

Declaration
[JsonProperty("latencyTolerant")]
public virtual bool? LatencyTolerant { get; set; }
Property Value
Type Description
bool?

LocalSsdRecoveryTimeout

Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.

Declaration
[JsonProperty("localSsdRecoveryTimeout")]
public virtual Duration LocalSsdRecoveryTimeout { get; set; }
Property Value
Type Description
Duration

LocationHint

An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

Declaration
[JsonProperty("locationHint")]
public virtual string LocationHint { get; set; }
Property Value
Type Description
string

MaintenanceFreezeDurationHours

Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

Declaration
[JsonProperty("maintenanceFreezeDurationHours")]
public virtual int? MaintenanceFreezeDurationHours { get; set; }
Property Value
Type Description
int?

MaintenanceInterval

Specifies the frequency of planned maintenance events. The accepted values are: PERIODIC.

Declaration
[JsonProperty("maintenanceInterval")]
public virtual string MaintenanceInterval { get; set; }
Property Value
Type Description
string

MaxRunDuration

Specifies the max run duration for the given instance. If specified, the instance termination action will be performed at the end of the run duration.

Declaration
[JsonProperty("maxRunDuration")]
public virtual Duration MaxRunDuration { get; set; }
Property Value
Type Description
Duration

MinNodeCpus

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

Declaration
[JsonProperty("minNodeCpus")]
public virtual int? MinNodeCpus { get; set; }
Property Value
Type Description
int?

NodeAffinities

A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

Declaration
[JsonProperty("nodeAffinities")]
public virtual IList<SchedulingNodeAffinity> NodeAffinities { get; set; }
Property Value
Type Description
IList<SchedulingNodeAffinity>

OnHostMaintenance

Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy.

Declaration
[JsonProperty("onHostMaintenance")]
public virtual string OnHostMaintenance { get; set; }
Property Value
Type Description
string

OnInstanceStopAction

Declaration
[JsonProperty("onInstanceStopAction")]
public virtual SchedulingOnInstanceStopAction OnInstanceStopAction { get; set; }
Property Value
Type Description
SchedulingOnInstanceStopAction

Preemptible

Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a TERMINATED state. See Instance Life Cycle for more information on the possible instance states.

Declaration
[JsonProperty("preemptible")]
public virtual bool? Preemptible { get; set; }
Property Value
Type Description
bool?

ProvisioningModel

Specifies the provisioning model of the instance.

Declaration
[JsonProperty("provisioningModel")]
public virtual string ProvisioningModel { get; set; }
Property Value
Type Description
string

ShutdownTimeout

DEPRECATED: please use skipGuestOsShutdown. Timeout between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off during shutdown operation of VM. For Standard VMs values between 0s and 120s are allowed. For Spot and Preemptible VMs supported values are between 0s and 30s. If no value is specified for shutdownDuration, default values are 90s for Standard VMs and 30s for Spot/Preemptible VMs.

Declaration
[JsonProperty("shutdownTimeout")]
public virtual Duration ShutdownTimeout { get; set; }
Property Value
Type Description
Duration

TerminationTime

Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time.

Declaration
[JsonProperty("terminationTime")]
public virtual string TerminationTime { get; set; }
Property Value
Type Description
string

WindowsLicenseOptimizationMode

Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is OFF.

Declaration
[JsonProperty("windowsLicenseOptimizationMode")]
public virtual string WindowsLicenseOptimizationMode { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX