com.pulumi.kubernetes.batch.v1.kotlin.Job.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-kubernetes-kotlin Show documentation
Show all versions of pulumi-kubernetes-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
The newest version!
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.kubernetes.batch.v1.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.kubernetes.batch.v1.kotlin.outputs.JobSpec
import com.pulumi.kubernetes.batch.v1.kotlin.outputs.JobStatus
import com.pulumi.kubernetes.meta.v1.kotlin.outputs.ObjectMeta
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import com.pulumi.kubernetes.batch.v1.kotlin.outputs.JobSpec.Companion.toKotlin as jobSpecToKotlin
import com.pulumi.kubernetes.batch.v1.kotlin.outputs.JobStatus.Companion.toKotlin as jobStatusToKotlin
import com.pulumi.kubernetes.meta.v1.kotlin.outputs.ObjectMeta.Companion.toKotlin as objectMetaToKotlin
/**
* Builder for [Job].
*/
@PulumiTagMarker
public class JobResourceBuilder internal constructor() {
public var name: String? = null
public var args: JobArgs = JobArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend JobArgsBuilder.() -> Unit) {
val builder = JobArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Job {
val builtJavaResource = com.pulumi.kubernetes.batch.v1.Job(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Job(builtJavaResource)
}
}
/**
* Job represents the configuration of a single job.
* This resource waits until its status is ready before registering success
* for create/update, and populating output properties from the current state of the resource.
* The following conditions are used to determine whether the resource creation has
* succeeded or failed:
* 1. The Job's '.status.startTime' is set, which indicates that the Job has started running.
* 2. The Job's '.status.conditions' has a status of type 'Complete', and a 'status' set
* to 'True'.
* 3. The Job's '.status.conditions' do not have a status of type 'Failed', with a
* 'status' set to 'True'. If this condition is set, we should fail the Job immediately.
* If the Job has not reached a Ready state after 10 minutes, it will
* time out and mark the resource update as Failed. You can override the default timeout value
* by setting the 'customTimeouts' option on the resource.
* By default, if a resource failed to become ready in a previous update,
* Pulumi will continue to wait for readiness on the next update. If you would prefer
* to schedule a replacement for an unready resource on the next update, you can add the
* "pulumi.com/replaceUnready": "true" annotation to the resource definition.
* ## Example Usage
* ### Create a Job with auto-naming
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.kubernetes.batch_v1.Job;
* import com.pulumi.kubernetes.batch_v1.JobArgs;
* import com.pulumi.kubernetes.batch_v1.inputs.JobSpecArgs;
* import com.pulumi.kubernetes.core_v1.inputs.PodTemplateSpecArgs;
* import com.pulumi.kubernetes.core_v1.inputs.PodSpecArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var job = new Job("job", JobArgs.builder()
* .metadata(null)
* .spec(JobSpecArgs.builder()
* .backoffLimit(4)
* .template(PodTemplateSpecArgs.builder()
* .spec(PodSpecArgs.builder()
* .containers(ContainerArgs.builder()
* .command(
* "perl",
* "-Mbignum=bpi",
* "-wle",
* "print bpi(2000)")
* .image("perl")
* .name("pi")
* .build())
* .restartPolicy("Never")
* .build())
* .build())
* .build())
* .build());
* }
* }
* ```
* ### Create a Job with a user-specified name
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.kubernetes.batch_v1.Job;
* import com.pulumi.kubernetes.batch_v1.JobArgs;
* import com.pulumi.kubernetes.meta_v1.inputs.ObjectMetaArgs;
* import com.pulumi.kubernetes.batch_v1.inputs.JobSpecArgs;
* import com.pulumi.kubernetes.core_v1.inputs.PodTemplateSpecArgs;
* import com.pulumi.kubernetes.core_v1.inputs.PodSpecArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var job = new Job("job", JobArgs.builder()
* .metadata(ObjectMetaArgs.builder()
* .name("pi")
* .build())
* .spec(JobSpecArgs.builder()
* .backoffLimit(4)
* .template(PodTemplateSpecArgs.builder()
* .spec(PodSpecArgs.builder()
* .containers(ContainerArgs.builder()
* .command(
* "perl",
* "-Mbignum=bpi",
* "-wle",
* "print bpi(2000)")
* .image("perl")
* .name("pi")
* .build())
* .restartPolicy("Never")
* .build())
* .build())
* .build())
* .build());
* }
* }
* ```
*/
public class Job internal constructor(
override val javaResource: com.pulumi.kubernetes.batch.v1.Job,
) : KotlinCustomResource(javaResource, JobMapper) {
/**
* APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
*/
public val apiVersion: Output
get() = javaResource.apiVersion().applyValue({ args0 -> args0 })
/**
* Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
*/
public val kind: Output
get() = javaResource.kind().applyValue({ args0 -> args0 })
/**
* Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*/
public val metadata: Output
get() = javaResource.metadata().applyValue({ args0 ->
args0.let({ args0 ->
objectMetaToKotlin(args0)
})
})
/**
* Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
*/
public val spec: Output
get() = javaResource.spec().applyValue({ args0 -> args0.let({ args0 -> jobSpecToKotlin(args0) }) })
/**
* Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
*/
public val status: Output?
get() = javaResource.status().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
jobStatusToKotlin(args0)
})
}).orElse(null)
})
}
public object JobMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.kubernetes.batch.v1.Job::class == javaResource::class
override fun map(javaResource: Resource): Job = Job(
javaResource as
com.pulumi.kubernetes.batch.v1.Job,
)
}
/**
* @see [Job].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Job].
*/
public suspend fun job(name: String, block: suspend JobResourceBuilder.() -> Unit): Job {
val builder = JobResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Job].
* @param name The _unique_ name of the resulting resource.
*/
public fun job(name: String): Job {
val builder = JobResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy