Class AllocationPolicy (0.17.6rc0)

Version 0.17.6-rc0

• 0.17.31 (latest)
• 0.17.30
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.1
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.2
• 0.2.0
• 0.1.2

AllocationPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.

Attributes
Name	Description
location	google.cloud.batch_v1alpha.types.AllocationPolicy.LocationPolicy Location where compute resources should be allocated for the Job.
instance	google.cloud.batch_v1alpha.types.AllocationPolicy.InstancePolicy Deprecated: please use instances[0].policy instead.
instances	MutableSequence[google.cloud.batch_v1alpha.types.AllocationPolicy.InstancePolicyOrTemplate] Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
instance_templates	MutableSequence[str] Deprecated: please use instances[0].template instead.
provisioning_models	MutableSequence[google.cloud.batch_v1alpha.types.AllocationPolicy.ProvisioningModel] Deprecated: please use instances[0].policy.provisioning_model instead.
service_account_email	str Deprecated: please use service_account instead.
service_account	google.cloud.batch_v1alpha.types.ServiceAccount Service account that VMs will run as.
labels	MutableMapping[str, str] Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. `Google Compute Engine label restrictions
network	google.cloud.batch_v1alpha.types.AllocationPolicy.NetworkPolicy The network policy. If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.
placement	google.cloud.batch_v1alpha.types.AllocationPolicy.PlacementPolicy The placement policy.

Classes

Accelerator

Accelerator(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Accelerator describes Compute Engine accelerators to be attached to the VM.

AttachedDisk

AttachedDisk(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Disk

Disk(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A new persistent disk or a local ssd. A VM can only have one local SSD setting but multiple local SSD partitions. See https://cloud.google.com/compute/docs/disks#pdspecs and https://cloud.google.com/compute/docs/disks#localssds.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

InstancePolicy

InstancePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.

InstancePolicyOrTemplate

InstancePolicyOrTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

LocationPolicy

LocationPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

NetworkInterface

NetworkInterface(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A network interface.

NetworkPolicy

NetworkPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

NetworkPolicy describes VM instance network configurations.

PlacementPolicy

PlacementPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.

ProvisioningModel

ProvisioningModel(value)

Compute Engine VM instance provisioning model.

Values: PROVISIONING_MODEL_UNSPECIFIED (0): Unspecified. STANDARD (1): Standard VM. SPOT (2): SPOT VM. PREEMPTIBLE (3): Preemptible VM (PVM).

    Above SPOT VM is the preferable model for
    preemptible VM instances: the old preemptible VM
    model (indicated by this field) is the older
    model, and has been migrated to use the SPOT
    model as the underlying technology. This old
    model will still be supported.