1. Packages
  2. Ns1 Provider
  3. API Docs
  4. PulsarJob
NS1 v3.6.2 published on Wednesday, Apr 9, 2025 by Pulumi

ns1.PulsarJob

Explore with Pulumi AI

Create PulsarJob Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PulsarJob(name: string, args: PulsarJobArgs, opts?: CustomResourceOptions);
@overload
def PulsarJob(resource_name: str,
              args: PulsarJobArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def PulsarJob(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              app_id: Optional[str] = None,
              type_id: Optional[str] = None,
              active: Optional[bool] = None,
              blend_metric_weights: Optional[PulsarJobBlendMetricWeightsArgs] = None,
              config: Optional[PulsarJobConfigArgs] = None,
              name: Optional[str] = None,
              shared: Optional[bool] = None,
              weights: Optional[Sequence[PulsarJobWeightArgs]] = None)
func NewPulsarJob(ctx *Context, name string, args PulsarJobArgs, opts ...ResourceOption) (*PulsarJob, error)
public PulsarJob(string name, PulsarJobArgs args, CustomResourceOptions? opts = null)
public PulsarJob(String name, PulsarJobArgs args)
public PulsarJob(String name, PulsarJobArgs args, CustomResourceOptions options)
type: ns1:PulsarJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PulsarJobArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PulsarJobArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PulsarJobArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PulsarJobArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PulsarJobArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var pulsarJobResource = new Ns1.PulsarJob("pulsarJobResource", new()
{
    AppId = "string",
    TypeId = "string",
    Active = false,
    BlendMetricWeights = new Ns1.Inputs.PulsarJobBlendMetricWeightsArgs
    {
        Timestamp = 0,
    },
    Config = new Ns1.Inputs.PulsarJobConfigArgs
    {
        Host = "string",
        Http = false,
        Https = false,
        JobTimeoutMillis = 0,
        RequestTimeoutMillis = 0,
        StaticValues = false,
        UrlPath = "string",
        UseXhr = false,
    },
    Name = "string",
    Shared = false,
    Weights = new[]
    {
        new Ns1.Inputs.PulsarJobWeightArgs
        {
            DefaultValue = 0,
            Name = "string",
            Weight = 0,
            Maximize = false,
        },
    },
});
Copy
example, err := ns1.NewPulsarJob(ctx, "pulsarJobResource", &ns1.PulsarJobArgs{
	AppId:  pulumi.String("string"),
	TypeId: pulumi.String("string"),
	Active: pulumi.Bool(false),
	BlendMetricWeights: &ns1.PulsarJobBlendMetricWeightsArgs{
		Timestamp: pulumi.Int(0),
	},
	Config: &ns1.PulsarJobConfigArgs{
		Host:                 pulumi.String("string"),
		Http:                 pulumi.Bool(false),
		Https:                pulumi.Bool(false),
		JobTimeoutMillis:     pulumi.Int(0),
		RequestTimeoutMillis: pulumi.Int(0),
		StaticValues:         pulumi.Bool(false),
		UrlPath:              pulumi.String("string"),
		UseXhr:               pulumi.Bool(false),
	},
	Name:   pulumi.String("string"),
	Shared: pulumi.Bool(false),
	Weights: ns1.PulsarJobWeightArray{
		&ns1.PulsarJobWeightArgs{
			DefaultValue: pulumi.Float64(0),
			Name:         pulumi.String("string"),
			Weight:       pulumi.Int(0),
			Maximize:     pulumi.Bool(false),
		},
	},
})
Copy
var pulsarJobResource = new PulsarJob("pulsarJobResource", PulsarJobArgs.builder()
    .appId("string")
    .typeId("string")
    .active(false)
    .blendMetricWeights(PulsarJobBlendMetricWeightsArgs.builder()
        .timestamp(0)
        .build())
    .config(PulsarJobConfigArgs.builder()
        .host("string")
        .http(false)
        .https(false)
        .jobTimeoutMillis(0)
        .requestTimeoutMillis(0)
        .staticValues(false)
        .urlPath("string")
        .useXhr(false)
        .build())
    .name("string")
    .shared(false)
    .weights(PulsarJobWeightArgs.builder()
        .defaultValue(0)
        .name("string")
        .weight(0)
        .maximize(false)
        .build())
    .build());
Copy
pulsar_job_resource = ns1.PulsarJob("pulsarJobResource",
    app_id="string",
    type_id="string",
    active=False,
    blend_metric_weights={
        "timestamp": 0,
    },
    config={
        "host": "string",
        "http": False,
        "https": False,
        "job_timeout_millis": 0,
        "request_timeout_millis": 0,
        "static_values": False,
        "url_path": "string",
        "use_xhr": False,
    },
    name="string",
    shared=False,
    weights=[{
        "default_value": 0,
        "name": "string",
        "weight": 0,
        "maximize": False,
    }])
Copy
const pulsarJobResource = new ns1.PulsarJob("pulsarJobResource", {
    appId: "string",
    typeId: "string",
    active: false,
    blendMetricWeights: {
        timestamp: 0,
    },
    config: {
        host: "string",
        http: false,
        https: false,
        jobTimeoutMillis: 0,
        requestTimeoutMillis: 0,
        staticValues: false,
        urlPath: "string",
        useXhr: false,
    },
    name: "string",
    shared: false,
    weights: [{
        defaultValue: 0,
        name: "string",
        weight: 0,
        maximize: false,
    }],
});
Copy
type: ns1:PulsarJob
properties:
    active: false
    appId: string
    blendMetricWeights:
        timestamp: 0
    config:
        host: string
        http: false
        https: false
        jobTimeoutMillis: 0
        requestTimeoutMillis: 0
        staticValues: false
        urlPath: string
        useXhr: false
    name: string
    shared: false
    typeId: string
    weights:
        - defaultValue: 0
          maximize: false
          name: string
          weight: 0
Copy

PulsarJob Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PulsarJob resource accepts the following input properties:

AppId This property is required. string
TypeId This property is required. string
Active bool
BlendMetricWeights PulsarJobBlendMetricWeights
Config PulsarJobConfig
Name string
Shared bool
Weights List<PulsarJobWeight>
AppId This property is required. string
TypeId This property is required. string
Active bool
BlendMetricWeights PulsarJobBlendMetricWeightsArgs
Config PulsarJobConfigArgs
Name string
Shared bool
Weights []PulsarJobWeightArgs
appId This property is required. String
typeId This property is required. String
active Boolean
blendMetricWeights PulsarJobBlendMetricWeights
config PulsarJobConfig
name String
shared Boolean
weights List<PulsarJobWeight>
appId This property is required. string
typeId This property is required. string
active boolean
blendMetricWeights PulsarJobBlendMetricWeights
config PulsarJobConfig
name string
shared boolean
weights PulsarJobWeight[]
appId This property is required. String
typeId This property is required. String
active Boolean
blendMetricWeights Property Map
config Property Map
name String
shared Boolean
weights List<Property Map>

Outputs

All input properties are implicitly available as output properties. Additionally, the PulsarJob resource produces the following output properties:

Community bool
Customer int
Id string
The provider-assigned unique ID for this managed resource.
JobId string
Community bool
Customer int
Id string
The provider-assigned unique ID for this managed resource.
JobId string
community Boolean
customer Integer
id String
The provider-assigned unique ID for this managed resource.
jobId String
community boolean
customer number
id string
The provider-assigned unique ID for this managed resource.
jobId string
community bool
customer int
id str
The provider-assigned unique ID for this managed resource.
job_id str
community Boolean
customer Number
id String
The provider-assigned unique ID for this managed resource.
jobId String

Look up Existing PulsarJob Resource

Get an existing PulsarJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PulsarJobState, opts?: CustomResourceOptions): PulsarJob
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        app_id: Optional[str] = None,
        blend_metric_weights: Optional[PulsarJobBlendMetricWeightsArgs] = None,
        community: Optional[bool] = None,
        config: Optional[PulsarJobConfigArgs] = None,
        customer: Optional[int] = None,
        job_id: Optional[str] = None,
        name: Optional[str] = None,
        shared: Optional[bool] = None,
        type_id: Optional[str] = None,
        weights: Optional[Sequence[PulsarJobWeightArgs]] = None) -> PulsarJob
