Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.batch/v1.getJob
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Get a Job specified by its resource name.
Using getJob
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getJob(args: GetJobArgs, opts?: InvokeOptions): Promise<GetJobResult>
function getJobOutput(args: GetJobOutputArgs, opts?: InvokeOptions): Output<GetJobResult>
def get_job(job_id: Optional[str] = None,
location: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetJobResult
def get_job_output(job_id: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetJobResult]
func LookupJob(ctx *Context, args *LookupJobArgs, opts ...InvokeOption) (*LookupJobResult, error)
func LookupJobOutput(ctx *Context, args *LookupJobOutputArgs, opts ...InvokeOption) LookupJobResultOutput
> Note: This function is named LookupJob
in the Go SDK.
public static class GetJob
{
public static Task<GetJobResult> InvokeAsync(GetJobArgs args, InvokeOptions? opts = null)
public static Output<GetJobResult> Invoke(GetJobInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:batch/v1:getJob
arguments:
# arguments dictionary
The following arguments are supported:
getJob Result
The following output properties are available:
- Allocation
Policy Pulumi.Google Native. Batch. V1. Outputs. Allocation Policy Response - Compute resource allocation for all TaskGroups in the Job.
- Create
Time string - When the Job was created.
- Labels Dictionary<string, string>
- Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
- Logs
Policy Pulumi.Google Native. Batch. V1. Outputs. Logs Policy Response - Log preservation policy for the Job.
- Name string
- Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
- Notifications
List<Pulumi.
Google Native. Batch. V1. Outputs. Job Notification Response> - Notification configurations.
- Priority string
- Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
- Status
Pulumi.
Google Native. Batch. V1. Outputs. Job Status Response - Job status. It is read only for users.
- Task
Groups List<Pulumi.Google Native. Batch. V1. Outputs. Task Group Response> - TaskGroups in the Job. Only one TaskGroup is supported now.
- Uid string
- A system generated unique ID (in UUID4 format) for the Job.
- Update
Time string - The last time the Job was updated.
- Allocation
Policy AllocationPolicy Response - Compute resource allocation for all TaskGroups in the Job.
- Create
Time string - When the Job was created.
- Labels map[string]string
- Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
- Logs
Policy LogsPolicy Response - Log preservation policy for the Job.
- Name string
- Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
- Notifications
[]Job
Notification Response - Notification configurations.
- Priority string
- Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
- Status
Job
Status Response - Job status. It is read only for users.
- Task
Groups []TaskGroup Response - TaskGroups in the Job. Only one TaskGroup is supported now.
- Uid string
- A system generated unique ID (in UUID4 format) for the Job.
- Update
Time string - The last time the Job was updated.
- allocation
Policy AllocationPolicy Response - Compute resource allocation for all TaskGroups in the Job.
- create
Time String - When the Job was created.
- labels Map<String,String>
- Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
- logs
Policy LogsPolicy Response - Log preservation policy for the Job.
- name String
- Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
- notifications
List<Job
Notification Response> - Notification configurations.
- priority String
- Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
- status
Job
Status Response - Job status. It is read only for users.
- task
Groups List<TaskGroup Response> - TaskGroups in the Job. Only one TaskGroup is supported now.
- uid String
- A system generated unique ID (in UUID4 format) for the Job.
- update
Time String - The last time the Job was updated.
- allocation
Policy AllocationPolicy Response - Compute resource allocation for all TaskGroups in the Job.
- create
Time string - When the Job was created.
- labels {[key: string]: string}
- Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
- logs
Policy LogsPolicy Response - Log preservation policy for the Job.
- name string
- Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
- notifications
Job
Notification Response[] - Notification configurations.
- priority string
- Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
- status
Job
Status Response - Job status. It is read only for users.
- task
Groups TaskGroup Response[] - TaskGroups in the Job. Only one TaskGroup is supported now.
- uid string
- A system generated unique ID (in UUID4 format) for the Job.
- update
Time string - The last time the Job was updated.
- allocation_
policy AllocationPolicy Response - Compute resource allocation for all TaskGroups in the Job.
- create_
time str - When the Job was created.
- labels Mapping[str, str]
- Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
- logs_
policy LogsPolicy Response - Log preservation policy for the Job.
- name str
- Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
- notifications
Sequence[Job
Notification Response] - Notification configurations.
- priority str
- Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
- status
Job
Status Response - Job status. It is read only for users.
- task_
groups Sequence[TaskGroup Response] - TaskGroups in the Job. Only one TaskGroup is supported now.
- uid str
- A system generated unique ID (in UUID4 format) for the Job.
- update_
time str - The last time the Job was updated.
- allocation
Policy Property Map - Compute resource allocation for all TaskGroups in the Job.
- create
Time String - When the Job was created.
- labels Map<String>
- Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
- logs
Policy Property Map - Log preservation policy for the Job.
- name String
- Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
- notifications List<Property Map>
- Notification configurations.
- priority String
- Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
- status Property Map
- Job status. It is read only for users.
- task
Groups List<Property Map> - TaskGroups in the Job. Only one TaskGroup is supported now.
- uid String
- A system generated unique ID (in UUID4 format) for the Job.
- update
Time String - The last time the Job was updated.
Supporting Types
AcceleratorResponse
- Count string
- The number of accelerators of this type.
- Driver
Version string - Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
- Install
Gpu boolDrivers - Deprecated: please use instances[0].install_gpu_drivers instead.
- Type string
- The accelerator type. For example, "nvidia-tesla-t4". See
gcloud compute accelerator-types list
.
- Count string
- The number of accelerators of this type.
- Driver
Version string - Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
- Install
Gpu boolDrivers - Deprecated: please use instances[0].install_gpu_drivers instead.
- Type string
- The accelerator type. For example, "nvidia-tesla-t4". See
gcloud compute accelerator-types list
.
- count String
- The number of accelerators of this type.
- driver
Version String - Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
- install
Gpu BooleanDrivers - Deprecated: please use instances[0].install_gpu_drivers instead.
- type String
- The accelerator type. For example, "nvidia-tesla-t4". See
gcloud compute accelerator-types list
.
- count string
- The number of accelerators of this type.
- driver
Version string - Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
- install
Gpu booleanDrivers - Deprecated: please use instances[0].install_gpu_drivers instead.
- type string
- The accelerator type. For example, "nvidia-tesla-t4". See
gcloud compute accelerator-types list
.
- count str
- The number of accelerators of this type.
- driver_
version str - Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
- install_
gpu_ booldrivers - Deprecated: please use instances[0].install_gpu_drivers instead.
- type str
- The accelerator type. For example, "nvidia-tesla-t4". See
gcloud compute accelerator-types list
.
- count String
- The number of accelerators of this type.
- driver
Version String - Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
- install
Gpu BooleanDrivers - Deprecated: please use instances[0].install_gpu_drivers instead.
- type String
- The accelerator type. For example, "nvidia-tesla-t4". See
gcloud compute accelerator-types list
.
ActionConditionResponse
- Exit
Codes List<int> - Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
- Exit
Codes []int - Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
- exit
Codes List<Integer> - Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
- exit
Codes number[] - Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
- exit_
codes Sequence[int] - Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
- exit
Codes List<Number> - Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
AllocationPolicyResponse
- Instances
List<Pulumi.
Google Native. Batch. V1. Inputs. Instance Policy Or Template Response> - Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
- Labels Dictionary<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
Pulumi.
Google Native. Batch. V1. Inputs. Location Policy Response - Location where compute resources should be allocated for the Job.
- Network
Pulumi.
Google Native. Batch. V1. Inputs. Network Policy Response - 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
Pulumi.
Google Native. Batch. V1. Inputs. Placement Policy Response - The placement policy.
- Service
Account Pulumi.Google Native. Batch. V1. Inputs. Service Account Response - Service account that VMs will run as.
- Instances
[]Instance
Policy Or Template Response - Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
- Labels 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
Location
Policy Response - Location where compute resources should be allocated for the Job.
- Network
Network
Policy Response - 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
Placement
Policy Response - The placement policy.
- Service
Account ServiceAccount Response - Service account that VMs will run as.
- instances
List<Instance
Policy Or Template Response> - Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
- labels 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
Location
Policy Response - Location where compute resources should be allocated for the Job.
- network
Network
Policy Response - 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
Placement
Policy Response - The placement policy.
- service
Account ServiceAccount Response - Service account that VMs will run as.
- instances
Instance
Policy Or Template Response[] - Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
- labels {[key: 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
Location
Policy Response - Location where compute resources should be allocated for the Job.
- network
Network
Policy Response - 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
Placement
Policy Response - The placement policy.
- service
Account ServiceAccount Response - Service account that VMs will run as.
- instances
Sequence[Instance
Policy Or Template Response] - Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
- labels Mapping[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 apply. Label names that start with "goog-" or "google-" are reserved.
- location
Location
Policy Response - Location where compute resources should be allocated for the Job.
- network
Network
Policy Response - 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
Placement
Policy Response - The placement policy.
- service_
account ServiceAccount Response - Service account that VMs will run as.
- instances List<Property Map>
- Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
- labels Map<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 Property Map
- Location where compute resources should be allocated for the Job.
- network Property Map
- 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 Property Map
- The placement policy.
- service
Account Property Map - Service account that VMs will run as.
AttachedDiskResponse
- Device
Name string - Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
- Existing
Disk string - Name of an existing PD.
- New
Disk Pulumi.Google Native. Batch. V1. Inputs. Disk Response
- Device
Name string - Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
- Existing
Disk string - Name of an existing PD.
- New
Disk DiskResponse
- device
Name String - Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
- existing
Disk String - Name of an existing PD.
- new
Disk DiskResponse
- device
Name string - Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
- existing
Disk string - Name of an existing PD.
- new
Disk DiskResponse
- device_
name str - Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
- existing_
disk str - Name of an existing PD.
- new_
disk DiskResponse
- device
Name String - Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
- existing
Disk String - Name of an existing PD.
- new
Disk Property Map
BarrierResponse
- Name string
- Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
- Name string
- Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
- name String
- Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
- name string
- Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
- name str
- Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
- name String
- Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
ComputeResourceResponse
- Boot
Disk stringMib - Extra boot disk size in MiB for each task.
- Cpu
Milli string - The milliCPU count.
cpuMilli
defines the amount of CPU resources per task in milliCPU units. For example,1000
corresponds to 1 vCPU per task. If undefined, the default value is2000
. If you also define the VM's machine type using themachineType
in InstancePolicy field or inside theinstanceTemplate
in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify then2-standard-2
machine type, which has 2 vCPUs each, you are recommended to setcpuMilli
no more than2000
, or you are recommended to run two tasks on the same VM if you setcpuMilli
to1000
or less. - Memory
Mib string - Memory in MiB.
memoryMib
defines the amount of memory per task in MiB units. If undefined, the default value is2000
. If you also define the VM's machine type using themachineType
in InstancePolicy field or inside theinstanceTemplate
in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify then2-standard-2
machine type, which has 8 GiB each, you are recommended to setmemoryMib
to no more than8192
, or you are recommended to run two tasks on the same VM if you setmemoryMib
to4096
or less.
- Boot
Disk stringMib - Extra boot disk size in MiB for each task.
- Cpu
Milli string - The milliCPU count.
cpuMilli
defines the amount of CPU resources per task in milliCPU units. For example,1000
corresponds to 1 vCPU per task. If undefined, the default value is2000
. If you also define the VM's machine type using themachineType
in InstancePolicy field or inside theinstanceTemplate
in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify then2-standard-2
machine type, which has 2 vCPUs each, you are recommended to setcpuMilli
no more than2000
, or you are recommended to run two tasks on the same VM if you setcpuMilli
to1000
or less. - Memory
Mib string - Memory in MiB.
memoryMib
defines the amount of memory per task in MiB units. If undefined, the default value is2000
. If you also define the VM's machine type using themachineType
in InstancePolicy field or inside theinstanceTemplate
in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify then2-standard-2
machine type, which has 8 GiB each, you are recommended to setmemoryMib
to no more than8192
, or you are recommended to run two tasks on the same VM if you setmemoryMib
to4096
or less.
- boot
Disk StringMib - Extra boot disk size in MiB for each task.
- cpu
Milli String - The milliCPU count.
cpuMilli
defines the amount of CPU resources per task in milliCPU units. For example,1000
corresponds to 1 vCPU per task. If undefined, the default value is2000
. If you also define the VM's machine type using themachineType
in InstancePolicy field or inside theinstanceTemplate
in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify then2-standard-2
machine type, which has 2 vCPUs each, you are recommended to setcpuMilli
no more than2000
, or you are recommended to run two tasks on the same VM if you setcpuMilli
to1000
or less. - memory
Mib String - Memory in MiB.
memoryMib
defines the amount of memory per task in MiB units. If undefined, the default value is2000
. If you also define the VM's machine type using themachineType
in InstancePolicy field or inside theinstanceTemplate
in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify then2-standard-2
machine type, which has 8 GiB each, you are recommended to setmemoryMib
to no more than8192
, or you are recommended to run two tasks on the same VM if you setmemoryMib
to4096
or less.
- boot
Disk stringMib - Extra boot disk size in MiB for each task.
- cpu
Milli string - The milliCPU count.
cpuMilli
defines the amount of CPU resources per task in milliCPU units. For example,1000
corresponds to 1 vCPU per task. If undefined, the default value is2000
. If you also define the VM's machine type using themachineType
in InstancePolicy field or inside theinstanceTemplate
in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify then2-standard-2
machine type, which has 2 vCPUs each, you are recommended to setcpuMilli
no more than2000
, or you are recommended to run two tasks on the same VM if you setcpuMilli
to1000
or less. - memory
Mib string - Memory in MiB.
memoryMib
defines the amount of memory per task in MiB units. If undefined, the default value is2000
. If you also define the VM's machine type using themachineType
in InstancePolicy field or inside theinstanceTemplate
in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify then2-standard-2
machine type, which has 8 GiB each, you are recommended to setmemoryMib
to no more than8192
, or you are recommended to run two tasks on the same VM if you setmemoryMib
to4096
or less.
- boot_
disk_ strmib - Extra boot disk size in MiB for each task.
- cpu_
milli str - The milliCPU count.
cpuMilli
defines the amount of CPU resources per task in milliCPU units. For example,1000
corresponds to 1 vCPU per task. If undefined, the default value is2000
. If you also define the VM's machine type using themachineType
in InstancePolicy field or inside theinstanceTemplate
in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify then2-standard-2
machine type, which has 2 vCPUs each, you are recommended to setcpuMilli
no more than2000
, or you are recommended to run two tasks on the same VM if you setcpuMilli
to1000
or less. - memory_
mib str - Memory in MiB.
memoryMib
defines the amount of memory per task in MiB units. If undefined, the default value is2000
. If you also define the VM's machine type using themachineType
in InstancePolicy field or inside theinstanceTemplate
in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify then2-standard-2
machine type, which has 8 GiB each, you are recommended to setmemoryMib
to no more than8192
, or you are recommended to run two tasks on the same VM if you setmemoryMib
to4096
or less.
- boot
Disk StringMib - Extra boot disk size in MiB for each task.
- cpu
Milli String - The milliCPU count.
cpuMilli
defines the amount of CPU resources per task in milliCPU units. For example,1000
corresponds to 1 vCPU per task. If undefined, the default value is2000
. If you also define the VM's machine type using themachineType
in InstancePolicy field or inside theinstanceTemplate
in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify then2-standard-2
machine type, which has 2 vCPUs each, you are recommended to setcpuMilli
no more than2000
, or you are recommended to run two tasks on the same VM if you setcpuMilli
to1000
or less. - memory
Mib String - Memory in MiB.
memoryMib
defines the amount of memory per task in MiB units. If undefined, the default value is2000
. If you also define the VM's machine type using themachineType
in InstancePolicy field or inside theinstanceTemplate
in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify then2-standard-2
machine type, which has 8 GiB each, you are recommended to setmemoryMib
to no more than8192
, or you are recommended to run two tasks on the same VM if you setmemoryMib
to4096
or less.
ContainerResponse
- Block
External boolNetwork - If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the
container.options
field. - Commands List<string>
- Overrides the
CMD
specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT. - Entrypoint string
- Overrides the
ENTRYPOINT
specified in the container. - Image
Uri string - The URI to pull the container image from.
- Options string
- Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
- Password string
- Optional password for logging in to a docker registry. If password matches
projects/*/secrets/*/versions/*
then Batch will read the password from the Secret Manager; - Username string
- Optional username for logging in to a docker registry. If username matches
projects/*/secrets/*/versions/*
then Batch will read the username from the Secret Manager. - Volumes List<string>
- Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the
TaskSpec.Volumes
field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified inTaskSpec.Volumes
. If you need different mount settings, you can explicitly configure them in this field.
- Block
External boolNetwork - If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the
container.options
field. - Commands []string
- Overrides the
CMD
specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT. - Entrypoint string
- Overrides the
ENTRYPOINT
specified in the container. - Image
Uri string - The URI to pull the container image from.
- Options string
- Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
- Password string
- Optional password for logging in to a docker registry. If password matches
projects/*/secrets/*/versions/*
then Batch will read the password from the Secret Manager; - Username string
- Optional username for logging in to a docker registry. If username matches
projects/*/secrets/*/versions/*
then Batch will read the username from the Secret Manager. - Volumes []string
- Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the
TaskSpec.Volumes
field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified inTaskSpec.Volumes
. If you need different mount settings, you can explicitly configure them in this field.
- block
External BooleanNetwork - If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the
container.options
field. - commands List<String>
- Overrides the
CMD
specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT. - entrypoint String
- Overrides the
ENTRYPOINT
specified in the container. - image
Uri String - The URI to pull the container image from.
- options String
- Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
- password String
- Optional password for logging in to a docker registry. If password matches
projects/*/secrets/*/versions/*
then Batch will read the password from the Secret Manager; - username String
- Optional username for logging in to a docker registry. If username matches
projects/*/secrets/*/versions/*
then Batch will read the username from the Secret Manager. - volumes List<String>
- Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the
TaskSpec.Volumes
field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified inTaskSpec.Volumes
. If you need different mount settings, you can explicitly configure them in this field.
- block
External booleanNetwork - If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the
container.options
field. - commands string[]
- Overrides the
CMD
specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT. - entrypoint string
- Overrides the
ENTRYPOINT
specified in the container. - image
Uri string - The URI to pull the container image from.
- options string
- Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
- password string
- Optional password for logging in to a docker registry. If password matches
projects/*/secrets/*/versions/*
then Batch will read the password from the Secret Manager; - username string
- Optional username for logging in to a docker registry. If username matches
projects/*/secrets/*/versions/*
then Batch will read the username from the Secret Manager. - volumes string[]
- Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the
TaskSpec.Volumes
field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified inTaskSpec.Volumes
. If you need different mount settings, you can explicitly configure them in this field.
- block_
external_ boolnetwork - If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the
container.options
field. - commands Sequence[str]
- Overrides the
CMD
specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT. - entrypoint str
- Overrides the
ENTRYPOINT
specified in the container. - image_
uri str - The URI to pull the container image from.
- options str
- Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
- password str
- Optional password for logging in to a docker registry. If password matches
projects/*/secrets/*/versions/*
then Batch will read the password from the Secret Manager; - username str
- Optional username for logging in to a docker registry. If username matches
projects/*/secrets/*/versions/*
then Batch will read the username from the Secret Manager. - volumes Sequence[str]
- Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the
TaskSpec.Volumes
field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified inTaskSpec.Volumes
. If you need different mount settings, you can explicitly configure them in this field.
- block
External BooleanNetwork - If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the
container.options
field. - commands List<String>
- Overrides the
CMD
specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT. - entrypoint String
- Overrides the
ENTRYPOINT
specified in the container. - image
Uri String - The URI to pull the container image from.
- options String
- Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
- password String
- Optional password for logging in to a docker registry. If password matches
projects/*/secrets/*/versions/*
then Batch will read the password from the Secret Manager; - username String
- Optional username for logging in to a docker registry. If username matches
projects/*/secrets/*/versions/*
then Batch will read the username from the Secret Manager. - volumes List<String>
- Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the
TaskSpec.Volumes
field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified inTaskSpec.Volumes
. If you need different mount settings, you can explicitly configure them in this field.
DiskResponse
- Disk
Interface string - Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
- Image string
- URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: *
batch-debian
: use Batch Debian images. *batch-centos
: use Batch CentOS images. *batch-cos
: use Batch Container-Optimized images. *batch-hpc-centos
: use Batch HPC CentOS images. *batch-hpc-rocky
: use Batch HPC Rocky Linux images. - Size
Gb string - Disk size in GB. Non-Boot Disk: If the
type
specifies a persistent disk, this field is ignored ifdata_source
is set asimage
orsnapshot
. If thetype
specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and theboot_disk_mib
field in task spec'scompute_resource
are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when thedata_source
is set assnapshot
orimage
. For example, if you set an image as thedata_source
field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB. - Snapshot string
- Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
- Type string
- Disk type as shown in
gcloud compute disk-types list
. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".
- Disk
Interface string - Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
- Image string
- URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: *
batch-debian
: use Batch Debian images. *batch-centos
: use Batch CentOS images. *batch-cos
: use Batch Container-Optimized images. *batch-hpc-centos
: use Batch HPC CentOS images. *batch-hpc-rocky
: use Batch HPC Rocky Linux images. - Size
Gb string - Disk size in GB. Non-Boot Disk: If the
type
specifies a persistent disk, this field is ignored ifdata_source
is set asimage
orsnapshot
. If thetype
specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and theboot_disk_mib
field in task spec'scompute_resource
are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when thedata_source
is set assnapshot
orimage
. For example, if you set an image as thedata_source
field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB. - Snapshot string
- Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
- Type string
- Disk type as shown in
gcloud compute disk-types list
. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".
- disk
Interface String - Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
- image String
- URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: *
batch-debian
: use Batch Debian images. *batch-centos
: use Batch CentOS images. *batch-cos
: use Batch Container-Optimized images. *batch-hpc-centos
: use Batch HPC CentOS images. *batch-hpc-rocky
: use Batch HPC Rocky Linux images. - size
Gb String - Disk size in GB. Non-Boot Disk: If the
type
specifies a persistent disk, this field is ignored ifdata_source
is set asimage
orsnapshot
. If thetype
specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and theboot_disk_mib
field in task spec'scompute_resource
are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when thedata_source
is set assnapshot
orimage
. For example, if you set an image as thedata_source
field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB. - snapshot String
- Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
- type String
- Disk type as shown in
gcloud compute disk-types list
. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".
- disk
Interface string - Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
- image string
- URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: *
batch-debian
: use Batch Debian images. *batch-centos
: use Batch CentOS images. *batch-cos
: use Batch Container-Optimized images. *batch-hpc-centos
: use Batch HPC CentOS images. *batch-hpc-rocky
: use Batch HPC Rocky Linux images. - size
Gb string - Disk size in GB. Non-Boot Disk: If the
type
specifies a persistent disk, this field is ignored ifdata_source
is set asimage
orsnapshot
. If thetype
specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and theboot_disk_mib
field in task spec'scompute_resource
are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when thedata_source
is set assnapshot
orimage
. For example, if you set an image as thedata_source
field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB. - snapshot string
- Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
- type string
- Disk type as shown in
gcloud compute disk-types list
. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".
- disk_
interface str - Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
- image str
- URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: *
batch-debian
: use Batch Debian images. *batch-centos
: use Batch CentOS images. *batch-cos
: use Batch Container-Optimized images. *batch-hpc-centos
: use Batch HPC CentOS images. *batch-hpc-rocky
: use Batch HPC Rocky Linux images. - size_
gb str - Disk size in GB. Non-Boot Disk: If the
type
specifies a persistent disk, this field is ignored ifdata_source
is set asimage
orsnapshot
. If thetype
specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and theboot_disk_mib
field in task spec'scompute_resource
are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when thedata_source
is set assnapshot
orimage
. For example, if you set an image as thedata_source
field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB. - snapshot str
- Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
- type str
- Disk type as shown in
gcloud compute disk-types list
. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".
- disk
Interface String - Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
- image String
- URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: *
batch-debian
: use Batch Debian images. *batch-centos
: use Batch CentOS images. *batch-cos
: use Batch Container-Optimized images. *batch-hpc-centos
: use Batch HPC CentOS images. *batch-hpc-rocky
: use Batch HPC Rocky Linux images. - size
Gb String - Disk size in GB. Non-Boot Disk: If the
type
specifies a persistent disk, this field is ignored ifdata_source
is set asimage
orsnapshot
. If thetype
specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and theboot_disk_mib
field in task spec'scompute_resource
are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when thedata_source
is set assnapshot
orimage
. For example, if you set an image as thedata_source
field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB. - snapshot String
- Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
- type String
- Disk type as shown in
gcloud compute disk-types list
. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".
EnvironmentResponse
- Encrypted
Variables Pulumi.Google Native. Batch. V1. Inputs. KMSEnv Map Response - An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
- Secret
Variables Dictionary<string, string> - A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
- Variables Dictionary<string, string>
- A map of environment variable names to values.
- Encrypted
Variables KMSEnvMap Response - An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
- Secret
Variables map[string]string - A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
- Variables map[string]string
- A map of environment variable names to values.
- encrypted
Variables KMSEnvMap Response - An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
- secret
Variables Map<String,String> - A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
- variables Map<String,String>
- A map of environment variable names to values.
- encrypted
Variables KMSEnvMap Response - An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
- secret
Variables {[key: string]: string} - A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
- variables {[key: string]: string}
- A map of environment variable names to values.
- encrypted_
variables KMSEnvMap Response - An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
- secret_
variables Mapping[str, str] - A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
- variables Mapping[str, str]
- A map of environment variable names to values.
- encrypted
Variables Property Map - An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
- secret
Variables Map<String> - A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
- variables Map<String>
- A map of environment variable names to values.
GCSResponse
- Remote
Path string - Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
- Remote
Path string - Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
- remote
Path String - Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
- remote
Path string - Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
- remote_
path str - Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
- remote
Path String - Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
InstancePolicyOrTemplateResponse
- Install
Gpu boolDrivers - Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
- Instance
Template string - Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
- Policy
Pulumi.
Google Native. Batch. V1. Inputs. Instance Policy Response - InstancePolicy.
- Install
Gpu boolDrivers - Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
- Instance
Template string - Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
- Policy
Instance
Policy Response - InstancePolicy.
- install
Gpu BooleanDrivers - Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
- instance
Template String - Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
- policy
Instance
Policy Response - InstancePolicy.
- install
Gpu booleanDrivers - Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
- instance
Template string - Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
- policy
Instance
Policy Response - InstancePolicy.
- install_
gpu_ booldrivers - Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
- instance_
template str - Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
- policy
Instance
Policy Response - InstancePolicy.
- install
Gpu BooleanDrivers - Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
- instance
Template String - Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
- policy Property Map
- InstancePolicy.
InstancePolicyResponse
- Accelerators
List<Pulumi.
Google Native. Batch. V1. Inputs. Accelerator Response> - The accelerators attached to each VM instance.
- Boot
Disk Pulumi.Google Native. Batch. V1. Inputs. Disk Response - Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.
- Disks
List<Pulumi.
Google Native. Batch. V1. Inputs. Attached Disk Response> - Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.
- Machine
Type string - The Compute Engine machine type.
- Min
Cpu stringPlatform - The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
- Provisioning
Model string - The provisioning model.
- Reservation string
- Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation.
- Accelerators
[]Accelerator
Response - The accelerators attached to each VM instance.
- Boot
Disk DiskResponse - Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.
- Disks
[]Attached
Disk Response - Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.
- Machine
Type string - The Compute Engine machine type.
- Min
Cpu stringPlatform - The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
- Provisioning
Model string - The provisioning model.
- Reservation string
- Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation.
- accelerators
List<Accelerator
Response> - The accelerators attached to each VM instance.
- boot
Disk DiskResponse - Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.
- disks
List<Attached
Disk Response> - Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.
- machine
Type String - The Compute Engine machine type.
- min
Cpu StringPlatform - The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
- provisioning
Model String - The provisioning model.
- reservation String
- Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation.
- accelerators
Accelerator
Response[] - The accelerators attached to each VM instance.
- boot
Disk DiskResponse - Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.
- disks
Attached
Disk Response[] - Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.
- machine
Type string - The Compute Engine machine type.
- min
Cpu stringPlatform - The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
- provisioning
Model string - The provisioning model.
- reservation string
- Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation.
- accelerators
Sequence[Accelerator
Response] - The accelerators attached to each VM instance.
- boot_
disk DiskResponse - Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.
- disks
Sequence[Attached
Disk Response] - Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.
- machine_
type str - The Compute Engine machine type.
- min_
cpu_ strplatform - The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
- provisioning_
model str - The provisioning model.
- reservation str
- Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation.
- accelerators List<Property Map>
- The accelerators attached to each VM instance.
- boot
Disk Property Map - Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.
- disks List<Property Map>
- Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.
- machine
Type String - The Compute Engine machine type.
- min
Cpu StringPlatform - The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
- provisioning
Model String - The provisioning model.
- reservation String
- Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation.
JobNotificationResponse
- Message
Pulumi.
Google Native. Batch. V1. Inputs. Message Response - The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
- Pubsub
Topic string - The Pub/Sub topic where notifications like the job state changes will be published. The topic must exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format:
projects/{project}/topics/{topic}
.
- Message
Message
Response - The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
- Pubsub
Topic string - The Pub/Sub topic where notifications like the job state changes will be published. The topic must exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format:
projects/{project}/topics/{topic}
.
- message
Message
Response - The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
- pubsub
Topic String - The Pub/Sub topic where notifications like the job state changes will be published. The topic must exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format:
projects/{project}/topics/{topic}
.
- message
Message
Response - The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
- pubsub
Topic string - The Pub/Sub topic where notifications like the job state changes will be published. The topic must exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format:
projects/{project}/topics/{topic}
.
- message
Message
Response - The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
- pubsub_
topic str - The Pub/Sub topic where notifications like the job state changes will be published. The topic must exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format:
projects/{project}/topics/{topic}
.
- message Property Map
- The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
- pubsub
Topic String - The Pub/Sub topic where notifications like the job state changes will be published. The topic must exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format:
projects/{project}/topics/{topic}
.
JobStatusResponse
- Run
Duration string - The duration of time that the Job spent in status RUNNING.
- State string
- Job state
- Status
Events List<Pulumi.Google Native. Batch. V1. Inputs. Status Event Response> - Job status events
- Task
Groups Dictionary<string, string> - Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
- Run
Duration string - The duration of time that the Job spent in status RUNNING.
- State string
- Job state
- Status
Events []StatusEvent Response - Job status events
- Task
Groups map[string]string - Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
- run
Duration String - The duration of time that the Job spent in status RUNNING.
- state String
- Job state
- status
Events List<StatusEvent Response> - Job status events
- task
Groups Map<String,String> - Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
- run
Duration string - The duration of time that the Job spent in status RUNNING.
- state string
- Job state
- status
Events StatusEvent Response[] - Job status events
- task
Groups {[key: string]: string} - Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
- run_
duration str - The duration of time that the Job spent in status RUNNING.
- state str
- Job state
- status_
events Sequence[StatusEvent Response] - Job status events
- task_
groups Mapping[str, str] - Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
- run
Duration String - The duration of time that the Job spent in status RUNNING.
- state String
- Job state
- status
Events List<Property Map> - Job status events
- task
Groups Map<String> - Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
KMSEnvMapResponse
- Cipher
Text string - The value of the cipherText response from the
encrypt
method. - Key
Name string - The name of the KMS key that will be used to decrypt the cipher text.
- Cipher
Text string - The value of the cipherText response from the
encrypt
method. - Key
Name string - The name of the KMS key that will be used to decrypt the cipher text.
- cipher
Text String - The value of the cipherText response from the
encrypt
method. - key
Name String - The name of the KMS key that will be used to decrypt the cipher text.
- cipher
Text string - The value of the cipherText response from the
encrypt
method. - key
Name string - The name of the KMS key that will be used to decrypt the cipher text.
- cipher_
text str - The value of the cipherText response from the
encrypt
method. - key_
name str - The name of the KMS key that will be used to decrypt the cipher text.
- cipher
Text String - The value of the cipherText response from the
encrypt
method. - key
Name String - The name of the KMS key that will be used to decrypt the cipher text.
LifecyclePolicyResponse
- Action string
- Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
- Action
Condition Pulumi.Google Native. Batch. V1. Inputs. Action Condition Response - Conditions that decide why a task failure is dealt with a specific action.
- Action string
- Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
- Action
Condition ActionCondition Response - Conditions that decide why a task failure is dealt with a specific action.
- action String
- Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
- action
Condition ActionCondition Response - Conditions that decide why a task failure is dealt with a specific action.
- action string
- Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
- action
Condition ActionCondition Response - Conditions that decide why a task failure is dealt with a specific action.
- action str
- Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
- action_
condition ActionCondition Response - Conditions that decide why a task failure is dealt with a specific action.
- action String
- Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
- action
Condition Property Map - Conditions that decide why a task failure is dealt with a specific action.
LocationPolicyResponse
- Allowed
Locations List<string> - A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
- Allowed
Locations []string - A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
- allowed
Locations List<String> - A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
- allowed
Locations string[] - A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
- allowed_
locations Sequence[str] - A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
- allowed
Locations List<String> - A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
LogsPolicyResponse
- Cloud
Logging Pulumi.Option Google Native. Batch. V1. Inputs. Cloud Logging Option Response - Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.
- Destination string
- Where logs should be saved.
- Logs
Path string - The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
- Cloud
Logging CloudOption Logging Option Response - Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.
- Destination string
- Where logs should be saved.
- Logs
Path string - The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
- cloud
Logging CloudOption Logging Option Response - Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.
- destination String
- Where logs should be saved.
- logs
Path String - The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
- cloud
Logging CloudOption Logging Option Response - Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.
- destination string
- Where logs should be saved.
- logs
Path string - The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
- cloud_
logging_ Cloudoption Logging Option Response - Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.
- destination str
- Where logs should be saved.
- logs_
path str - The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
- cloud
Logging Property MapOption - Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.
- destination String
- Where logs should be saved.
- logs
Path String - The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
MessageResponse
- New
Job stringState - The new job state.
- New
Task stringState - The new task state.
- Type string
- The message type.
- New
Job stringState - The new job state.
- New
Task stringState - The new task state.
- Type string
- The message type.
- new
Job StringState - The new job state.
- new
Task StringState - The new task state.
- type String
- The message type.
- new
Job stringState - The new job state.
- new
Task stringState - The new task state.
- type string
- The message type.
- new_
job_ strstate - The new job state.
- new_
task_ strstate - The new task state.
- type str
- The message type.
- new
Job StringState - The new job state.
- new
Task StringState - The new task state.
- type String
- The message type.
NFSResponse
- Remote
Path string - Remote source path exported from the NFS, e.g., "/share".
- Server string
- The IP address of the NFS.
- Remote
Path string - Remote source path exported from the NFS, e.g., "/share".
- Server string
- The IP address of the NFS.
- remote
Path String - Remote source path exported from the NFS, e.g., "/share".
- server String
- The IP address of the NFS.
- remote
Path string - Remote source path exported from the NFS, e.g., "/share".
- server string
- The IP address of the NFS.
- remote_
path str - Remote source path exported from the NFS, e.g., "/share".
- server str
- The IP address of the NFS.
- remote
Path String - Remote source path exported from the NFS, e.g., "/share".
- server String
- The IP address of the NFS.
NetworkInterfaceResponse
- Network string
- The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network}
- No
External boolIp Address - Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
- Subnetwork string
- The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork}
- Network string
- The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network}
- No
External boolIp Address - Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
- Subnetwork string
- The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork}
- network String
- The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network}
- no
External BooleanIp Address - Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
- subnetwork String
- The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork}
- network string
- The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network}
- no
External booleanIp Address - Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
- subnetwork string
- The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork}
- network str
- The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network}
- no_
external_ boolip_ address - Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
- subnetwork str
- The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork}
- network String
- The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network}
- no
External BooleanIp Address - Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
- subnetwork String
- The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork}
NetworkPolicyResponse
- Network
Interfaces List<Pulumi.Google Native. Batch. V1. Inputs. Network Interface Response> - Network configurations.
- Network
Interfaces []NetworkInterface Response - Network configurations.
- network
Interfaces List<NetworkInterface Response> - Network configurations.
- network
Interfaces NetworkInterface Response[] - Network configurations.
- network_
interfaces Sequence[NetworkInterface Response] - Network configurations.
- network
Interfaces List<Property Map> - Network configurations.
PlacementPolicyResponse
- Collocation string
- UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.
- Max
Distance string - When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented
- Collocation string
- UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.
- Max
Distance string - When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented
- collocation String
- UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.
- max
Distance String - When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented
- collocation string
- UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.
- max
Distance string - When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented
- collocation str
- UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.
- max_
distance str - When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented
- collocation String
- UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.
- max
Distance String - When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented
RunnableResponse
- Always
Run bool - By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
- Background bool
- This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
- Barrier
Pulumi.
Google Native. Batch. V1. Inputs. Barrier Response - Barrier runnable.
- Container
Pulumi.
Google Native. Batch. V1. Inputs. Container Response - Container runnable.
- Display
Name string - Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs.
- Environment
Pulumi.
Google Native. Batch. V1. Inputs. Environment Response - Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
- Ignore
Exit boolStatus - Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
- Labels Dictionary<string, string>
- Labels for this Runnable.
- Script
Pulumi.
Google Native. Batch. V1. Inputs. Script Response - Script runnable.
- Timeout string
- Timeout for this Runnable.
- Always
Run bool - By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
- Background bool
- This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
- Barrier
Barrier
Response - Barrier runnable.
- Container
Container
Response - Container runnable.
- Display
Name string - Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs.
- Environment
Environment
Response - Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
- Ignore
Exit boolStatus - Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
- Labels map[string]string
- Labels for this Runnable.
- Script
Script
Response - Script runnable.
- Timeout string
- Timeout for this Runnable.
- always
Run Boolean - By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
- background Boolean
- This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
- barrier
Barrier
Response - Barrier runnable.
- container
Container
Response - Container runnable.
- display
Name String - Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs.
- environment
Environment
Response - Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
- ignore
Exit BooleanStatus - Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
- labels Map<String,String>
- Labels for this Runnable.
- script
Script
Response - Script runnable.
- timeout String
- Timeout for this Runnable.
- always
Run boolean - By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
- background boolean
- This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
- barrier
Barrier
Response - Barrier runnable.
- container
Container
Response - Container runnable.
- display
Name string - Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs.
- environment
Environment
Response - Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
- ignore
Exit booleanStatus - Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
- labels {[key: string]: string}
- Labels for this Runnable.
- script
Script
Response - Script runnable.
- timeout string
- Timeout for this Runnable.
- always_
run bool - By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
- background bool
- This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
- barrier
Barrier
Response - Barrier runnable.
- container
Container
Response - Container runnable.
- display_
name str - Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs.
- environment
Environment
Response - Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
- ignore_
exit_ boolstatus - Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
- labels Mapping[str, str]
- Labels for this Runnable.
- script
Script
Response - Script runnable.
- timeout str
- Timeout for this Runnable.
- always
Run Boolean - By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
- background Boolean
- This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
- barrier Property Map
- Barrier runnable.
- container Property Map
- Container runnable.
- display
Name String - Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs.
- environment Property Map
- Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
- ignore
Exit BooleanStatus - Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
- labels Map<String>
- Labels for this Runnable.
- script Property Map
- Script runnable.
- timeout String
- Timeout for this Runnable.
ScriptResponse
- Path string
- Script file path on the host VM. To specify an interpreter, please add a
#!
(also known as shebang line) as the first line of the file.(For example, to execute the script using bash,#!/bin/bash
should be the first line of the file. To execute the script usingPython3
,#!/usr/bin/env python3
should be the first line of the file.) Otherwise, the file will by default be excuted by/bin/sh
. - Text string
- Shell script text. To specify an interpreter, please add a
#!\n
at the beginning of the text.(For example, to execute the script using bash,#!/bin/bash\n
should be added. To execute the script usingPython3
,#!/usr/bin/env python3\n
should be added.) Otherwise, the script will by default be excuted by/bin/sh
.
- Path string
- Script file path on the host VM. To specify an interpreter, please add a
#!
(also known as shebang line) as the first line of the file.(For example, to execute the script using bash,#!/bin/bash
should be the first line of the file. To execute the script usingPython3
,#!/usr/bin/env python3
should be the first line of the file.) Otherwise, the file will by default be excuted by/bin/sh
. - Text string
- Shell script text. To specify an interpreter, please add a
#!\n
at the beginning of the text.(For example, to execute the script using bash,#!/bin/bash\n
should be added. To execute the script usingPython3
,#!/usr/bin/env python3\n
should be added.) Otherwise, the script will by default be excuted by/bin/sh
.
- path String
- Script file path on the host VM. To specify an interpreter, please add a
#!
(also known as shebang line) as the first line of the file.(For example, to execute the script using bash,#!/bin/bash
should be the first line of the file. To execute the script usingPython3
,#!/usr/bin/env python3
should be the first line of the file.) Otherwise, the file will by default be excuted by/bin/sh
. - text String
- Shell script text. To specify an interpreter, please add a
#!\n
at the beginning of the text.(For example, to execute the script using bash,#!/bin/bash\n
should be added. To execute the script usingPython3
,#!/usr/bin/env python3\n
should be added.) Otherwise, the script will by default be excuted by/bin/sh
.
- path string
- Script file path on the host VM. To specify an interpreter, please add a
#!
(also known as shebang line) as the first line of the file.(For example, to execute the script using bash,#!/bin/bash
should be the first line of the file. To execute the script usingPython3
,#!/usr/bin/env python3
should be the first line of the file.) Otherwise, the file will by default be excuted by/bin/sh
. - text string
- Shell script text. To specify an interpreter, please add a
#!\n
at the beginning of the text.(For example, to execute the script using bash,#!/bin/bash\n
should be added. To execute the script usingPython3
,#!/usr/bin/env python3\n
should be added.) Otherwise, the script will by default be excuted by/bin/sh
.
- path str
- Script file path on the host VM. To specify an interpreter, please add a
#!
(also known as shebang line) as the first line of the file.(For example, to execute the script using bash,#!/bin/bash
should be the first line of the file. To execute the script usingPython3
,#!/usr/bin/env python3
should be the first line of the file.) Otherwise, the file will by default be excuted by/bin/sh
. - text str
- Shell script text. To specify an interpreter, please add a
#!\n
at the beginning of the text.(For example, to execute the script using bash,#!/bin/bash\n
should be added. To execute the script usingPython3
,#!/usr/bin/env python3\n
should be added.) Otherwise, the script will by default be excuted by/bin/sh
.
- path String
- Script file path on the host VM. To specify an interpreter, please add a
#!
(also known as shebang line) as the first line of the file.(For example, to execute the script using bash,#!/bin/bash
should be the first line of the file. To execute the script usingPython3
,#!/usr/bin/env python3
should be the first line of the file.) Otherwise, the file will by default be excuted by/bin/sh
. - text String
- Shell script text. To specify an interpreter, please add a
#!\n
at the beginning of the text.(For example, to execute the script using bash,#!/bin/bash\n
should be added. To execute the script usingPython3
,#!/usr/bin/env python3\n
should be added.) Otherwise, the script will by default be excuted by/bin/sh
.
ServiceAccountResponse
- Email string
- Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
- Scopes List<string>
- List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default.
- Email string
- Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
- Scopes []string
- List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default.
- email String
- Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
- scopes List<String>
- List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default.
- email string
- Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
- scopes string[]
- List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default.
- email str
- Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
- scopes Sequence[str]
- List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default.
- email String
- Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
- scopes List<String>
- List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default.
StatusEventResponse
- Description string
- Description of the event.
- Event
Time string - The time this event occurred.
- Task
Execution Pulumi.Google Native. Batch. V1. Inputs. Task Execution Response - Task Execution
- Task
State string - Task State
- Type string
- Type of the event.
- Description string
- Description of the event.
- Event
Time string - The time this event occurred.
- Task
Execution TaskExecution Response - Task Execution
- Task
State string - Task State
- Type string
- Type of the event.
- description String
- Description of the event.
- event
Time String - The time this event occurred.
- task
Execution TaskExecution Response - Task Execution
- task
State String - Task State
- type String
- Type of the event.
- description string
- Description of the event.
- event
Time string - The time this event occurred.
- task
Execution TaskExecution Response - Task Execution
- task
State string - Task State
- type string
- Type of the event.
- description str
- Description of the event.
- event_
time str - The time this event occurred.
- task_
execution TaskExecution Response - Task Execution
- task_
state str - Task State
- type str
- Type of the event.
- description String
- Description of the event.
- event
Time String - The time this event occurred.
- task
Execution Property Map - Task Execution
- task
State String - Task State
- type String
- Type of the event.
TaskExecutionResponse
- Exit
Code int - When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
- Exit
Code int - When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
- exit
Code Integer - When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
- exit
Code number - When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
- exit_
code int - When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
- exit
Code Number - When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
TaskGroupResponse
- Name string
- TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
- Parallelism string
- Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
- Permissive
Ssh bool - When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
- Require
Hosts boolFile - When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
- Scheduling
Policy string - Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
- Task
Count string - Number of Tasks in the TaskGroup. Default is 1.
- Task
Count stringPer Node - Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
- Task
Environments List<Pulumi.Google Native. Batch. V1. Inputs. Environment Response> - An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1).
- Task
Spec Pulumi.Google Native. Batch. V1. Inputs. Task Spec Response - Tasks in the group share the same task spec.
- Name string
- TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
- Parallelism string
- Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
- Permissive
Ssh bool - When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
- Require
Hosts boolFile - When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
- Scheduling
Policy string - Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
- Task
Count string - Number of Tasks in the TaskGroup. Default is 1.
- Task
Count stringPer Node - Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
- Task
Environments []EnvironmentResponse - An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1).
- Task
Spec TaskSpec Response - Tasks in the group share the same task spec.
- name String
- TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
- parallelism String
- Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
- permissive
Ssh Boolean - When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
- require
Hosts BooleanFile - When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
- scheduling
Policy String - Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
- task
Count String - Number of Tasks in the TaskGroup. Default is 1.
- task
Count StringPer Node - Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
- task
Environments List<EnvironmentResponse> - An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1).
- task
Spec TaskSpec Response - Tasks in the group share the same task spec.
- name string
- TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
- parallelism string
- Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
- permissive
Ssh boolean - When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
- require
Hosts booleanFile - When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
- scheduling
Policy string - Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
- task
Count string - Number of Tasks in the TaskGroup. Default is 1.
- task
Count stringPer Node - Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
- task
Environments EnvironmentResponse[] - An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1).
- task
Spec TaskSpec Response - Tasks in the group share the same task spec.
- name str
- TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
- parallelism str
- Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
- permissive_
ssh bool - When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
- require_
hosts_ boolfile - When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
- scheduling_
policy str - Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
- task_
count str - Number of Tasks in the TaskGroup. Default is 1.
- task_
count_ strper_ node - Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
- task_
environments Sequence[EnvironmentResponse] - An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1).
- task_
spec TaskSpec Response - Tasks in the group share the same task spec.
- name String
- TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
- parallelism String
- Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
- permissive
Ssh Boolean - When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
- require
Hosts BooleanFile - When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
- scheduling
Policy String - Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
- task
Count String - Number of Tasks in the TaskGroup. Default is 1.
- task
Count StringPer Node - Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
- task
Environments List<Property Map> - An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1).
- task
Spec Property Map - Tasks in the group share the same task spec.
TaskSpecResponse
- Compute
Resource Pulumi.Google Native. Batch. V1. Inputs. Compute Resource Response - ComputeResource requirements.
- Environment
Pulumi.
Google Native. Batch. V1. Inputs. Environment Response - Environment variables to set before running the Task.
- Environments Dictionary<string, string>
- Deprecated: please use environment(non-plural) instead.
- Lifecycle
Policies List<Pulumi.Google Native. Batch. V1. Inputs. Lifecycle Policy Response> - Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
- Max
Retry intCount - Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
- Max
Run stringDuration - Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
- Runnables
List<Pulumi.
Google Native. Batch. V1. Inputs. Runnable Response> - The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
- Volumes
List<Pulumi.
Google Native. Batch. V1. Inputs. Volume Response> - Volumes to mount before running Tasks using this TaskSpec.
- Compute
Resource ComputeResource Response - ComputeResource requirements.
- Environment
Environment
Response - Environment variables to set before running the Task.
- Environments map[string]string
- Deprecated: please use environment(non-plural) instead.
- Lifecycle
Policies []LifecyclePolicy Response - Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
- Max
Retry intCount - Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
- Max
Run stringDuration - Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
- Runnables
[]Runnable
Response - The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
- Volumes
[]Volume
Response - Volumes to mount before running Tasks using this TaskSpec.
- compute
Resource ComputeResource Response - ComputeResource requirements.
- environment
Environment
Response - Environment variables to set before running the Task.
- environments Map<String,String>
- Deprecated: please use environment(non-plural) instead.
- lifecycle
Policies List<LifecyclePolicy Response> - Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
- max
Retry IntegerCount - Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
- max
Run StringDuration - Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
- runnables
List<Runnable
Response> - The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
- volumes
List<Volume
Response> - Volumes to mount before running Tasks using this TaskSpec.
- compute
Resource ComputeResource Response - ComputeResource requirements.
- environment
Environment
Response - Environment variables to set before running the Task.
- environments {[key: string]: string}
- Deprecated: please use environment(non-plural) instead.
- lifecycle
Policies LifecyclePolicy Response[] - Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
- max
Retry numberCount - Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
- max
Run stringDuration - Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
- runnables
Runnable
Response[] - The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
- volumes
Volume
Response[] - Volumes to mount before running Tasks using this TaskSpec.
- compute_
resource ComputeResource Response - ComputeResource requirements.
- environment
Environment
Response - Environment variables to set before running the Task.
- environments Mapping[str, str]
- Deprecated: please use environment(non-plural) instead.
- lifecycle_
policies Sequence[LifecyclePolicy Response] - Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
- max_
retry_ intcount - Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
- max_
run_ strduration - Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
- runnables
Sequence[Runnable
Response] - The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
- volumes
Sequence[Volume
Response] - Volumes to mount before running Tasks using this TaskSpec.
- compute
Resource Property Map - ComputeResource requirements.
- environment Property Map
- Environment variables to set before running the Task.
- environments Map<String>
- Deprecated: please use environment(non-plural) instead.
- lifecycle
Policies List<Property Map> - Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
- max
Retry NumberCount - Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
- max
Run StringDuration - Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
- runnables List<Property Map>
- The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
- volumes List<Property Map>
- Volumes to mount before running Tasks using this TaskSpec.
VolumeResponse
- Device
Name string - Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
- Gcs
Pulumi.
Google Native. Batch. V1. Inputs. GCSResponse - A Google Cloud Storage (GCS) volume.
- Mount
Options List<string> - For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
- Mount
Path string - The mount path for the volume, e.g. /mnt/disks/share.
- Nfs
Pulumi.
Google Native. Batch. V1. Inputs. NFSResponse - A Network File System (NFS) volume. For example, a Filestore file share.
- Device
Name string - Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
- Gcs GCSResponse
- A Google Cloud Storage (GCS) volume.
- Mount
Options []string - For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
- Mount
Path string - The mount path for the volume, e.g. /mnt/disks/share.
- Nfs NFSResponse
- A Network File System (NFS) volume. For example, a Filestore file share.
- device
Name String - Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
- gcs GCSResponse
- A Google Cloud Storage (GCS) volume.
- mount
Options List<String> - For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
- mount
Path String - The mount path for the volume, e.g. /mnt/disks/share.
- nfs NFSResponse
- A Network File System (NFS) volume. For example, a Filestore file share.
- device
Name string - Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
- gcs GCSResponse
- A Google Cloud Storage (GCS) volume.
- mount
Options string[] - For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
- mount
Path string - The mount path for the volume, e.g. /mnt/disks/share.
- nfs NFSResponse
- A Network File System (NFS) volume. For example, a Filestore file share.
- device_
name str - Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
- gcs GCSResponse
- A Google Cloud Storage (GCS) volume.
- mount_
options Sequence[str] - For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
- mount_
path str - The mount path for the volume, e.g. /mnt/disks/share.
- nfs NFSResponse
- A Network File System (NFS) volume. For example, a Filestore file share.
- device
Name String - Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
- gcs Property Map
- A Google Cloud Storage (GCS) volume.
- mount
Options List<String> - For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
- mount
Path String - The mount path for the volume, e.g. /mnt/disks/share.
- nfs Property Map
- A Network File System (NFS) volume. For example, a Filestore file share.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi