v1

class pulumi_kubernetes.batch.v1.Job(resource_name, opts=None, metadata=None, spec=None, __name__=None, __opts__=None)

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.

Create a Job resource with the given unique name, arguments, and options.

Parameters
apiVersion = None

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/api-conventions.md#resources

kind = None

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/api-conventions.md#types-kinds

metadata = None

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec = None

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

status = None

Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

static get(resource_name, id, opts=None)

Get the state of an existing Job resource, as identified by id. The ID is of the form [namespace]/[name]; if [namespace] is omitted, then (per Kubernetes convention) the ID becomes default/[name].

Pulumi will keep track of this resource using resource_name as the Pulumi ID.

Parameters
  • resource_name (str) – Unique name used to register this resource with Pulumi.

  • id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form [namespace]/[name] or [name].

  • opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.

translate_output_property(prop: str) → str

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop: str) → str

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_kubernetes.batch.v1.JobList(resource_name, opts=None, items=None, metadata=None, __name__=None, __opts__=None)

JobList is a collection of jobs.

Create a JobList resource with the given unique name, arguments, and options.

Parameters
apiVersion = None

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/api-conventions.md#resources

kind = None

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/api-conventions.md#types-kinds

items = None

items is the list of Jobs.

metadata = None

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

static get(resource_name, id, opts=None)

Get the state of an existing JobList resource, as identified by id. The ID is of the form [namespace]/[name]; if [namespace] is omitted, then (per Kubernetes convention) the ID becomes default/[name].

Pulumi will keep track of this resource using resource_name as the Pulumi ID.

Parameters
  • resource_name (str) – Unique name used to register this resource with Pulumi.

  • id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form [namespace]/[name] or [name].

  • opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.

translate_output_property(prop: str) → str

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop: str) → str

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str