func GetPulsarJob(ctx *Context, name string, id IDInput, state *PulsarJobState, opts ...ResourceOption) (*PulsarJob, error)
public static PulsarJob Get(string name, Input<string> id, PulsarJobState? state, CustomResourceOptions? opts = null)
public static PulsarJob get(String name, Output<String> id, PulsarJobState state, CustomResourceOptions options)
resources:  _:    type: ns1:PulsarJob    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Active bool
AppId string
BlendMetricWeights PulsarJobBlendMetricWeights
Community bool
Config PulsarJobConfig
Customer int
JobId Changes to this property will trigger replacement. string
Name string
Shared bool
TypeId string
Weights List<PulsarJobWeight>
Active bool
AppId string
BlendMetricWeights PulsarJobBlendMetricWeightsArgs
Community bool
Config PulsarJobConfigArgs
Customer int
JobId Changes to this property will trigger replacement. string
Name string
Shared bool
TypeId string
Weights []PulsarJobWeightArgs
active Boolean
appId String
blendMetricWeights PulsarJobBlendMetricWeights
community Boolean
config PulsarJobConfig
customer Integer
jobId Changes to this property will trigger replacement. String
name String
shared Boolean
typeId String
weights List<PulsarJobWeight>
active boolean
appId string
blendMetricWeights PulsarJobBlendMetricWeights
community boolean
config PulsarJobConfig
customer number
jobId Changes to this property will trigger replacement. string
name string
shared boolean
typeId string
weights PulsarJobWeight[]
active Boolean
appId String
blendMetricWeights Property Map
community Boolean
config Property Map
customer Number
jobId Changes to this property will trigger replacement. String
name String
shared Boolean
typeId String
weights List<Property Map>

