Class Violation (2.51.0)

public final class Violation extends GeneratedMessageV3 implements ViolationOrBuilder

Workload monitoring Violation.

Protobuf type google.cloud.assuredworkloads.v1.Violation

Implements

ViolationOrBuilder

Static Fields

ACKNOWLEDGED_FIELD_NUMBER

public static final int ACKNOWLEDGED_FIELD_NUMBER
Field Value
Type Description
int

ACKNOWLEDGEMENT_TIME_FIELD_NUMBER

public static final int ACKNOWLEDGEMENT_TIME_FIELD_NUMBER
Field Value
Type Description
int
public static final int AUDIT_LOG_LINK_FIELD_NUMBER
Field Value
Type Description
int

BEGIN_TIME_FIELD_NUMBER

public static final int BEGIN_TIME_FIELD_NUMBER
Field Value
Type Description
int

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int
public static final int EXCEPTION_AUDIT_LOG_LINK_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NON_COMPLIANT_ORG_POLICY_FIELD_NUMBER

public static final int NON_COMPLIANT_ORG_POLICY_FIELD_NUMBER
Field Value
Type Description
int

ORG_POLICY_CONSTRAINT_FIELD_NUMBER

public static final int ORG_POLICY_CONSTRAINT_FIELD_NUMBER
Field Value
Type Description
int

REMEDIATION_FIELD_NUMBER

public static final int REMEDIATION_FIELD_NUMBER
Field Value
Type Description
int

RESOLVE_TIME_FIELD_NUMBER

public static final int RESOLVE_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Violation getDefaultInstance()
Returns
Type Description
Violation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Violation.Builder newBuilder()
Returns
Type Description
Violation.Builder

newBuilder(Violation prototype)

public static Violation.Builder newBuilder(Violation prototype)
Parameter
Name Description
prototype Violation
Returns
Type Description
Violation.Builder

parseDelimitedFrom(InputStream input)

public static Violation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Violation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Violation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Violation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Violation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Violation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Violation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Violation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Violation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Violation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Violation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Violation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Violation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Violation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Violation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Violation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Violation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Violation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Violation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Violation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Violation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Violation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Violation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Violation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Violation> parser()
Returns
Type Description
Parser<Violation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAcknowledged()

public boolean getAcknowledged()

Output only. A boolean that indicates if the violation is acknowledged

bool acknowledged = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The acknowledged.

getAcknowledgementTime()

public Timestamp getAcknowledgementTime()

Optional. Timestamp when this violation was acknowledged last. This will be absent when acknowledged field is marked as false.

optional .google.protobuf.Timestamp acknowledgement_time = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The acknowledgementTime.

getAcknowledgementTimeOrBuilder()

public TimestampOrBuilder getAcknowledgementTimeOrBuilder()

Optional. Timestamp when this violation was acknowledged last. This will be absent when acknowledged field is marked as false.

optional .google.protobuf.Timestamp acknowledgement_time = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder
public String getAuditLogLink()

Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder}

string audit_log_link = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The auditLogLink.

getAuditLogLinkBytes()

public ByteString getAuditLogLinkBytes()

Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder}

string audit_log_link = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for auditLogLink.

getBeginTime()

public Timestamp getBeginTime()

Output only. Time of the event which triggered the Violation.

.google.protobuf.Timestamp begin_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The beginTime.

getBeginTimeOrBuilder()

public TimestampOrBuilder getBeginTimeOrBuilder()

Output only. Time of the event which triggered the Violation.

.google.protobuf.Timestamp begin_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCategory()

public String getCategory()

Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.

string category = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The category.

getCategoryBytes()

public ByteString getCategoryBytes()

Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.

string category = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for category.

getDefaultInstanceForType()

public Violation getDefaultInstanceForType()
Returns
Type Description
Violation

getDescription()

public String getDescription()

Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.

string description = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.

string description = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for description.

public String getExceptionAuditLogLink()

Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization}

string exception_audit_log_link = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The exceptionAuditLogLink.

getExceptionAuditLogLinkBytes()

public ByteString getExceptionAuditLogLinkBytes()

Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization}

string exception_audit_log_link = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for exceptionAuditLogLink.

getName()

public String getName()

Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getNonCompliantOrgPolicy()

public String getNonCompliantOrgPolicy()

Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}

string non_compliant_org_policy = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The nonCompliantOrgPolicy.

getNonCompliantOrgPolicyBytes()

public ByteString getNonCompliantOrgPolicyBytes()

Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}

string non_compliant_org_policy = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for nonCompliantOrgPolicy.

getOrgPolicyConstraint()

public String getOrgPolicyConstraint()

Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.

string org_policy_constraint = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The orgPolicyConstraint.

getOrgPolicyConstraintBytes()

public ByteString getOrgPolicyConstraintBytes()

Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.

string org_policy_constraint = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for orgPolicyConstraint.

getParserForType()

public Parser<Violation> getParserForType()
Returns
Type Description
Parser<Violation>
Overrides

getRemediation()

public Violation.Remediation getRemediation()

Output only. Compliance violation remediation

.google.cloud.assuredworkloads.v1.Violation.Remediation remediation = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Violation.Remediation

The remediation.

getRemediationOrBuilder()

public Violation.RemediationOrBuilder getRemediationOrBuilder()

Output only. Compliance violation remediation

.google.cloud.assuredworkloads.v1.Violation.Remediation remediation = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Violation.RemediationOrBuilder

getResolveTime()

public Timestamp getResolveTime()

Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.

.google.protobuf.Timestamp resolve_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The resolveTime.

getResolveTimeOrBuilder()

public TimestampOrBuilder getResolveTimeOrBuilder()

Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.

.google.protobuf.Timestamp resolve_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Violation.State getState()

Output only. State of the violation

.google.cloud.assuredworkloads.v1.Violation.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Violation.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the violation

.google.cloud.assuredworkloads.v1.Violation.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The last time when the Violation record was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last time when the Violation record was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasAcknowledgementTime()

public boolean hasAcknowledgementTime()

Optional. Timestamp when this violation was acknowledged last. This will be absent when acknowledged field is marked as false.

optional .google.protobuf.Timestamp acknowledgement_time = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the acknowledgementTime field is set.

hasBeginTime()

public boolean hasBeginTime()

Output only. Time of the event which triggered the Violation.

.google.protobuf.Timestamp begin_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the beginTime field is set.

hasRemediation()

public boolean hasRemediation()

Output only. Compliance violation remediation

.google.cloud.assuredworkloads.v1.Violation.Remediation remediation = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the remediation field is set.

hasResolveTime()

public boolean hasResolveTime()

Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.

.google.protobuf.Timestamp resolve_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the resolveTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The last time when the Violation record was updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Violation.Builder newBuilderForType()
Returns
Type Description
Violation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Violation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Violation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Violation.Builder toBuilder()
Returns
Type Description
Violation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException