Package-level declarations

Types

Link copied to clipboard
data class AcceleratorArgs(val count: Output<String>? = null, val installGpuDrivers: Output<Boolean>? = null, val type: Output<String>? = null) : ConvertibleToJava<AcceleratorArgs>

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

Link copied to clipboard
Link copied to clipboard
data class ActionConditionArgs(val exitCodes: Output<List<Int>>? = null) : ConvertibleToJava<ActionConditionArgs>

Conditions for actions to deal with task failures.

Link copied to clipboard
data class AllocationPolicyArgs(val instances: Output<List<InstancePolicyOrTemplateArgs>>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<LocationPolicyArgs>? = null, val network: Output<NetworkPolicyArgs>? = null, val placement: Output<PlacementPolicyArgs>? = null, val serviceAccount: Output<ServiceAccountArgs>? = null) : ConvertibleToJava<AllocationPolicyArgs>

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

Link copied to clipboard
data class AttachedDiskArgs(val deviceName: Output<String>? = null, val existingDisk: Output<String>? = null, val newDisk: Output<DiskArgs>? = null) : ConvertibleToJava<AttachedDiskArgs>

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

Link copied to clipboard
Link copied to clipboard
data class BarrierArgs(val name: Output<String>? = null) : ConvertibleToJava<BarrierArgs>

Barrier runnable blocks until all tasks in a taskgroup reach it.

Link copied to clipboard
Link copied to clipboard
data class ComputeResourceArgs(val bootDiskMib: Output<String>? = null, val cpuMilli: Output<String>? = null, val memoryMib: Output<String>? = null) : ConvertibleToJava<ComputeResourceArgs>

Compute resource requirements

Link copied to clipboard
data class ContainerArgs(val blockExternalNetwork: Output<Boolean>? = null, val commands: Output<List<String>>? = null, val entrypoint: Output<String>? = null, val imageUri: Output<String>? = null, val options: Output<String>? = null, val password: Output<String>? = null, val username: Output<String>? = null, val volumes: Output<List<String>>? = null) : ConvertibleToJava<ContainerArgs>

Container runnable.

