Class protos.google.cloud.assuredworkloads.v1.Workload (1.8.0)

Represents a Workload.

Package

@google-cloud/assured-workloads!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.assuredworkloads.v1.IWorkload);

Constructs a new Workload.

Parameter

Name	Description
properties	`IWorkload` Properties to set

Properties

billingAccount

public billingAccount: string;

Workload billingAccount.

Property Value

Type	Description
string

complianceRegime

public complianceRegime: (google.cloud.assuredworkloads.v1.Workload.ComplianceRegime|keyof typeof google.cloud.assuredworkloads.v1.Workload.ComplianceRegime);

Workload complianceRegime.

Property Value

Type	Description
(google.cloud.assuredworkloads.v1.Workload.ComplianceRegime\|keyof typeof google.cloud.assuredworkloads.v1.Workload.ComplianceRegime)

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Workload createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

displayName

public displayName: string;

Workload displayName.

Property Value

Type	Description
string

etag

public etag: string;

Workload etag.

Property Value

Type	Description
string

kmsSettings

public kmsSettings?: (google.cloud.assuredworkloads.v1.Workload.IKMSSettings|null);

Workload kmsSettings.

Property Value

Type	Description
(google.cloud.assuredworkloads.v1.Workload.IKMSSettings\|null)

labels

public labels: { [k: string]: string };

Workload labels.

Property Value

Type	Description
{ [k: string]: string }

name

public name: string;

Workload name.

Property Value

Type	Description
string

provisionedResourcesParent

public provisionedResourcesParent: string;

Workload provisionedResourcesParent.

Property Value

Type	Description
string

resources

public resources: google.cloud.assuredworkloads.v1.Workload.IResourceInfo[];

Workload resources.

Property Value

Type	Description
google.cloud.assuredworkloads.v1.Workload.IResourceInfo[]

resourceSettings

public resourceSettings: google.cloud.assuredworkloads.v1.Workload.IResourceSettings[];

Workload resourceSettings.

Property Value

Type	Description
google.cloud.assuredworkloads.v1.Workload.IResourceSettings[]

Methods

create(properties)

public static create(properties?: google.cloud.assuredworkloads.v1.IWorkload): google.cloud.assuredworkloads.v1.Workload;

Creates a new Workload instance using the specified properties.

Parameter

Name	Description
properties	`IWorkload` Properties to set

Returns

Type	Description
google.cloud.assuredworkloads.v1.Workload	Workload instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.assuredworkloads.v1.Workload;

Decodes a Workload message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.assuredworkloads.v1.Workload	Workload

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.assuredworkloads.v1.Workload;

Decodes a Workload message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.assuredworkloads.v1.Workload	Workload

encode(message, writer)

public static encode(message: google.cloud.assuredworkloads.v1.IWorkload, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Workload message. Does not implicitly messages.

Parameters

Name	Description
message	`IWorkload` Workload message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.assuredworkloads.v1.IWorkload, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Workload message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`IWorkload` Workload message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.assuredworkloads.v1.Workload;

Creates a Workload message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.assuredworkloads.v1.Workload	Workload

toJSON()

public toJSON(): { [k: string]: any };

Converts this Workload to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.assuredworkloads.v1.Workload, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Workload message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.cloud.assuredworkloads.v1.Workload` Workload
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Workload message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not