Represents a Violation.
Package
@google-cloud/assured-workloadsConstructors
(constructor)(properties)
constructor(properties?: google.cloud.assuredworkloads.v1.IViolation);
Constructs a new Violation.
Parameter | |
---|---|
Name | Description |
properties |
IViolation
Properties to set |
Properties
_acknowledgementTime
public _acknowledgementTime?: "acknowledgementTime";
Violation _acknowledgementTime.
acknowledged
public acknowledged: boolean;
Violation acknowledged.
acknowledgementTime
public acknowledgementTime?: (google.protobuf.ITimestamp|null);
Violation acknowledgementTime.
auditLogLink
public auditLogLink: string;
Violation auditLogLink.
beginTime
public beginTime?: (google.protobuf.ITimestamp|null);
Violation beginTime.
category
public category: string;
Violation category.
description
public description: string;
Violation description.
exceptionAuditLogLink
public exceptionAuditLogLink: string;
Violation exceptionAuditLogLink.
name
public name: string;
Violation name.
nonCompliantOrgPolicy
public nonCompliantOrgPolicy: string;
Violation nonCompliantOrgPolicy.
orgPolicyConstraint
public orgPolicyConstraint: string;
Violation orgPolicyConstraint.
remediation
public remediation?: (google.cloud.assuredworkloads.v1.Violation.IRemediation|null);
Violation remediation.
resolveTime
public resolveTime?: (google.protobuf.ITimestamp|null);
Violation resolveTime.
state
public state: (google.cloud.assuredworkloads.v1.Violation.State|keyof typeof google.cloud.assuredworkloads.v1.Violation.State);
Violation state.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);
Violation updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.assuredworkloads.v1.IViolation): google.cloud.assuredworkloads.v1.Violation;
Creates a new Violation instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IViolation
Properties to set |
Returns | |
---|---|
Type | Description |
google.cloud.assuredworkloads.v1.Violation | Violation instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.assuredworkloads.v1.Violation;
Decodes a Violation 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.Violation | Violation |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.assuredworkloads.v1.Violation;
Decodes a Violation 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.Violation | Violation |
encode(message, writer)
public static encode(message: google.cloud.assuredworkloads.v1.IViolation, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Violation message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IViolation
Violation 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.IViolation, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Violation message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IViolation
Violation 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.Violation;
Creates a Violation 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.Violation | Violation |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Violation
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Violation to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.assuredworkloads.v1.Violation, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Violation message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
google.cloud.assuredworkloads.v1.Violation
Violation |
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 Violation message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|