com.pulumi.kubernetes.apps.v1.DeploymentPatch 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.apps.v1;
import com.pulumi.core.Alias;
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.apps.v1.DeploymentPatchArgs;
import com.pulumi.kubernetes.apps.v1.outputs.DeploymentSpecPatch;
import com.pulumi.kubernetes.apps.v1.outputs.DeploymentStatusPatch;
import com.pulumi.kubernetes.meta.v1.outputs.ObjectMetaPatch;
import java.lang.String;
import java.util.List;
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.
* Deployment enables declarative updates for Pods and ReplicaSets.
*
* 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 Deployment has begun to be updated by the Deployment controller. If the current
* generation of the Deployment is > 1, then this means that the current generation must
* be different from the generation reported by the last outputs.
* 2. There exists a ReplicaSet whose revision is equal to the current revision of the
* Deployment.
* 3. The Deployment's '.status.conditions' has a status of type 'Available' whose 'status'
* member is set to 'True'.
* 4. If the Deployment has generation > 1, then '.status.conditions' has a status of type
* 'Progressing', whose 'status' member is set to 'True', and whose 'reason' is
* 'NewReplicaSetAvailable'. For generation <= 1, this status field does not exist,
* because it doesn't do a rollout (i.e., it simply creates the Deployment and
* corresponding ReplicaSet), and therefore there is no rollout to mark as 'Progressing'.
*
* If the Deployment 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.
*
*/
@ResourceType(type="kubernetes:apps/v1:DeploymentPatch")
public class DeploymentPatch 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 the Deployment.
*
*/
@Export(name="spec", refs={DeploymentSpecPatch.class}, tree="[0]")
private Output spec;
/**
* @return Specification of the desired behavior of the Deployment.
*
*/
public Output> spec() {
return Codegen.optional(this.spec);
}
/**
* Most recently observed status of the Deployment.
*
*/
@Export(name="status", refs={DeploymentStatusPatch.class}, tree="[0]")
private Output status;
/**
* @return Most recently observed status of the Deployment.
*
*/
public Output> status() {
return Codegen.optional(this.status);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public DeploymentPatch(String name) {
this(name, DeploymentPatchArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public DeploymentPatch(String name, @Nullable DeploymentPatchArgs 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 DeploymentPatch(String name, @Nullable DeploymentPatchArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("kubernetes:apps/v1:DeploymentPatch", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()));
}
private DeploymentPatch(String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("kubernetes:apps/v1:DeploymentPatch", name, null, makeResourceOptions(options, id));
}
private static DeploymentPatchArgs makeArgs(@Nullable DeploymentPatchArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
var builder = args == null ? DeploymentPatchArgs.builder() : DeploymentPatchArgs.builder(args);
return builder
.apiVersion("apps/v1")
.kind("Deployment")
.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())
.aliases(List.of(
Output.of(Alias.builder().type("kubernetes:apps/v1beta1:DeploymentPatch").build()),
Output.of(Alias.builder().type("kubernetes:apps/v1beta2:DeploymentPatch").build()),
Output.of(Alias.builder().type("kubernetes:extensions/v1beta1:DeploymentPatch").build())
))
.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 DeploymentPatch get(String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new DeploymentPatch(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy