Interface AllocationPolicyOrBuilder (0.54.0)

Version 0.54.0

• 0.55.0 (latest)
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 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.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.2
• 0.2.2
• 0.1.1

public interface AllocationPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

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.

map<string, string> labels = 6;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getInstances(int index)

public abstract AllocationPolicy.InstancePolicyOrTemplate getInstances(int index)

Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.

repeated .google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
AllocationPolicy.InstancePolicyOrTemplate

getInstancesCount()

public abstract int getInstancesCount()

Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.

repeated .google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

Returns
Type	Description
int

getInstancesList()

public abstract List<AllocationPolicy.InstancePolicyOrTemplate> getInstancesList()

Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.

repeated .google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

Returns
Type	Description
List<InstancePolicyOrTemplate>

getInstancesOrBuilder(int index)

public abstract AllocationPolicy.InstancePolicyOrTemplateOrBuilder getInstancesOrBuilder(int index)

Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.

repeated .google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
AllocationPolicy.InstancePolicyOrTemplateOrBuilder

getInstancesOrBuilderList()

public abstract List<? extends AllocationPolicy.InstancePolicyOrTemplateOrBuilder> getInstancesOrBuilderList()

Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.

repeated .google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

Returns
Type	Description
List<? extends com.google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplateOrBuilder>

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

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.

map<string, string> labels = 6;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

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.

map<string, string> labels = 6;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 6;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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.

map<string, string> labels = 6;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getLocation()

public abstract AllocationPolicy.LocationPolicy getLocation()

Location where compute resources should be allocated for the Job.

.google.cloud.batch.v1.AllocationPolicy.LocationPolicy location = 1;

Returns
Type	Description
AllocationPolicy.LocationPolicy	The location.

getLocationOrBuilder()

public abstract AllocationPolicy.LocationPolicyOrBuilder getLocationOrBuilder()

Location where compute resources should be allocated for the Job.

.google.cloud.batch.v1.AllocationPolicy.LocationPolicy location = 1;

Returns
Type	Description
AllocationPolicy.LocationPolicyOrBuilder

getNetwork()

public abstract AllocationPolicy.NetworkPolicy getNetwork()

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.

.google.cloud.batch.v1.AllocationPolicy.NetworkPolicy network = 7;

Returns
Type	Description
AllocationPolicy.NetworkPolicy	The network.

getNetworkOrBuilder()

public abstract AllocationPolicy.NetworkPolicyOrBuilder getNetworkOrBuilder()

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.

.google.cloud.batch.v1.AllocationPolicy.NetworkPolicy network = 7;

Returns
Type	Description
AllocationPolicy.NetworkPolicyOrBuilder

getPlacement()

public abstract AllocationPolicy.PlacementPolicy getPlacement()

The placement policy.

.google.cloud.batch.v1.AllocationPolicy.PlacementPolicy placement = 10;

Returns
Type	Description
AllocationPolicy.PlacementPolicy	The placement.

getPlacementOrBuilder()

public abstract AllocationPolicy.PlacementPolicyOrBuilder getPlacementOrBuilder()

The placement policy.

.google.cloud.batch.v1.AllocationPolicy.PlacementPolicy placement = 10;

Returns
Type	Description
AllocationPolicy.PlacementPolicyOrBuilder

getServiceAccount()

public abstract ServiceAccount getServiceAccount()

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)

.google.cloud.batch.v1.ServiceAccount service_account = 9;

Returns
Type	Description
ServiceAccount	The serviceAccount.

getServiceAccountOrBuilder()

public abstract ServiceAccountOrBuilder getServiceAccountOrBuilder()

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)

.google.cloud.batch.v1.ServiceAccount service_account = 9;

Returns
Type	Description
ServiceAccountOrBuilder

getTags(int index)

public abstract String getTags(int index)

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.

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The tags at the given index.

getTagsBytes(int index)

public abstract ByteString getTagsBytes(int index)

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.

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the tags at the given index.

getTagsCount()

public abstract int getTagsCount()

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.

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of tags.

getTagsList()

public abstract List<String> getTagsList()

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.

repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the tags.

hasLocation()

public abstract boolean hasLocation()

Location where compute resources should be allocated for the Job.

.google.cloud.batch.v1.AllocationPolicy.LocationPolicy location = 1;

Returns
Type	Description
boolean	Whether the location field is set.

hasNetwork()

public abstract boolean hasNetwork()

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.

.google.cloud.batch.v1.AllocationPolicy.NetworkPolicy network = 7;

Returns
Type	Description
boolean	Whether the network field is set.

hasPlacement()

public abstract boolean hasPlacement()

The placement policy.

.google.cloud.batch.v1.AllocationPolicy.PlacementPolicy placement = 10;

Returns
Type	Description
boolean	Whether the placement field is set.

hasServiceAccount()

public abstract boolean hasServiceAccount()

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)

.google.cloud.batch.v1.ServiceAccount service_account = 9;

Returns
Type	Description
boolean	Whether the serviceAccount field is set.