REST Resource: projects.locations.applications.workloads

Resource: Workload

Workload is an App Hub data model that contains a discovered workload, which represents a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "workloadReference": {
    object (WorkloadReference)
  },
  "workloadProperties": {
    object (WorkloadProperties)
  },
  "discoveredWorkload": string,
  "attributes": {
    object (Attributes)
  },
  "createTime": string,
  "updateTime": string,
  "uid": string,
  "state": enum (State)
}
Fields
name

string

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

string

Optional. User-defined name for the Workload. Can have a maximum length of 63 characters.
description

string

Optional. User-defined description of a Workload. Can have a maximum length of 2048 characters.
workloadReference

object (WorkloadReference)

Output only. Reference of an underlying compute resource represented by the Workload. These are immutable.
workloadProperties

object (WorkloadProperties)

Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
discoveredWorkload

string

Required. Immutable. The resource name of the original discovered workload.
attributes

object (Attributes)

Optional. Consumer provided attributes.
createTime

string (Timestamp format)

Output only. Create time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Update time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
uid

string

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

enum (State)

Output only. Workload state.

State

Workload state.

Enums
STATE_UNSPECIFIED Unspecified state.
CREATING The Workload is being created.
ACTIVE The Workload is ready.
DELETING The Workload is being deleted.
DETACHED The underlying compute resources have been deleted.

Methods

create

 Creates a Workload in an Application.

delete

 Deletes a Workload from an Application.

get

 Gets a Workload in an Application.

list

 Lists Workloads in an Application.

patch

 Updates a Workload in an Application.