com.pulumi.kubernetes.core.v1.Service 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.core.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.core.v1.ServiceArgs;
import com.pulumi.kubernetes.core.v1.outputs.ServiceSpec;
import com.pulumi.kubernetes.core.v1.outputs.ServiceStatus;
import com.pulumi.kubernetes.meta.v1.outputs.ObjectMeta;
import java.lang.String;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.
*
* 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. Service object exists.
* 2. Related Endpoint objects are created. Each time we get an update, wait 10 seconds
* for any stragglers.
* 3. There are no "not ready" endpoints -- unless the Service is an "empty
* headless" Service [1], a Service with '.spec.type: ExternalName', or a Service
* without a selector.
* 4. External IP address is allocated (if Service has '.spec.type: LoadBalancer').
*
* If the Service 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.
*
* ## Example Usage
* ### Create a Service with auto-naming
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.kubernetes.core_v1.Service;
* import com.pulumi.kubernetes.core_v1.ServiceArgs;
* import com.pulumi.kubernetes.core_v1.inputs.ServiceSpecArgs;
* 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 service = new Service("service", ServiceArgs.builder()
* .spec(ServiceSpecArgs.builder()
* .ports(ServicePortArgs.builder()
* .port(80)
* .protocol("TCP")
* .targetPort(9376)
* .build())
* .selector(Map.of("app", "MyApp"))
* .build())
* .build());
*
* }
* }
* }
*
* ### Create a Service with a user-specified name
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.kubernetes.core_v1.Service;
* import com.pulumi.kubernetes.core_v1.ServiceArgs;
* import com.pulumi.kubernetes.meta_v1.inputs.ObjectMetaArgs;
* import com.pulumi.kubernetes.core_v1.inputs.ServiceSpecArgs;
* 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 service = new Service("service", ServiceArgs.builder()
* .metadata(ObjectMetaArgs.builder()
* .name("my-service")
* .build())
* .spec(ServiceSpecArgs.builder()
* .ports(ServicePortArgs.builder()
* .port(80)
* .protocol("TCP")
* .targetPort(9376)
* .build())
* .selector(Map.of("app", "MyApp"))
* .build())
* .build());
*
* }
* }
* }
*
*
*/
@ResourceType(type="kubernetes:core/v1:Service")
public class Service 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 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 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={ObjectMeta.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 this.metadata;
}
/**
* Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
*
*/
@Export(name="spec", refs={ServiceSpec.class}, tree="[0]")
private Output spec;
/**
* @return Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
*
*/
public Output spec() {
return this.spec;
}
/**
* Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
*
*/
@Export(name="status", refs={ServiceStatus.class}, tree="[0]")
private Output status;
/**
* @return Most recently observed status of the service. Populated by the system. Read-only. 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 Service(String name) {
this(name, ServiceArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Service(String name, @Nullable ServiceArgs 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 Service(String name, @Nullable ServiceArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("kubernetes:core/v1:Service", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()));
}
private Service(String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("kubernetes:core/v1:Service", name, null, makeResourceOptions(options, id));
}
private static ServiceArgs makeArgs(@Nullable ServiceArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
var builder = args == null ? ServiceArgs.builder() : ServiceArgs.builder(args);
return builder
.apiVersion("v1")
.kind("Service")
.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 Service get(String name, Output id, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Service(name, id, options);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy