Violation

google.cloud.assuredworkloads.v1. Violation

Represents a Violation.

Constructor

new Violation(propertiesopt)

Constructs a new Violation.

Parameters:
Name Type Attributes Description
properties google.cloud.assuredworkloads.v1.IViolation <optional>

Properties to set
Implements:
  • IViolation

Classes

Remediation

Members

_acknowledgementTime

Violation _acknowledgementTime.

acknowledged

Violation acknowledged.

acknowledgementTime

Violation acknowledgementTime.

Violation auditLogLink.

beginTime

Violation beginTime.

category

Violation category.

description

Violation description.

Violation exceptionAuditLogLink.

name

Violation name.

nonCompliantOrgPolicy

Violation nonCompliantOrgPolicy.

orgPolicyConstraint

Violation orgPolicyConstraint.

remediation

Violation remediation.

resolveTime

Violation resolveTime.

state

Violation state.

updateTime

Violation updateTime.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value
RESOLVED number

RESOLVED value
UNRESOLVED number

UNRESOLVED value
EXCEPTION number

EXCEPTION value

Methods

toJSON() → {Object.<string, *>}

Converts this Violation to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.assuredworkloads.v1.Violation}

Creates a new Violation instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.assuredworkloads.v1.IViolation <optional>

Properties to set
Returns:
Type Description
google.cloud.assuredworkloads.v1.Violation

Violation instance

(static) decode(reader, lengthopt) → {google.cloud.assuredworkloads.v1.Violation}

Decodes a Violation message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Returns:
Type Description
google.cloud.assuredworkloads.v1.Violation

Violation
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.assuredworkloads.v1.Violation}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Returns:
Type Description
google.cloud.assuredworkloads.v1.Violation

Violation
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Violation message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.assuredworkloads.v1.IViolation

Violation message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.assuredworkloads.v1.IViolation

Violation message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.assuredworkloads.v1.Violation}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
google.cloud.assuredworkloads.v1.Violation

Violation

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Violation

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")
Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.assuredworkloads.v1.Violation

Violation
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Violation message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not