Batch V1 API - Class Google::Cloud::Batch::V1::AllocationPolicy (v0.17.3)

Reference documentation and code samples for the Batch V1 API class Google::Cloud::Batch::V1::AllocationPolicy.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#instances

def instances() -> ::Array<::Google::Cloud::Batch::V1::AllocationPolicy::InstancePolicyOrTemplate>

Returns

(::Array<::Google::Cloud::Batch::V1::AllocationPolicy::InstancePolicyOrTemplate>) — Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.

#instances=

def instances=(value) -> ::Array<::Google::Cloud::Batch::V1::AllocationPolicy::InstancePolicyOrTemplate>

Parameter

value (::Array<::Google::Cloud::Batch::V1::AllocationPolicy::InstancePolicyOrTemplate>) — Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.

Returns

(::Array<::Google::Cloud::Batch::V1::AllocationPolicy::InstancePolicyOrTemplate>) — Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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 apply. Label names that start with "goog-" or "google-" are reserved.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — 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 apply. Label names that start with "goog-" or "google-" are reserved.

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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 apply. Label names that start with "goog-" or "google-" are reserved.

#location

def location() -> ::Google::Cloud::Batch::V1::AllocationPolicy::LocationPolicy

Returns

(::Google::Cloud::Batch::V1::AllocationPolicy::LocationPolicy) — Location where compute resources should be allocated for the Job.

#location=

def location=(value) -> ::Google::Cloud::Batch::V1::AllocationPolicy::LocationPolicy

Parameter

value (::Google::Cloud::Batch::V1::AllocationPolicy::LocationPolicy) — Location where compute resources should be allocated for the Job.

Returns

(::Google::Cloud::Batch::V1::AllocationPolicy::LocationPolicy) — Location where compute resources should be allocated for the Job.

#network

def network() -> ::Google::Cloud::Batch::V1::AllocationPolicy::NetworkPolicy

Returns

(::Google::Cloud::Batch::V1::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.

#network=

def network=(value) -> ::Google::Cloud::Batch::V1::AllocationPolicy::NetworkPolicy

Parameter

value (::Google::Cloud::Batch::V1::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.

Returns

(::Google::Cloud::Batch::V1::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

def placement() -> ::Google::Cloud::Batch::V1::AllocationPolicy::PlacementPolicy

Returns

(::Google::Cloud::Batch::V1::AllocationPolicy::PlacementPolicy) — The placement policy.

#placement=

def placement=(value) -> ::Google::Cloud::Batch::V1::AllocationPolicy::PlacementPolicy

Parameter

value (::Google::Cloud::Batch::V1::AllocationPolicy::PlacementPolicy) — The placement policy.

Returns

(::Google::Cloud::Batch::V1::AllocationPolicy::PlacementPolicy) — The placement policy.

#service_account

def service_account() -> ::Google::Cloud::Batch::V1::ServiceAccount

Returns

(::Google::Cloud::Batch::V1::ServiceAccount) —
Defines the service account for Batch-created VMs. If omitted, the default Compute Engine service account is used. Must match the service account specified in any used instance template configured in the Batch job.

Includes the following fields:
- email: The service account's email address. If not set, the default Compute Engine service account is used.
- scopes: Additional OAuth scopes to grant the service account, beyond the default cloud-platform scope. (list of strings)

#service_account=

def service_account=(value) -> ::Google::Cloud::Batch::V1::ServiceAccount

Parameter

value (::Google::Cloud::Batch::V1::ServiceAccount) —
Defines the service account for Batch-created VMs. If omitted, the default Compute Engine service account is used. Must match the service account specified in any used instance template configured in the Batch job.

Includes the following fields:
- email: The service account's email address. If not set, the default Compute Engine service account is used.
- scopes: Additional OAuth scopes to grant the service account, beyond the default cloud-platform scope. (list of strings)

Returns

(::Google::Cloud::Batch::V1::ServiceAccount) —
Defines the service account for Batch-created VMs. If omitted, the default Compute Engine service account is used. Must match the service account specified in any used instance template configured in the Batch job.

Includes the following fields:
- email: The service account's email address. If not set, the default Compute Engine service account is used.
- scopes: Additional OAuth scopes to grant the service account, beyond the default cloud-platform scope. (list of strings)

#tags

def tags() -> ::Array<::String>

Returns

(::Array<::String>) — Optional. Tags applied to the VM instances.

The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035.

#tags=

def tags=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — Optional. Tags applied to the VM instances.

The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035.

Returns

(::Array<::String>) — Optional. Tags applied to the VM instances.

The tags identify valid sources or targets for network firewalls. Each tag must be 1-63 characters long, and comply with RFC1035.