Close httplib2 connections.
Gets details of a single Violation.
Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of {customer} & {workload}. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}`
Retrieves the next page of results.
close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets details of a single Violation.
Args:
name: string, Required. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/violations/{violation}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Details of resource Violation
"beginTime": "A String", # Output only. Time of the event which triggered the Violation.
"category": "A String", # Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.
"description": "A String", # Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.
"folderId": "A String", # The folder_id of the violation
"name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/violations/{violation}`
"nonCompliantOrgPolicy": "A 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": { # Represents remediation guidance to resolve compliance violation for AssuredWorkload # Output only. Compliance violation remediation
"compliantValues": [ # Values that can resolve the violation For example: for list org policy violations, this will either be the list of allowed or denied values
"A String",
],
"instructions": { # Instructions to remediate violation # Required. Remediation instructions to resolve violations
"consoleInstructions": { # Remediation instructions to resolve violation via cloud console # Remediation instructions to resolve violation via cloud console
"additionalLinks": [ # Additional urls for more information about steps
"A String",
],
"consoleUris": [ # Link to console page where violations can be resolved
"A String",
],
"steps": [ # Steps to resolve violation via cloud console
"A String",
],
},
"gcloudInstructions": { # Remediation instructions to resolve violation via gcloud cli # Remediation instructions to resolve violation via gcloud cli
"additionalLinks": [ # Additional urls for more information about steps
"A String",
],
"gcloudCommands": [ # Gcloud command to resolve violation
"A String",
],
"steps": [ # Steps to resolve violation via gcloud cli
"A String",
],
},
},
"remediationType": "A String", # Output only. Remediation type based on the type of org policy values violated
},
"resolveTime": "A String", # Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.
"state": "A String", # Output only. State of the violation
"updateTime": "A String", # Output only. The last time when the Violation record was updated.
}
list(parent, filter=None, interval_endTime=None, interval_startTime=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of {customer} & {workload}. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}`
Args:
parent: string, Required. Parent resource Format `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}` (required)
filter: string, Optional. Filtering results
interval_endTime: string, Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
interval_startTime: string, Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
orderBy: string, Optional. Hint for how to order the results
pageSize: integer, Optional. The maximum number of customers row to return. The service may return fewer than this value. If unspecified, at most 10 customers will be returned.
pageToken: string, Optional. A page token, received from a previous `ListViolations` call. Provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for list customer violation requests
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"unreachable": [ # Workloads that could not be reached due to permission errors or any other error. Ref: https://google.aip.dev/217
"A String",
],
"violations": [ # List of violation
{ # Details of resource Violation
"beginTime": "A String", # Output only. Time of the event which triggered the Violation.
"category": "A String", # Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc.
"description": "A String", # Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.
"folderId": "A String", # The folder_id of the violation
"name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/violations/{violation}`
"nonCompliantOrgPolicy": "A 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": { # Represents remediation guidance to resolve compliance violation for AssuredWorkload # Output only. Compliance violation remediation
"compliantValues": [ # Values that can resolve the violation For example: for list org policy violations, this will either be the list of allowed or denied values
"A String",
],
"instructions": { # Instructions to remediate violation # Required. Remediation instructions to resolve violations
"consoleInstructions": { # Remediation instructions to resolve violation via cloud console # Remediation instructions to resolve violation via cloud console
"additionalLinks": [ # Additional urls for more information about steps
"A String",
],
"consoleUris": [ # Link to console page where violations can be resolved
"A String",
],
"steps": [ # Steps to resolve violation via cloud console
"A String",
],
},
"gcloudInstructions": { # Remediation instructions to resolve violation via gcloud cli # Remediation instructions to resolve violation via gcloud cli
"additionalLinks": [ # Additional urls for more information about steps
"A String",
],
"gcloudCommands": [ # Gcloud command to resolve violation
"A String",
],
"steps": [ # Steps to resolve violation via gcloud cli
"A String",
],
},
},
"remediationType": "A String", # Output only. Remediation type based on the type of org policy values violated
},
"resolveTime": "A String", # Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.
"state": "A String", # Output only. State of the violation
"updateTime": "A String", # Output only. The last time when the Violation record was updated.
},
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.