com.google.api.services.servicecontrol.v2.model

Class AuditLog

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.servicecontrol.v2.model.AuditLog

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AuditLog
extends com.google.api.client.json.GenericJson

Common audit log format for Google Cloud Platform API operations.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Service Control API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AuditLog()

Method Summary

Modifier and Type	Method and Description
AuditLog	clone()
AuthenticationInfo	getAuthenticationInfo() Authentication information.
List<AuthorizationInfo>	getAuthorizationInfo() Authorization information.
Map<String,Object>	getMetadata() Other service-specific data about the request, response, and other information associated with the current audited event.
String	getMethodName() The name of the service method or operation.
Long	getNumResponseItems() The number of items returned from a List or Query API method, if applicable.
PolicyViolationInfo	getPolicyViolationInfo() Indicates the policy violations for this request.
Map<String,Object>	getRequest() The operation request.
RequestMetadata	getRequestMetadata() Metadata about the operation.
ResourceLocation	getResourceLocation() The resource location information.
String	getResourceName() The resource or collection that is the target of the operation.
Map<String,Object>	getResourceOriginalState() The resource's original state before mutation.
Map<String,Object>	getResponse() The operation response.
Map<String,Object>	getServiceData() Deprecated.
String	getServiceName() The name of the API service performing the operation.
Status	getStatus() The status of the overall operation.
AuditLog	set(String fieldName, Object value)
AuditLog	setAuthenticationInfo(AuthenticationInfo authenticationInfo) Authentication information.
AuditLog	setAuthorizationInfo(List<AuthorizationInfo> authorizationInfo) Authorization information.
AuditLog	setMetadata(Map<String,Object> metadata) Other service-specific data about the request, response, and other information associated with the current audited event.
AuditLog	setMethodName(String methodName) The name of the service method or operation.
AuditLog	setNumResponseItems(Long numResponseItems) The number of items returned from a List or Query API method, if applicable.
AuditLog	setPolicyViolationInfo(PolicyViolationInfo policyViolationInfo) Indicates the policy violations for this request.
AuditLog	setRequest(Map<String,Object> request) The operation request.
AuditLog	setRequestMetadata(RequestMetadata requestMetadata) Metadata about the operation.
AuditLog	setResourceLocation(ResourceLocation resourceLocation) The resource location information.
AuditLog	setResourceName(String resourceName) The resource or collection that is the target of the operation.
AuditLog	setResourceOriginalState(Map<String,Object> resourceOriginalState) The resource's original state before mutation.
AuditLog	setResponse(Map<String,Object> response) The operation response.
AuditLog	setServiceData(Map<String,Object> serviceData) Deprecated.
AuditLog	setServiceName(String serviceName) The name of the API service performing the operation.
AuditLog	setStatus(Status status) The status of the overall operation.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

AuditLog

public AuditLog()

Method Detail

getAuthenticationInfo

public AuthenticationInfo getAuthenticationInfo()

Authentication information.

Returns:

value or null for none

setAuthenticationInfo

public AuditLog setAuthenticationInfo(AuthenticationInfo authenticationInfo)

Authentication information.

Parameters:

authenticationInfo - authenticationInfo or null for none

getAuthorizationInfo

public List<AuthorizationInfo> getAuthorizationInfo()

Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission} tuple.

Returns:

value or null for none

setAuthorizationInfo

public AuditLog setAuthorizationInfo(List<AuthorizationInfo> authorizationInfo)

Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission} tuple.

Parameters:

authorizationInfo - authorizationInfo or null for none

getMetadata

public Map<String,Object> getMetadata()

Other service-specific data about the request, response, and other information associated with the current audited event.

Returns:

value or null for none

setMetadata

public AuditLog setMetadata(Map<String,Object> metadata)

Other service-specific data about the request, response, and other information associated with the current audited event.

Parameters:

metadata - metadata or null for none

getMethodName

public String getMethodName()

The name of the service method or operation. For API calls, this should be the name of the API method. For example, "google.cloud.bigquery.v2.TableService.InsertTable" "google.logging.v2.ConfigServiceV2.CreateSink"

Returns:

value or null for none

setMethodName

public AuditLog setMethodName(String methodName)

The name of the service method or operation. For API calls, this should be the name of the API method. For example, "google.cloud.bigquery.v2.TableService.InsertTable" "google.logging.v2.ConfigServiceV2.CreateSink"

Parameters:

methodName - methodName or null for none

getNumResponseItems

public Long getNumResponseItems()

The number of items returned from a List or Query API method, if applicable.

Returns:

value or null for none

setNumResponseItems

public AuditLog setNumResponseItems(Long numResponseItems)

The number of items returned from a List or Query API method, if applicable.

Parameters:

numResponseItems - numResponseItems or null for none

getPolicyViolationInfo

public PolicyViolationInfo getPolicyViolationInfo()

Indicates the policy violations for this request. If the request is denied by the policy, violation information will be logged here.

Returns:

value or null for none

setPolicyViolationInfo

public AuditLog setPolicyViolationInfo(PolicyViolationInfo policyViolationInfo)

Indicates the policy violations for this request. If the request is denied by the policy, violation information will be logged here.

Parameters:

policyViolationInfo - policyViolationInfo or null for none

getRequest

public Map<String,Object> getRequest()

The operation request. This may not include all request parameters, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.

Returns:

value or null for none

setRequest

public AuditLog setRequest(Map<String,Object> request)

The operation request. This may not include all request parameters, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.

Parameters:

request - request or null for none

getRequestMetadata

public RequestMetadata getRequestMetadata()

Metadata about the operation.

Returns:

value or null for none

setRequestMetadata

public AuditLog setRequestMetadata(RequestMetadata requestMetadata)

Metadata about the operation.

Parameters:

requestMetadata - requestMetadata or null for none

getResourceLocation

public ResourceLocation getResourceLocation()

The resource location information.

Returns:

value or null for none

setResourceLocation

public AuditLog setResourceLocation(ResourceLocation resourceLocation)

The resource location information.

Parameters:

resourceLocation - resourceLocation or null for none

getResourceName

public String getResourceName()

The resource or collection that is the target of the operation. The name is a scheme-less URI, not including the API service name. For example: "projects/PROJECT_ID/zones/us- central1-a/instances" "projects/PROJECT_ID/datasets/DATASET_ID"

Returns:

value or null for none

setResourceName

public AuditLog setResourceName(String resourceName)

The resource or collection that is the target of the operation. The name is a scheme-less URI, not including the API service name. For example: "projects/PROJECT_ID/zones/us- central1-a/instances" "projects/PROJECT_ID/datasets/DATASET_ID"

Parameters:

resourceName - resourceName or null for none

getResourceOriginalState

public Map<String,Object> getResourceOriginalState()

The resource's original state before mutation. Present only for operations which have successfully modified the targeted resource(s). In general, this field should contain all changed fields, except those that are already been included in `request`, `response`, `metadata` or `service_data` fields. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.

Returns:

value or null for none

setResourceOriginalState

public AuditLog setResourceOriginalState(Map<String,Object> resourceOriginalState)

The resource's original state before mutation. Present only for operations which have successfully modified the targeted resource(s). In general, this field should contain all changed fields, except those that are already been included in `request`, `response`, `metadata` or `service_data` fields. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.

Parameters:

resourceOriginalState - resourceOriginalState or null for none

getResponse

public Map<String,Object> getResponse()

The operation response. This may not include all response elements, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.

Returns:

value or null for none

setResponse

public AuditLog setResponse(Map<String,Object> response)

The operation response. This may not include all response elements, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.

Parameters:

response - response or null for none

getServiceData

public Map<String,Object> getServiceData()

Deprecated. Use the `metadata` field instead. Other service-specific data about the request, response, and other activities.

Returns:

value or null for none

setServiceData

public AuditLog setServiceData(Map<String,Object> serviceData)

Deprecated. Use the `metadata` field instead. Other service-specific data about the request, response, and other activities.

Parameters:

serviceData - serviceData or null for none

getServiceName

public String getServiceName()

The name of the API service performing the operation. For example, `"compute.googleapis.com"`.

Returns:

value or null for none

setServiceName

public AuditLog setServiceName(String serviceName)

The name of the API service performing the operation. For example, `"compute.googleapis.com"`.

Parameters:

serviceName - serviceName or null for none

getStatus

public Status getStatus()

The status of the overall operation.

Returns:

value or null for none

setStatus

public AuditLog setStatus(Status status)

The status of the overall operation.

Parameters:

status - status or null for none

set

public AuditLog set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public AuditLog clone()

Overrides:

clone in class com.google.api.client.json.GenericJson