Supporting Types

PulsarJobBlendMetricWeights
, PulsarJobBlendMetricWeightsArgs

Timestamp This property is required. int
Timestamp This property is required. int
timestamp This property is required. Integer
timestamp This property is required. number
timestamp This property is required. int
timestamp This property is required. Number

PulsarJobConfig
, PulsarJobConfigArgs

host String
http Boolean
https Boolean
jobTimeoutMillis Integer
requestTimeoutMillis Integer
staticValues Boolean
urlPath String
useXhr Boolean
host string
http boolean
https boolean
jobTimeoutMillis number
requestTimeoutMillis number
staticValues boolean
urlPath string
useXhr boolean
host String
http Boolean
https Boolean
jobTimeoutMillis Number
requestTimeoutMillis Number
staticValues Boolean
urlPath String
useXhr Boolean

PulsarJobWeight
, PulsarJobWeightArgs

DefaultValue This property is required. double
Name This property is required. string
Weight This property is required. int
Maximize bool
DefaultValue This property is required. float64
Name This property is required. string
Weight This property is required. int
Maximize bool
defaultValue This property is required. Double
name This property is required. String
weight This property is required. Integer
maximize Boolean
defaultValue This property is required. number
name This property is required. string
weight This property is required. number
maximize boolean
default_value This property is required. float
name This property is required. str
weight This property is required. int
maximize bool
defaultValue This property is required. Number
name This property is required. String
weight This property is required. Number
maximize Boolean

Package Details

Repository
NS1 pulumi/pulumi-ns1
License
Apache-2.0
Notes
This Pulumi package is based on the ns1 Terraform Provider.