Package com.google.cloud.batch.v1alpha

Interface AllocationPolicyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AllocationPolicy, AllocationPolicy.Builder
@Generated public interface AllocationPolicyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasLocation

      boolean hasLocation()
       Location where compute resources should be allocated for the Job.
      .google.cloud.batch.v1alpha.AllocationPolicy.LocationPolicy location = 1;
      Returns:
      Whether the location field is set.

    • getLocation

      AllocationPolicy.LocationPolicy getLocation()
       Location where compute resources should be allocated for the Job.
      .google.cloud.batch.v1alpha.AllocationPolicy.LocationPolicy location = 1;
      Returns:
      The location.

    • getLocationOrBuilder

      AllocationPolicy.LocationPolicyOrBuilder getLocationOrBuilder()
       Location where compute resources should be allocated for the Job.
      .google.cloud.batch.v1alpha.AllocationPolicy.LocationPolicy location = 1;

    • hasInstance

      @Deprecated boolean hasInstance()
      Deprecated.
      google.cloud.batch.v1alpha.AllocationPolicy.instance is deprecated. See google/cloud/batch/v1alpha/job.proto;l=642
       Deprecated: please use instances[0].policy instead.
      .google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicy instance = 2 [deprecated = true];
      Returns:
      Whether the instance field is set.

    • getInstance

      @Deprecated AllocationPolicy.InstancePolicy getInstance()
      Deprecated.
      google.cloud.batch.v1alpha.AllocationPolicy.instance is deprecated. See google/cloud/batch/v1alpha/job.proto;l=642
       Deprecated: please use instances[0].policy instead.
      .google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicy instance = 2 [deprecated = true];
      Returns:
      The instance.

    • getInstanceOrBuilder

      @Deprecated AllocationPolicy.InstancePolicyOrBuilder getInstanceOrBuilder()
      Deprecated.
       Deprecated: please use instances[0].policy instead.
      .google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicy instance = 2 [deprecated = true];

    • getInstancesList

      List<AllocationPolicy.InstancePolicyOrTemplate> getInstancesList()
       Describe instances that can be created by this AllocationPolicy.
 Only instances[0] is supported now.
      repeated .google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

    • getInstances

      AllocationPolicy.InstancePolicyOrTemplate getInstances(int index)
       Describe instances that can be created by this AllocationPolicy.
 Only instances[0] is supported now.
      repeated .google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

    • getInstancesCount

      int getInstancesCount()
       Describe instances that can be created by this AllocationPolicy.
 Only instances[0] is supported now.
      repeated .google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

    • getInstancesOrBuilderList

      List<? extends AllocationPolicy.InstancePolicyOrTemplateOrBuilder> getInstancesOrBuilderList()
       Describe instances that can be created by this AllocationPolicy.
 Only instances[0] is supported now.
      repeated .google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

    • getInstancesOrBuilder

      AllocationPolicy.InstancePolicyOrTemplateOrBuilder getInstancesOrBuilder(int index)
       Describe instances that can be created by this AllocationPolicy.
 Only instances[0] is supported now.
      repeated .google.cloud.batch.v1alpha.AllocationPolicy.InstancePolicyOrTemplate instances = 8;

    • getInstanceTemplatesList

      @Deprecated List<String> getInstanceTemplatesList()
      Deprecated.
      google.cloud.batch.v1alpha.AllocationPolicy.instance_templates is deprecated. See google/cloud/batch/v1alpha/job.proto;l=649
       Deprecated: please use instances[0].template instead.
      repeated string instance_templates = 3 [deprecated = true];
      Returns:
      A list containing the instanceTemplates.

    • getInstanceTemplatesCount

      @Deprecated int getInstanceTemplatesCount()
      Deprecated.
      google.cloud.batch.v1alpha.AllocationPolicy.instance_templates is deprecated. See google/cloud/batch/v1alpha/job.proto;l=649
       Deprecated: please use instances[0].template instead.
      repeated string instance_templates = 3 [deprecated = true];
      Returns:
      The count of instanceTemplates.

    • getInstanceTemplates

      @Deprecated String getInstanceTemplates(int index)
      Deprecated.
      google.cloud.batch.v1alpha.AllocationPolicy.instance_templates is deprecated. See google/cloud/batch/v1alpha/job.proto;l=649
       Deprecated: please use instances[0].template instead.
      repeated string instance_templates = 3 [deprecated = true];
      Parameters:
      index - The index of the element to return.
      Returns:
      The instanceTemplates at the given index.

    • getInstanceTemplatesBytes

      @Deprecated com.google.protobuf.ByteString getInstanceTemplatesBytes(int index)
      Deprecated.
      google.cloud.batch.v1alpha.AllocationPolicy.instance_templates is deprecated. See google/cloud/batch/v1alpha/job.proto;l=649
       Deprecated: please use instances[0].template instead.
      repeated string instance_templates = 3 [deprecated = true];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the instanceTemplates at the given index.

    • getProvisioningModelsList

      @Deprecated List<AllocationPolicy.ProvisioningModel> getProvisioningModelsList()
      Deprecated.
      google.cloud.batch.v1alpha.AllocationPolicy.provisioning_models is deprecated. See google/cloud/batch/v1alpha/job.proto;l=652
       Deprecated: please use instances[0].policy.provisioning_model instead.
      repeated .google.cloud.batch.v1alpha.AllocationPolicy.ProvisioningModel provisioning_models = 4 [deprecated = true];
      Returns:
      A list containing the provisioningModels.

    • getProvisioningModelsCount

      @Deprecated int getProvisioningModelsCount()
      Deprecated.
      google.cloud.batch.v1alpha.AllocationPolicy.provisioning_models is deprecated. See google/cloud/batch/v1alpha/job.proto;l=652
       Deprecated: please use instances[0].policy.provisioning_model instead.
      repeated .google.cloud.batch.v1alpha.AllocationPolicy.ProvisioningModel provisioning_models = 4 [deprecated = true];
      Returns:
      The count of provisioningModels.

    • getProvisioningModels

      @Deprecated AllocationPolicy.ProvisioningModel getProvisioningModels(int index)
      Deprecated.
      google.cloud.batch.v1alpha.AllocationPolicy.provisioning_models is deprecated. See google/cloud/batch/v1alpha/job.proto;l=652
       Deprecated: please use instances[0].policy.provisioning_model instead.
      repeated .google.cloud.batch.v1alpha.AllocationPolicy.ProvisioningModel provisioning_models = 4 [deprecated = true];
      Parameters:
      index - The index of the element to return.
      Returns:
      The provisioningModels at the given index.

    • getProvisioningModelsValueList

      @Deprecated List<Integer> getProvisioningModelsValueList()
      Deprecated.
      google.cloud.batch.v1alpha.AllocationPolicy.provisioning_models is deprecated. See google/cloud/batch/v1alpha/job.proto;l=652
       Deprecated: please use instances[0].policy.provisioning_model instead.
      repeated .google.cloud.batch.v1alpha.AllocationPolicy.ProvisioningModel provisioning_models = 4 [deprecated = true];
      Returns:
      A list containing the enum numeric values on the wire for provisioningModels.

    • getProvisioningModelsValue

      @Deprecated int getProvisioningModelsValue(int index)
      Deprecated.
      google.cloud.batch.v1alpha.AllocationPolicy.provisioning_models is deprecated. See google/cloud/batch/v1alpha/job.proto;l=652
       Deprecated: please use instances[0].policy.provisioning_model instead.
      repeated .google.cloud.batch.v1alpha.AllocationPolicy.ProvisioningModel provisioning_models = 4 [deprecated = true];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of provisioningModels at the given index.

    • getServiceAccountEmail

      @Deprecated String getServiceAccountEmail()
      Deprecated.
      google.cloud.batch.v1alpha.AllocationPolicy.service_account_email is deprecated. See google/cloud/batch/v1alpha/job.proto;l=655
       Deprecated: please use service_account instead.
      string service_account_email = 5 [deprecated = true];
      Returns:
      The serviceAccountEmail.

    • getServiceAccountEmailBytes

      @Deprecated com.google.protobuf.ByteString getServiceAccountEmailBytes()
      Deprecated.
      google.cloud.batch.v1alpha.AllocationPolicy.service_account_email is deprecated. See google/cloud/batch/v1alpha/job.proto;l=655
       Deprecated: please use service_account instead.
      string service_account_email = 5 [deprecated = true];
      Returns:
      The bytes for serviceAccountEmail.

    • hasServiceAccount

      boolean hasServiceAccount()
       Defines the service account for Batch-created VMs. If omitted, the [default
 Compute Engine service
 account](https://cloud.google.com/compute/docs/access/service-accounts#default_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.v1alpha.ServiceAccount service_account = 9;
      Returns:
      Whether the serviceAccount field is set.

    • getServiceAccount

      ServiceAccount getServiceAccount()
       Defines the service account for Batch-created VMs. If omitted, the [default
 Compute Engine service
 account](https://cloud.google.com/compute/docs/access/service-accounts#default_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.v1alpha.ServiceAccount service_account = 9;
      Returns:
      The serviceAccount.

    • getServiceAccountOrBuilder

      ServiceAccountOrBuilder getServiceAccountOrBuilder()
       Defines the service account for Batch-created VMs. If omitted, the [default
 Compute Engine service
 account](https://cloud.google.com/compute/docs/access/service-accounts#default_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.v1alpha.ServiceAccount service_account = 9;

    • getLabelsCount

      int getLabelsCount()
       Custom labels to apply to the job and all the Compute Engine resources
 that both are created by this allocation policy and support labels.

 Use labels to group and describe the resources they are applied to. Batch
 automatically applies predefined labels and supports multiple `labels`
 fields for each job, which each let you apply custom labels to various
 resources. Label names that start with "goog-" or "google-" are
 reserved for predefined labels. For more information about labels with
 Batch, see
 [Organize resources using
 labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
      map<string, string> labels = 6;

    • containsLabels

      boolean containsLabels(String key)
       Custom labels to apply to the job and all the Compute Engine resources
 that both are created by this allocation policy and support labels.

 Use labels to group and describe the resources they are applied to. Batch
 automatically applies predefined labels and supports multiple `labels`
 fields for each job, which each let you apply custom labels to various
 resources. Label names that start with "goog-" or "google-" are
 reserved for predefined labels. For more information about labels with
 Batch, see
 [Organize resources using
 labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
      map<string, string> labels = 6;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Custom labels to apply to the job and all the Compute Engine resources
 that both are created by this allocation policy and support labels.

 Use labels to group and describe the resources they are applied to. Batch
 automatically applies predefined labels and supports multiple `labels`
 fields for each job, which each let you apply custom labels to various
 resources. Label names that start with "goog-" or "google-" are
 reserved for predefined labels. For more information about labels with
 Batch, see
 [Organize resources using
 labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
      map<string, string> labels = 6;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Custom labels to apply to the job and all the Compute Engine resources
 that both are created by this allocation policy and support labels.

 Use labels to group and describe the resources they are applied to. Batch
 automatically applies predefined labels and supports multiple `labels`
 fields for each job, which each let you apply custom labels to various
 resources. Label names that start with "goog-" or "google-" are
 reserved for predefined labels. For more information about labels with
 Batch, see
 [Organize resources using
 labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
      map<string, string> labels = 6;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Custom labels to apply to the job and all the Compute Engine resources
 that both are created by this allocation policy and support labels.

 Use labels to group and describe the resources they are applied to. Batch
 automatically applies predefined labels and supports multiple `labels`
 fields for each job, which each let you apply custom labels to various
 resources. Label names that start with "goog-" or "google-" are
 reserved for predefined labels. For more information about labels with
 Batch, see
 [Organize resources using
 labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).
      map<string, string> labels = 6;

    • hasNetwork

      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.v1alpha.AllocationPolicy.NetworkPolicy network = 7;
      Returns:
      Whether the network field is set.

    • getNetwork

      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.v1alpha.AllocationPolicy.NetworkPolicy network = 7;
      Returns:
      The network.

    • getNetworkOrBuilder

      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.v1alpha.AllocationPolicy.NetworkPolicy network = 7;

    • hasPlacement

      boolean hasPlacement()
       The placement policy.
      .google.cloud.batch.v1alpha.AllocationPolicy.PlacementPolicy placement = 10;
      Returns:
      Whether the placement field is set.

    • getPlacement

      AllocationPolicy.PlacementPolicy getPlacement()
       The placement policy.
      .google.cloud.batch.v1alpha.AllocationPolicy.PlacementPolicy placement = 10;
      Returns:
      The placement.

    • getPlacementOrBuilder

      AllocationPolicy.PlacementPolicyOrBuilder getPlacementOrBuilder()
       The placement policy.
      .google.cloud.batch.v1alpha.AllocationPolicy.PlacementPolicy placement = 10;

    • getTagsList

      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](https://www.ietf.org/rfc/rfc1035.txt).
      repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the tags.

    • getTagsCount

      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](https://www.ietf.org/rfc/rfc1035.txt).
      repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of tags.

    • getTags

      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](https://www.ietf.org/rfc/rfc1035.txt).
      repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The tags at the given index.

    • getTagsBytes

      com.google.protobuf.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](https://www.ietf.org/rfc/rfc1035.txt).
      repeated string tags = 11 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tags at the given index.