Link copied to clipboard
Link copied to clipboard
data class DiskArgs(val diskInterface: Output<String>? = null, val image: Output<String>? = null, val sizeGb: Output<String>? = null, val snapshot: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<DiskArgs>

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

Link copied to clipboard

Builder for DiskArgs.

Link copied to clipboard
data class EnvironmentArgs(val encryptedVariables: Output<KMSEnvMapArgs>? = null, val secretVariables: Output<Map<String, String>>? = null, val variables: Output<Map<String, String>>? = null) : ConvertibleToJava<EnvironmentArgs>

An Environment describes a collection of environment variables to set when executing Tasks.

Link copied to clipboard
Link copied to clipboard
data class GCSArgs(val remotePath: Output<String>? = null) : ConvertibleToJava<GCSArgs>

Represents a Google Cloud Storage volume.

Link copied to clipboard

Builder for GCSArgs.

Link copied to clipboard
data class GetJobPlainArgs(val jobId: String, val location: String, val project: String? = null) : ConvertibleToJava<GetJobPlainArgs>
Link copied to clipboard
Link copied to clipboard
data class InstancePolicyArgs(val accelerators: Output<List<AcceleratorArgs>>? = null, val bootDisk: Output<DiskArgs>? = null, val disks: Output<List<AttachedDiskArgs>>? = null, val machineType: Output<String>? = null, val minCpuPlatform: Output<String>? = null, val provisioningModel: Output<InstancePolicyProvisioningModel>? = null) : ConvertibleToJava<InstancePolicyArgs>

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

Link copied to clipboard
Link copied to clipboard
data class InstancePolicyOrTemplateArgs(val installGpuDrivers: Output<Boolean>? = null, val instanceTemplate: Output<String>? = null, val policy: Output<InstancePolicyArgs>? = null) : ConvertibleToJava<InstancePolicyOrTemplateArgs>

Either an InstancePolicy or an instance template.

Link copied to clipboard
data class JobNotificationArgs(val message: Output<MessageArgs>? = null, val pubsubTopic: Output<String>? = null) : ConvertibleToJava<JobNotificationArgs>

Notification configurations.

Link copied to clipboard
data class KMSEnvMapArgs(val cipherText: Output<String>? = null, val keyName: Output<String>? = null) : ConvertibleToJava<KMSEnvMapArgs>
Link copied to clipboard
Link copied to clipboard
data class LifecyclePolicyArgs(val action: Output<LifecyclePolicyAction>? = null, val actionCondition: Output<ActionConditionArgs>? = null) : ConvertibleToJava<LifecyclePolicyArgs>

LifecyclePolicy describes how to deal with task failures based on different conditions.

Link copied to clipboard
data class LocationPolicyArgs(val allowedLocations: Output<List<String>>? = null) : ConvertibleToJava<LocationPolicyArgs>
Link copied to clipboard
Link copied to clipboard
data class LogsPolicyArgs(val destination: Output<LogsPolicyDestination>? = null, val logsPath: Output<String>? = null) : ConvertibleToJava<LogsPolicyArgs>

LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved.

Link copied to clipboard
Link copied to clipboard
data class MessageArgs(val newJobState: Output<MessageNewJobState>? = null, val newTaskState: Output<MessageNewTaskState>? = null, val type: Output<MessageType>? = null) : ConvertibleToJava<MessageArgs>

Message details. Describe the attribute that a message should have. Without specified message attributes, no message will be sent by default.

Link copied to clipboard
Link copied to clipboard
data class NetworkInterfaceArgs(val network: Output<String>? = null, val noExternalIpAddress: Output<Boolean>? = null, val subnetwork: Output<String>? = null) : ConvertibleToJava<NetworkInterfaceArgs>

A network interface.

Link copied to clipboard
data class NetworkPolicyArgs(val networkInterfaces: Output<List<NetworkInterfaceArgs>>? = null) : ConvertibleToJava<NetworkPolicyArgs>

NetworkPolicy describes VM instance network configurations.

Link copied to clipboard
Link copied to clipboard
data class NFSArgs(val remotePath: Output<String>? = null, val server: Output<String>? = null) : ConvertibleToJava<NFSArgs>

Represents an NFS volume.

Link copied to clipboard

Builder for NFSArgs.

Link copied to clipboard
data class PlacementPolicyArgs(val collocation: Output<String>? = null, val maxDistance: Output<String>? = null) : ConvertibleToJava<PlacementPolicyArgs>

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

Link copied to clipboard
data class RunnableArgs(val alwaysRun: Output<Boolean>? = null, val background: Output<Boolean>? = null, val barrier: Output<BarrierArgs>? = null, val container: Output<ContainerArgs>? = null, val environment: Output<EnvironmentArgs>? = null, val ignoreExitStatus: Output<Boolean>? = null, val labels: Output<Map<String, String>>? = null, val script: Output<ScriptArgs>? = null, val timeout: Output<String>? = null) : ConvertibleToJava<RunnableArgs>

Runnable describes instructions for executing a specific script or container as part of a Task.

Link copied to clipboard
Link copied to clipboard
data class ScriptArgs(val path: Output<String>? = null, val text: Output<String>? = null) : ConvertibleToJava<ScriptArgs>

Script runnable.

Link copied to clipboard

Builder for ScriptArgs.

Link copied to clipboard
data class ServiceAccountArgs(val email: Output<String>? = null, val scopes: Output<List<String>>? = null) : ConvertibleToJava<ServiceAccountArgs>

Carries information about a Google Cloud service account.

Link copied to clipboard
Link copied to clipboard
data class TaskGroupArgs(val parallelism: Output<String>? = null, val permissiveSsh: Output<Boolean>? = null, val requireHostsFile: Output<Boolean>? = null, val taskCount: Output<String>? = null, val taskCountPerNode: Output<String>? = null, val taskEnvironments: Output<List<EnvironmentArgs>>? = null, val taskSpec: Output<TaskSpecArgs>) : ConvertibleToJava<TaskGroupArgs>

A TaskGroup contains one or multiple Tasks that share the same Runnable but with different runtime parameters.

Link copied to clipboard
Link copied to clipboard
data class TaskSpecArgs(val computeResource: Output<ComputeResourceArgs>? = null, val environment: Output<EnvironmentArgs>? = null, val environments: Output<Map<String, String>>? = null, val lifecyclePolicies: Output<List<LifecyclePolicyArgs>>? = null, val maxRetryCount: Output<Int>? = null, val maxRunDuration: Output<String>? = null, val runnables: Output<List<RunnableArgs>>? = null, val volumes: Output<List<VolumeArgs>>? = null) : ConvertibleToJava<TaskSpecArgs>

Spec of a task

Link copied to clipboard
Link copied to clipboard
data class VolumeArgs(val deviceName: Output<String>? = null, val gcs: Output<GCSArgs>? = null, val mountOptions: Output<List<String>>? = null, val mountPath: Output<String>? = null, val nfs: Output<NFSArgs>? = null) : ConvertibleToJava<VolumeArgs>

Volume describes a volume and parameters for it to be mounted to a VM.

Link copied to clipboard

Builder for VolumeArgs.