com.pulumi.kubernetes.batch.v1.JobPatch Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kubernetes Show documentation
Show all versions of kubernetes Show documentation
A Pulumi package for creating and managing Kubernetes resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.kubernetes.batch.v1;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import com.pulumi.kubernetes.Utilities;
import com.pulumi.kubernetes.batch.v1.JobPatchArgs;
import com.pulumi.kubernetes.batch.v1.outputs.JobSpecPatch;
import com.pulumi.kubernetes.batch.v1.outputs.JobStatusPatch;
import com.pulumi.kubernetes.meta.v1.outputs.ObjectMetaPatch;
import java.lang.String;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Patch resources are used to modify existing Kubernetes resources by using
* Server-Side Apply updates. The name of the resource must be specified, but all other properties are optional. More than
* one patch may be applied to the same resource, and a random FieldManager name will be used for each Patch resource.
* Conflicts will result in an error by default, but can be forced using the "pulumi.com/patchForce" annotation. See the
* [Server-Side Apply Docs](https://www.pulumi.com/registry/packages/kubernetes/how-to-guides/managing-resources-with-server-side-apply/) for
* additional information about using Server-Side Apply to manage Kubernetes resources with Pulumi.
* 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.
*
*/
@ResourceType(type="kubernetes:batch/v1:JobPatch")
public class JobPatch extends com.pulumi.resources.CustomResource {
/**
* 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
*
*/
@Export(name="apiVersion", refs={String.class}, tree="[0]")
private Output apiVersion;
/**
* @return 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 Output> apiVersion() {
return Codegen.optional(this.apiVersion);
}
/**
* 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
*
*/
@Export(name="kind", refs={String.class}, tree="[0]")
private Output kind;
/**
* @return 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 Output> kind() {
return Codegen.optional(this.kind);
}
/**
* Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*
*/
@Export(name="metadata", refs={ObjectMetaPatch.class}, tree="[0]")
private Output metadata;
/**
* @return Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*
*/
public Output> metadata() {
return Codegen.optional(this.metadata);
}
/**
* 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
*
*/
@Export(name="spec", refs={JobSpecPatch.class}, tree="[0]")
private Output spec;
/**
* @return 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 Output> spec() {
return Codegen.optional(this.spec);
}
/**
* Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
*
*/
@Export(name="status", refs={JobStatusPatch.class}, tree="[0]")
private Output status;
/**
* @return Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
*
*/
public Output> status() {
return Codegen.optional(this.status);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public JobPatch(String name) {
this(name, JobPatchArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public JobPatch(String name, @Nullable JobPatchArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public JobPatch(String name, @Nullable JobPatchArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("kubernetes:batch/v1:JobPatch", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()));
}
private JobPatch(String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("kubernetes:batch/v1:JobPatch", name, null, makeResourceOptions(options, id));
}
private static JobPatchArgs makeArgs(@Nullable JobPatchArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
var builder = args == null ? JobPatchArgs.builder() : JobPatchArgs.builder(args);
return builder
.apiVersion("batch/v1")
.kind("Job")
.build();
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static JobPatch get(String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new JobPatch(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy