Class: Google::Cloud::Compute::V1::Scheduling

Inherits:

Object

Object
Google::Cloud::Compute::V1::Scheduling

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/compute/v1/compute.rb

Overview

Sets the scheduling options for an Instance.

Defined Under Namespace

Modules: InstanceTerminationAction, OnHostMaintenance, ProvisioningModel

Instance Attribute Summary collapse

#automatic_restart ⇒ ::Boolean
Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
#instance_termination_action ⇒ ::String
Specifies the termination action for the instance.
#local_ssd_recovery_timeout ⇒ ::Google::Cloud::Compute::V1::Duration
Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted.
#location_hint ⇒ ::String
An opaque location hint used to place the instance close to other resources.
#min_node_cpus ⇒ ::Integer
The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
#node_affinities ⇒ ::Array<::Google::Cloud::Compute::V1::SchedulingNodeAffinity>
A set of node affinity and anti-affinity configurations.
#on_host_maintenance ⇒ ::String
Defines the maintenance behavior for this instance.
#preemptible ⇒ ::Boolean
Defines whether the instance is preemptible.
#provisioning_model ⇒ ::String
Specifies the provisioning model of the instance.

Instance Attribute Details

#automatic_restart ⇒ `::Boolean`

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

Returns:

(::Boolean) —
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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26863

class Scheduling
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the termination action for the instance.
  module InstanceTerminationAction
    # A value indicating that the enum field is not set.
    UNDEFINED_INSTANCE_TERMINATION_ACTION = 0

    # Delete the VM.
    DELETE = 402_225_579

    # Default value. This value is unused.
    INSTANCE_TERMINATION_ACTION_UNSPECIFIED = 92_954_803

    # Stop the VM without storing in-memory content. default action.
    STOP = 2_555_906
  end

  # 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.
  module OnHostMaintenance
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_HOST_MAINTENANCE = 0

    # *[Default]* Allows Compute Engine to automatically migrate instances out of the way of maintenance events.
    MIGRATE = 165_699_979

    # Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events.
    TERMINATE = 527_617_601
  end

  # Specifies the provisioning model of the instance.
  module ProvisioningModel
    # A value indicating that the enum field is not set.
    UNDEFINED_PROVISIONING_MODEL = 0

    # Heavily discounted, no guaranteed runtime.
    SPOT = 2_552_066

    # Standard provisioning with user controlled runtime, no discounts.
    STANDARD = 484_642_493
  end
end

#instance_termination_action ⇒ `::String`

Returns Specifies the termination action for the instance. Check the InstanceTerminationAction enum for the list of possible values.

Returns:

(::String) —
Specifies the termination action for the instance. Check the InstanceTerminationAction enum for the list of possible values.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26863

class Scheduling
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the termination action for the instance.
  module InstanceTerminationAction
    # A value indicating that the enum field is not set.
    UNDEFINED_INSTANCE_TERMINATION_ACTION = 0

    # Delete the VM.
    DELETE = 402_225_579

    # Default value. This value is unused.
    INSTANCE_TERMINATION_ACTION_UNSPECIFIED = 92_954_803

    # Stop the VM without storing in-memory content. default action.
    STOP = 2_555_906
  end

  # 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.
  module OnHostMaintenance
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_HOST_MAINTENANCE = 0

    # *[Default]* Allows Compute Engine to automatically migrate instances out of the way of maintenance events.
    MIGRATE = 165_699_979

    # Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events.
    TERMINATE = 527_617_601
  end

  # Specifies the provisioning model of the instance.
  module ProvisioningModel
    # A value indicating that the enum field is not set.
    UNDEFINED_PROVISIONING_MODEL = 0

    # Heavily discounted, no guaranteed runtime.
    SPOT = 2_552_066

    # Standard provisioning with user controlled runtime, no discounts.
    STANDARD = 484_642_493
  end
end

#local_ssd_recovery_timeout ⇒ `::Google::Cloud::Compute::V1::Duration`

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

Returns:

(::Google::Cloud::Compute::V1::Duration) —
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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26863

class Scheduling
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the termination action for the instance.
  module InstanceTerminationAction
    # A value indicating that the enum field is not set.
    UNDEFINED_INSTANCE_TERMINATION_ACTION = 0

    # Delete the VM.
    DELETE = 402_225_579

    # Default value. This value is unused.
    INSTANCE_TERMINATION_ACTION_UNSPECIFIED = 92_954_803

    # Stop the VM without storing in-memory content. default action.
    STOP = 2_555_906
  end

  # 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.
  module OnHostMaintenance
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_HOST_MAINTENANCE = 0

    # *[Default]* Allows Compute Engine to automatically migrate instances out of the way of maintenance events.
    MIGRATE = 165_699_979

    # Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events.
    TERMINATE = 527_617_601
  end

  # Specifies the provisioning model of the instance.
  module ProvisioningModel
    # A value indicating that the enum field is not set.
    UNDEFINED_PROVISIONING_MODEL = 0

    # Heavily discounted, no guaranteed runtime.
    SPOT = 2_552_066

    # Standard provisioning with user controlled runtime, no discounts.
    STANDARD = 484_642_493
  end
end

#location_hint ⇒ `::String`

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

Returns:

(::String) —
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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26863

class Scheduling
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the termination action for the instance.
  module InstanceTerminationAction
    # A value indicating that the enum field is not set.
    UNDEFINED_INSTANCE_TERMINATION_ACTION = 0

    # Delete the VM.
    DELETE = 402_225_579

    # Default value. This value is unused.
    INSTANCE_TERMINATION_ACTION_UNSPECIFIED = 92_954_803

    # Stop the VM without storing in-memory content. default action.
    STOP = 2_555_906
  end

  # 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.
  module OnHostMaintenance
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_HOST_MAINTENANCE = 0

    # *[Default]* Allows Compute Engine to automatically migrate instances out of the way of maintenance events.
    MIGRATE = 165_699_979

    # Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events.
    TERMINATE = 527_617_601
  end

  # Specifies the provisioning model of the instance.
  module ProvisioningModel
    # A value indicating that the enum field is not set.
    UNDEFINED_PROVISIONING_MODEL = 0

    # Heavily discounted, no guaranteed runtime.
    SPOT = 2_552_066

    # Standard provisioning with user controlled runtime, no discounts.
    STANDARD = 484_642_493
  end
end

#min_node_cpus ⇒ `::Integer`

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

Returns:

(::Integer) —
The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26863

class Scheduling
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the termination action for the instance.
  module InstanceTerminationAction
    # A value indicating that the enum field is not set.
    UNDEFINED_INSTANCE_TERMINATION_ACTION = 0

    # Delete the VM.
    DELETE = 402_225_579

    # Default value. This value is unused.
    INSTANCE_TERMINATION_ACTION_UNSPECIFIED = 92_954_803

    # Stop the VM without storing in-memory content. default action.
    STOP = 2_555_906
  end

  # 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.
  module OnHostMaintenance
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_HOST_MAINTENANCE = 0

    # *[Default]* Allows Compute Engine to automatically migrate instances out of the way of maintenance events.
    MIGRATE = 165_699_979

    # Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events.
    TERMINATE = 527_617_601
  end

  # Specifies the provisioning model of the instance.
  module ProvisioningModel
    # A value indicating that the enum field is not set.
    UNDEFINED_PROVISIONING_MODEL = 0

    # Heavily discounted, no guaranteed runtime.
    SPOT = 2_552_066

    # Standard provisioning with user controlled runtime, no discounts.
    STANDARD = 484_642_493
  end
end

#node_affinities ⇒ `::Array<::Google::Cloud::Compute::V1::SchedulingNodeAffinity>`

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

Returns:

(::Array<::Google::Cloud::Compute::V1::SchedulingNodeAffinity>) —
A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26863

class Scheduling
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the termination action for the instance.
  module InstanceTerminationAction
    # A value indicating that the enum field is not set.
    UNDEFINED_INSTANCE_TERMINATION_ACTION = 0

    # Delete the VM.
    DELETE = 402_225_579

    # Default value. This value is unused.
    INSTANCE_TERMINATION_ACTION_UNSPECIFIED = 92_954_803

    # Stop the VM without storing in-memory content. default action.
    STOP = 2_555_906
  end

  # 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.
  module OnHostMaintenance
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_HOST_MAINTENANCE = 0

    # *[Default]* Allows Compute Engine to automatically migrate instances out of the way of maintenance events.
    MIGRATE = 165_699_979

    # Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events.
    TERMINATE = 527_617_601
  end

  # Specifies the provisioning model of the instance.
  module ProvisioningModel
    # A value indicating that the enum field is not set.
    UNDEFINED_PROVISIONING_MODEL = 0

    # Heavily discounted, no guaranteed runtime.
    SPOT = 2_552_066

    # Standard provisioning with user controlled runtime, no discounts.
    STANDARD = 484_642_493
  end
end

#on_host_maintenance ⇒ `::String`

Returns 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. Check the OnHostMaintenance enum for the list of possible values.

Returns:

(::String) —
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. Check the OnHostMaintenance enum for the list of possible values.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26863

