Console
    Contact Us Start free

    Google Cloud Assured Workloads V1 Client - Class Violation (1.0.5)

    Reference documentation and code samples for the Google Cloud Assured Workloads V1 Client class Violation.

    Workload monitoring Violation.

    Generated from protobuf message google.cloud.assuredworkloads.v1.Violation

    Namespace

    Google \ Cloud \ AssuredWorkloads \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

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

    ↳ description
    string

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

    ↳ begin_time
    Google\Protobuf\Timestamp

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

    ↳ update_time
    Google\Protobuf\Timestamp

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

    ↳ resolve_time
    Google\Protobuf\Timestamp

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

    ↳ category
    string

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

    ↳ state
    int

    Output only. State of the violation

    ↳ org_policy_constraint
    string

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

    ↳ audit_log_link
    string

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

    ↳ non_compliant_org_policy
    string

    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}

    ↳ remediation
    Violation\Remediation

    Output only. Compliance violation remediation

    ↳ acknowledged
    bool

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

    ↳ acknowledgement_time
    Google\Protobuf\Timestamp

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

    ↳ exception_audit_log_link
    string

    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}

    getName

    Output only. Immutable. Name of the Violation.

    Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}

    Returns
    Type
    Description
    string

    setName

    Output only. Immutable. Name of the Violation.

    Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    Output only. Description for the Violation.

    e.g. OrgPolicy gcp.resourceLocations has non compliant value.

    Returns
    Type
    Description
    string

    setDescription

    Output only. Description for the Violation.

    e.g. OrgPolicy gcp.resourceLocations has non compliant value.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getBeginTime

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

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasBeginTime

    clearBeginTime

    setBeginTime

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

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

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

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

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

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getResolveTime

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

    If the violation is ACTIVE this will be empty.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasResolveTime

    clearResolveTime

    setResolveTime

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

    If the violation is ACTIVE this will be empty.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getCategory

    Output only. Category under which this violation is mapped.

    e.g. Location, Service Usage, Access, Encryption, etc.

    Returns
    Type
    Description
    string

    setCategory

    Output only. Category under which this violation is mapped.

    e.g. Location, Service Usage, Access, Encryption, etc.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getState

    Output only. State of the violation

    Returns
    Type
    Description
    int

    setState

    Output only. State of the violation

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getOrgPolicyConstraint

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

    Returns
    Type
    Description
    string

    setOrgPolicyConstraint

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getAuditLogLink

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

    Returns
    Type
    Description
    string

    setAuditLogLink

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    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}

    Returns
    Type
    Description
    string

    setNonCompliantOrgPolicy

    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}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getRemediation

    Output only. Compliance violation remediation

    Returns
    Type
    Description
    Violation\Remediation |null

    hasRemediation

    clearRemediation

    setRemediation

    Output only. Compliance violation remediation

    Parameter
    Name
    Description
    var
    Violation\Remediation
    Returns
    Type
    Description
    $this

    getAcknowledged

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

    Returns
    Type
    Description
    bool

    setAcknowledged

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

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getAcknowledgementTime

    Optional. Timestamp when this violation was acknowledged last.

    This will be absent when acknowledged field is marked as false.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasAcknowledgementTime

    clearAcknowledgementTime

    setAcknowledgementTime

    Optional. Timestamp when this violation was acknowledged last.

    This will be absent when acknowledged field is marked as false.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    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}

    Returns
    Type
    Description
    string

    setExceptionAuditLogLink

    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}

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: