public final class AuditLog extends GeneratedMessageV3 implements AuditLogOrBuilder
Common audit log format for Google Cloud Platform API operations.
Protobuf type google.cloud.audit.AuditLog
Static Fields
AUTHENTICATION_INFO_FIELD_NUMBER
public static final int AUTHENTICATION_INFO_FIELD_NUMBER
Field Value
AUTHORIZATION_INFO_FIELD_NUMBER
public static final int AUTHORIZATION_INFO_FIELD_NUMBER
Field Value
public static final int METADATA_FIELD_NUMBER
Field Value
METHOD_NAME_FIELD_NUMBER
public static final int METHOD_NAME_FIELD_NUMBER
Field Value
NUM_RESPONSE_ITEMS_FIELD_NUMBER
public static final int NUM_RESPONSE_ITEMS_FIELD_NUMBER
Field Value
POLICY_VIOLATION_INFO_FIELD_NUMBER
public static final int POLICY_VIOLATION_INFO_FIELD_NUMBER
Field Value
REQUEST_FIELD_NUMBER
public static final int REQUEST_FIELD_NUMBER
Field Value
public static final int REQUEST_METADATA_FIELD_NUMBER
Field Value
RESOURCE_LOCATION_FIELD_NUMBER
public static final int RESOURCE_LOCATION_FIELD_NUMBER
Field Value
RESOURCE_NAME_FIELD_NUMBER
public static final int RESOURCE_NAME_FIELD_NUMBER
Field Value
RESOURCE_ORIGINAL_STATE_FIELD_NUMBER
public static final int RESOURCE_ORIGINAL_STATE_FIELD_NUMBER
Field Value
RESPONSE_FIELD_NUMBER
public static final int RESPONSE_FIELD_NUMBER
Field Value
SERVICE_DATA_FIELD_NUMBER
public static final int SERVICE_DATA_FIELD_NUMBER
Field Value
SERVICE_NAME_FIELD_NUMBER
public static final int SERVICE_NAME_FIELD_NUMBER
Field Value
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AuditLog getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AuditLog.Builder newBuilder()
Returns
newBuilder(AuditLog prototype)
public static AuditLog.Builder newBuilder(AuditLog prototype)
Parameter
Returns
public static AuditLog parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AuditLog parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AuditLog parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AuditLog parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AuditLog parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AuditLog parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AuditLog parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AuditLog parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AuditLog parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AuditLog parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AuditLog parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AuditLog parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AuditLog> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAuthenticationInfo()
public AuthenticationInfo getAuthenticationInfo()
Authentication information.
.google.cloud.audit.AuthenticationInfo authentication_info = 3;
getAuthenticationInfoOrBuilder()
public AuthenticationInfoOrBuilder getAuthenticationInfoOrBuilder()
Authentication information.
.google.cloud.audit.AuthenticationInfo authentication_info = 3;
getAuthorizationInfo(int index)
public AuthorizationInfo getAuthorizationInfo(int index)
Authorization information. If there are multiple
resources or permissions involved, then there is
one AuthorizationInfo element for each {resource, permission} tuple.
repeated .google.cloud.audit.AuthorizationInfo authorization_info = 9;
getAuthorizationInfoCount()
public int getAuthorizationInfoCount()
Authorization information. If there are multiple
resources or permissions involved, then there is
one AuthorizationInfo element for each {resource, permission} tuple.
repeated .google.cloud.audit.AuthorizationInfo authorization_info = 9;
getAuthorizationInfoList()
public List<AuthorizationInfo> getAuthorizationInfoList()
Authorization information. If there are multiple
resources or permissions involved, then there is
one AuthorizationInfo element for each {resource, permission} tuple.
repeated .google.cloud.audit.AuthorizationInfo authorization_info = 9;
getAuthorizationInfoOrBuilder(int index)
public AuthorizationInfoOrBuilder getAuthorizationInfoOrBuilder(int index)
Authorization information. If there are multiple
resources or permissions involved, then there is
one AuthorizationInfo element for each {resource, permission} tuple.
repeated .google.cloud.audit.AuthorizationInfo authorization_info = 9;
getAuthorizationInfoOrBuilderList()
public List<? extends AuthorizationInfoOrBuilder> getAuthorizationInfoOrBuilderList()
Authorization information. If there are multiple
resources or permissions involved, then there is
one AuthorizationInfo element for each {resource, permission} tuple.
repeated .google.cloud.audit.AuthorizationInfo authorization_info = 9;
| Type | Description |
| List<? extends com.google.cloud.audit.AuthorizationInfoOrBuilder> | |
getDefaultInstanceForType()
public AuditLog getDefaultInstanceForType()
Returns
public Struct getMetadata()
Other service-specific data about the request, response, and other
information associated with the current audited event.
.google.protobuf.Struct metadata = 18;
| Type | Description |
| Struct | The metadata.
|
public StructOrBuilder getMetadataOrBuilder()
Other service-specific data about the request, response, and other
information associated with the current audited event.
.google.protobuf.Struct metadata = 18;
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"
string method_name = 8;
| Type | Description |
| String | The methodName.
|
getMethodNameBytes()
public ByteString getMethodNameBytes()
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"
string method_name = 8;
| Type | Description |
| ByteString | The bytes for methodName.
|
getNumResponseItems()
public long getNumResponseItems()
The number of items returned from a List or Query API method,
if applicable.
int64 num_response_items = 12;
| Type | Description |
| long | The numResponseItems.
|
getParserForType()
public Parser<AuditLog> getParserForType()
Returns
Overrides
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.
.google.cloud.audit.PolicyViolationInfo policy_violation_info = 25;
getPolicyViolationInfoOrBuilder()
public PolicyViolationInfoOrBuilder getPolicyViolationInfoOrBuilder()
Indicates the policy violations for this request. If the request
is denied by the policy, violation information will be logged
here.
.google.cloud.audit.PolicyViolationInfo policy_violation_info = 25;
getRequest()
public Struct 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.
.google.protobuf.Struct request = 16;
| Type | Description |
| Struct | The request.
|
public RequestMetadata getRequestMetadata()
Metadata about the operation.
.google.cloud.audit.RequestMetadata request_metadata = 4;
public RequestMetadataOrBuilder getRequestMetadataOrBuilder()
Metadata about the operation.
.google.cloud.audit.RequestMetadata request_metadata = 4;
getRequestOrBuilder()
public StructOrBuilder getRequestOrBuilder()
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.
.google.protobuf.Struct request = 16;
getResourceLocation()
public ResourceLocation getResourceLocation()
The resource location information.
.google.cloud.audit.ResourceLocation resource_location = 20;
getResourceLocationOrBuilder()
public ResourceLocationOrBuilder getResourceLocationOrBuilder()
The resource location information.
.google.cloud.audit.ResourceLocation resource_location = 20;
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"
string resource_name = 11;
| Type | Description |
| String | The resourceName.
|
getResourceNameBytes()
public ByteString getResourceNameBytes()
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"
string resource_name = 11;
| Type | Description |
| ByteString | The bytes for resourceName.
|
getResourceOriginalState()
public Struct 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.
.google.protobuf.Struct resource_original_state = 19;
| Type | Description |
| Struct | The resourceOriginalState.
|
getResourceOriginalStateOrBuilder()
public StructOrBuilder getResourceOriginalStateOrBuilder()
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.
.google.protobuf.Struct resource_original_state = 19;
getResponse()
public Struct 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.
.google.protobuf.Struct response = 17;
| Type | Description |
| Struct | The response.
|
getResponseOrBuilder()
public StructOrBuilder getResponseOrBuilder()
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.
.google.protobuf.Struct response = 17;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getServiceData() (deprecated)
public Any getServiceData()
Deprecated. google.cloud.audit.AuditLog.service_data is deprecated. See
google/cloud/audit/audit_log.proto;l=110
Deprecated. Use the metadata field instead.
Other service-specific data about the request, response, and other
activities.
.google.protobuf.Any service_data = 15 [deprecated = true];
| Type | Description |
| Any | The serviceData.
|
getServiceDataOrBuilder()
public AnyOrBuilder getServiceDataOrBuilder()
Deprecated. Use the metadata field instead.
Other service-specific data about the request, response, and other
activities.
.google.protobuf.Any service_data = 15 [deprecated = true];
getServiceName()
public String getServiceName()
The name of the API service performing the operation. For example,
"compute.googleapis.com".
string service_name = 7;
| Type | Description |
| String | The serviceName.
|
getServiceNameBytes()
public ByteString getServiceNameBytes()
The name of the API service performing the operation. For example,
"compute.googleapis.com".
string service_name = 7;
| Type | Description |
| ByteString | The bytes for serviceName.
|
getStatus()
public Status getStatus()
The status of the overall operation.
.google.rpc.Status status = 2;
| Type | Description |
| Status | The status.
|
getStatusOrBuilder()
public StatusOrBuilder getStatusOrBuilder()
The status of the overall operation.
.google.rpc.Status status = 2;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasAuthenticationInfo()
public boolean hasAuthenticationInfo()
Authentication information.
.google.cloud.audit.AuthenticationInfo authentication_info = 3;
| Type | Description |
| boolean | Whether the authenticationInfo field is set.
|
public boolean hasMetadata()
Other service-specific data about the request, response, and other
information associated with the current audited event.
.google.protobuf.Struct metadata = 18;
| Type | Description |
| boolean | Whether the metadata field is set.
|
hasPolicyViolationInfo()
public boolean hasPolicyViolationInfo()
Indicates the policy violations for this request. If the request
is denied by the policy, violation information will be logged
here.
.google.cloud.audit.PolicyViolationInfo policy_violation_info = 25;
| Type | Description |
| boolean | Whether the policyViolationInfo field is set.
|
hasRequest()
public boolean hasRequest()
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.
.google.protobuf.Struct request = 16;
| Type | Description |
| boolean | Whether the request field is set.
|
public boolean hasRequestMetadata()
Metadata about the operation.
.google.cloud.audit.RequestMetadata request_metadata = 4;
| Type | Description |
| boolean | Whether the requestMetadata field is set.
|
hasResourceLocation()
public boolean hasResourceLocation()
The resource location information.
.google.cloud.audit.ResourceLocation resource_location = 20;
| Type | Description |
| boolean | Whether the resourceLocation field is set.
|
hasResourceOriginalState()
public boolean hasResourceOriginalState()
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.
.google.protobuf.Struct resource_original_state = 19;
| Type | Description |
| boolean | Whether the resourceOriginalState field is set.
|
hasResponse()
public boolean hasResponse()
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.
.google.protobuf.Struct response = 17;
| Type | Description |
| boolean | Whether the response field is set.
|
hasServiceData() (deprecated)
public boolean hasServiceData()
Deprecated. google.cloud.audit.AuditLog.service_data is deprecated. See
google/cloud/audit/audit_log.proto;l=110
Deprecated. Use the metadata field instead.
Other service-specific data about the request, response, and other
activities.
.google.protobuf.Any service_data = 15 [deprecated = true];
| Type | Description |
| boolean | Whether the serviceData field is set.
|
hasStatus()
public boolean hasStatus()
The status of the overall operation.
.google.rpc.Status status = 2;
| Type | Description |
| boolean | Whether the status field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AuditLog.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AuditLog.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AuditLog.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