class Scheduling
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the termination action for the instance.
  module InstanceTerminationAction
    # A value indicating that the enum field is not set.
    UNDEFINED_INSTANCE_TERMINATION_ACTION = 0

    # Delete the VM.
    DELETE = 402_225_579

    # Default value. This value is unused.
    INSTANCE_TERMINATION_ACTION_UNSPECIFIED = 92_954_803

    # Stop the VM without storing in-memory content. default action.
    STOP = 2_555_906
  end

  # 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.
  module OnHostMaintenance
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_HOST_MAINTENANCE = 0

    # *[Default]* Allows Compute Engine to automatically migrate instances out of the way of maintenance events.
    MIGRATE = 165_699_979

    # Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events.
    TERMINATE = 527_617_601
  end

  # Specifies the provisioning model of the instance.
  module ProvisioningModel
    # A value indicating that the enum field is not set.
    UNDEFINED_PROVISIONING_MODEL = 0

    # Heavily discounted, no guaranteed runtime.
    SPOT = 2_552_066

    # Standard provisioning with user controlled runtime, no discounts.
    STANDARD = 484_642_493
  end
end

#preemptible ⇒ `::Boolean`

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

Returns:

(::Boolean) —
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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26863

class Scheduling
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the termination action for the instance.
  module InstanceTerminationAction
    # A value indicating that the enum field is not set.
    UNDEFINED_INSTANCE_TERMINATION_ACTION = 0

    # Delete the VM.
    DELETE = 402_225_579

    # Default value. This value is unused.
    INSTANCE_TERMINATION_ACTION_UNSPECIFIED = 92_954_803

    # Stop the VM without storing in-memory content. default action.
    STOP = 2_555_906
  end

  # 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.
  module OnHostMaintenance
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_HOST_MAINTENANCE = 0

    # *[Default]* Allows Compute Engine to automatically migrate instances out of the way of maintenance events.
    MIGRATE = 165_699_979

    # Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events.
    TERMINATE = 527_617_601
  end

  # Specifies the provisioning model of the instance.
  module ProvisioningModel
    # A value indicating that the enum field is not set.
    UNDEFINED_PROVISIONING_MODEL = 0

    # Heavily discounted, no guaranteed runtime.
    SPOT = 2_552_066

    # Standard provisioning with user controlled runtime, no discounts.
    STANDARD = 484_642_493
  end
end

#provisioning_model ⇒ `::String`

Returns Specifies the provisioning model of the instance. Check the ProvisioningModel enum for the list of possible values.

Returns:

(::String) —
Specifies the provisioning model of the instance. Check the ProvisioningModel enum for the list of possible values.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 26863

class Scheduling
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the termination action for the instance.
  module InstanceTerminationAction
    # A value indicating that the enum field is not set.
    UNDEFINED_INSTANCE_TERMINATION_ACTION = 0

    # Delete the VM.
    DELETE = 402_225_579

    # Default value. This value is unused.
    INSTANCE_TERMINATION_ACTION_UNSPECIFIED = 92_954_803

    # Stop the VM without storing in-memory content. default action.
    STOP = 2_555_906
  end

  # 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.
  module OnHostMaintenance
    # A value indicating that the enum field is not set.
    UNDEFINED_ON_HOST_MAINTENANCE = 0

    # *[Default]* Allows Compute Engine to automatically migrate instances out of the way of maintenance events.
    MIGRATE = 165_699_979

    # Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events.
    TERMINATE = 527_617_601
  end

  # Specifies the provisioning model of the instance.
  module ProvisioningModel
    # A value indicating that the enum field is not set.
    UNDEFINED_PROVISIONING_MODEL = 0

    # Heavily discounted, no guaranteed runtime.
    SPOT = 2_552_066

    # Standard provisioning with user controlled runtime, no discounts.
    STANDARD = 484_642_493
  end
end

Class: Google::Cloud::Compute::V1::Scheduling

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#automatic_restart ⇒ ::Boolean

#instance_termination_action ⇒ ::String

#local_ssd_recovery_timeout ⇒ ::Google::Cloud::Compute::V1::Duration

#location_hint ⇒ ::String

#min_node_cpus ⇒ ::Integer

#node_affinities ⇒ ::Array<::Google::Cloud::Compute::V1::SchedulingNodeAffinity>

#on_host_maintenance ⇒ ::String

#preemptible ⇒ ::Boolean

#provisioning_model ⇒ ::String

#automatic_restart ⇒ `::Boolean`

#instance_termination_action ⇒ `::String`

#local_ssd_recovery_timeout ⇒ `::Google::Cloud::Compute::V1::Duration`

#location_hint ⇒ `::String`

#min_node_cpus ⇒ `::Integer`

#node_affinities ⇒ `::Array<::Google::Cloud::Compute::V1::SchedulingNodeAffinity>`

#on_host_maintenance ⇒ `::String`

#preemptible ⇒ `::Boolean`

#provisioning_model ⇒ `::String`