Interface AuditLogOrBuilder (2.43.0)

public interface AuditLogOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAuthenticationInfo()

public abstract AuthenticationInfo getAuthenticationInfo()

Authentication information.

.google.cloud.audit.AuthenticationInfo authentication_info = 3;

Returns
Type Description
AuthenticationInfo

The authenticationInfo.

getAuthenticationInfoOrBuilder()

public abstract AuthenticationInfoOrBuilder getAuthenticationInfoOrBuilder()

Authentication information.

.google.cloud.audit.AuthenticationInfo authentication_info = 3;

Returns
Type Description
AuthenticationInfoOrBuilder

getAuthorizationInfo(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
AuthorizationInfo

getAuthorizationInfoCount()

public abstract 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;

Returns
Type Description
int

getAuthorizationInfoList()

public abstract 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;

Returns
Type Description
List<AuthorizationInfo>

getAuthorizationInfoOrBuilder(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
AuthorizationInfoOrBuilder

getAuthorizationInfoOrBuilderList()

public abstract 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;

Returns
Type Description
List<? extends com.google.cloud.audit.AuthorizationInfoOrBuilder>

getMetadata()

public abstract Struct getMetadata()

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

.google.protobuf.Struct metadata = 18;

Returns
Type Description
Struct

The metadata.

getMetadataOrBuilder()

public abstract StructOrBuilder getMetadataOrBuilder()

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

.google.protobuf.Struct metadata = 18;

Returns
Type Description
StructOrBuilder

getMethodName()

public abstract 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;

Returns
Type Description
String

The methodName.

getMethodNameBytes()

public abstract 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;

Returns
Type Description
ByteString

The bytes for methodName.

getNumResponseItems()

public abstract long getNumResponseItems()

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

int64 num_response_items = 12;

Returns
Type Description
long

The numResponseItems.

getPolicyViolationInfo()

public abstract 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;

Returns
Type Description
PolicyViolationInfo

The policyViolationInfo.

getPolicyViolationInfoOrBuilder()

public abstract 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;

Returns
Type Description
PolicyViolationInfoOrBuilder

getRequest()

public abstract 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;

Returns
Type Description
Struct

The request.

getRequestMetadata()

public abstract RequestMetadata getRequestMetadata()

Metadata about the operation.

.google.cloud.audit.RequestMetadata request_metadata = 4;

Returns
Type Description
RequestMetadata

The requestMetadata.

getRequestMetadataOrBuilder()

public abstract RequestMetadataOrBuilder getRequestMetadataOrBuilder()

Metadata about the operation.

.google.cloud.audit.RequestMetadata request_metadata = 4;

Returns
Type Description
RequestMetadataOrBuilder

getRequestOrBuilder()

public abstract 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;

Returns
Type Description
StructOrBuilder

getResourceLocation()

public abstract ResourceLocation getResourceLocation()

The resource location information.

.google.cloud.audit.ResourceLocation resource_location = 20;

Returns
Type Description
ResourceLocation

The resourceLocation.

getResourceLocationOrBuilder()

public abstract ResourceLocationOrBuilder getResourceLocationOrBuilder()

The resource location information.

.google.cloud.audit.ResourceLocation resource_location = 20;

Returns
Type Description
ResourceLocationOrBuilder

getResourceName()

public abstract 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;

Returns
Type Description
String

The resourceName.

getResourceNameBytes()

public abstract 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;

Returns
Type Description
ByteString

The bytes for resourceName.

getResourceOriginalState()

public abstract 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;

Returns
Type Description
Struct

The resourceOriginalState.

getResourceOriginalStateOrBuilder()

public abstract 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;

Returns
Type Description
StructOrBuilder

getResponse()

public abstract 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;

Returns
Type Description
Struct

The response.

getResponseOrBuilder()

public abstract 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;

Returns
Type Description
StructOrBuilder

getServiceData() (deprecated)

public abstract 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];

Returns
Type Description
Any

The serviceData.

getServiceDataOrBuilder() (deprecated)

public abstract 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];

Returns
Type Description
AnyOrBuilder

getServiceName()

public abstract String getServiceName()

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

string service_name = 7;

Returns
Type Description
String

The serviceName.

getServiceNameBytes()

public abstract ByteString getServiceNameBytes()

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

string service_name = 7;

Returns
Type Description
ByteString

The bytes for serviceName.

getStatus()

public abstract Status getStatus()

The status of the overall operation.

.google.rpc.Status status = 2;

Returns
Type Description
Status

The status.

getStatusOrBuilder()

public abstract StatusOrBuilder getStatusOrBuilder()

The status of the overall operation.

.google.rpc.Status status = 2;

Returns
Type Description
StatusOrBuilder

hasAuthenticationInfo()

public abstract boolean hasAuthenticationInfo()

Authentication information.

.google.cloud.audit.AuthenticationInfo authentication_info = 3;

Returns
Type Description
boolean

Whether the authenticationInfo field is set.

hasMetadata()

public abstract boolean hasMetadata()

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

.google.protobuf.Struct metadata = 18;

Returns
Type Description
boolean

Whether the metadata field is set.

hasPolicyViolationInfo()

public abstract 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;

Returns
Type Description
boolean

Whether the policyViolationInfo field is set.

hasRequest()

public abstract 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;

Returns
Type Description
boolean

Whether the request field is set.

hasRequestMetadata()

public abstract boolean hasRequestMetadata()

Metadata about the operation.

.google.cloud.audit.RequestMetadata request_metadata = 4;

Returns
Type Description
boolean

Whether the requestMetadata field is set.

hasResourceLocation()

public abstract boolean hasResourceLocation()

The resource location information.

.google.cloud.audit.ResourceLocation resource_location = 20;

Returns
Type Description
boolean

Whether the resourceLocation field is set.

hasResourceOriginalState()

public abstract 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;

Returns
Type Description
boolean

Whether the resourceOriginalState field is set.

hasResponse()

public abstract 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;

Returns
Type Description
boolean

Whether the response field is set.

hasServiceData() (deprecated)

public abstract 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];

Returns
Type Description
boolean

Whether the serviceData field is set.

hasStatus()

public abstract boolean hasStatus()

The status of the overall operation.

.google.rpc.Status status = 2;

Returns
Type Description
boolean

Whether the status field is set.