Workload class

Workload represents a binary deployment (such as Managed Instance Groups (MIGs), GKE deployments, etc.) that performs the smallest logical subset of business functionality. It registers identified workload to the Application.

Example Usage

Import

Workload can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/applications/{{application_id}}/workloads/{{workload_id}}
• {{project}}/{{location}}/{{application_id}}/{{workload_id}}
• {{location}}/{{application_id}}/{{workload_id}}

When using the pulumi import command, Workload can be imported using one of the formats above. For example:

$ pulumi import gcp:apphub/workload:Workload default projects/{{project}}/locations/{{location}}/applications/{{application_id}}/workloads/{{workload_id}}
$ pulumi import gcp:apphub/workload:Workload default {{project}}/{{location}}/{{application_id}}/{{workload_id}}
$ pulumi import gcp:apphub/workload:Workload default {{location}}/{{application_id}}/{{workload_id}}

Constructors

Workload(String name, {WorkloadArgs? args, CustomResourceOptions? options})

Creates a new Workload. name The Pulumi resource name. args Arguments used to configure this Workload. The set of arguments for Workload. options Resource options controlling this resource's behavior.

Workload.reference(String urn)

Creates a typed reference to an existing Workload resource.

Properties

applicationId ↔ Output<String>

Part of parent. Full resource name of a parent Application. Example: projects/{HOST_PROJECT_ID}/locations/{LOCATION}/applications/{APPLICATION_ID}

late, final

attributes ↔ Output<WorkloadAttributes?>

Consumer provided attributes. Structure is documented below.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Output only. Create time.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

description ↔ Output<String?>

User-defined description of a Workload.

late, final

discoveredWorkload ↔ Output<String>

Immutable. The resource name of the original discovered workload.

late, final

displayName ↔ Output<String?>

User-defined name for the Workload.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ Output<String>

Part of parent. Full resource name of a parent Application. Example: projects/{HOST_PROJECT_ID}/locations/{LOCATION}/applications/{APPLICATION_ID}

late, final

name ↔ Output<String>

Identifier. The resource name of the Workload. Format:"projects/{host-project-id}/locations/{location}/applications/{application-id}/workloads/{workload-id}"

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Output<String>

Output only. Workload state. Possible values: STATE_UNSPECIFIED CREATING ACTIVE DELETING DETACHED

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

Output only. A universally unique identifier (UUID) for the Workload in the UUID4 format.

late, final

updateTime ↔ Output<String>

Output only. Update time.

late, final

urn ↔ Output<String>

late, final, inherited

workloadId ↔ Output<String>

The Workload identifier.

late, final

workloadProperties ↔ Output<List<WorkloadWorkloadProperty>>

Properties of an underlying compute resource represented by the Workload. Structure is documented below.

late, final

workloadReferences ↔ Output<List<WorkloadWorkloadReference>>

Reference of an underlying compute resource represented by the Workload. Structure is documented below.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {WorkloadState? state, CustomResourceOptions? options}) → Workload

Gets an existing Workload resource's state with the given name and id.