/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/audit/audit_log.proto
// Protobuf Java Version: 3.25.3
package com.google.cloud.audit;
public interface AuditLogOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.audit.AuditLog)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The name of the API service performing the operation. For example,
* `"compute.googleapis.com"`.
*
*
* string service_name = 7;
*
* @return The serviceName.
*/
java.lang.String getServiceName();
/**
*
*
*
* The name of the API service performing the operation. For example,
* `"compute.googleapis.com"`.
*
*
* string service_name = 7;
*
* @return The bytes for serviceName.
*/
com.google.protobuf.ByteString getServiceNameBytes();
/**
*
*
*
* 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;
*
* @return The methodName.
*/
java.lang.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;
*
* @return The bytes for methodName.
*/
com.google.protobuf.ByteString getMethodNameBytes();
/**
*
*
*
* 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;
*
* @return The resourceName.
*/
java.lang.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;
*
* @return The bytes for resourceName.
*/
com.google.protobuf.ByteString getResourceNameBytes();
/**
*
*
*
* The resource location information.
*
*
* .google.cloud.audit.ResourceLocation resource_location = 20;
*
* @return Whether the resourceLocation field is set.
*/
boolean hasResourceLocation();
/**
*
*
*
* The resource location information.
*
*
* .google.cloud.audit.ResourceLocation resource_location = 20;
*
* @return The resourceLocation.
*/
com.google.cloud.audit.ResourceLocation getResourceLocation();
/**
*
*
*
* The resource location information.
*
*
* .google.cloud.audit.ResourceLocation resource_location = 20;
*/
com.google.cloud.audit.ResourceLocationOrBuilder getResourceLocationOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the resourceOriginalState field is set.
*/
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;
*
* @return The resourceOriginalState.
*/
com.google.protobuf.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;
*/
com.google.protobuf.StructOrBuilder getResourceOriginalStateOrBuilder();
/**
*
*
*
* The number of items returned from a List or Query API method,
* if applicable.
*
*
* int64 num_response_items = 12;
*
* @return The numResponseItems.
*/
long getNumResponseItems();
/**
*
*
*
* The status of the overall operation.
*
*
* .google.rpc.Status status = 2;
*
* @return Whether the status field is set.
*/
boolean hasStatus();
/**
*
*
*
* The status of the overall operation.
*
*
* .google.rpc.Status status = 2;
*
* @return The status.
*/
com.google.rpc.Status getStatus();
/**
*
*
*
* The status of the overall operation.
*
*
* .google.rpc.Status status = 2;
*/
com.google.rpc.StatusOrBuilder getStatusOrBuilder();
/**
*
*
*
* Authentication information.
*
*
* .google.cloud.audit.AuthenticationInfo authentication_info = 3;
*
* @return Whether the authenticationInfo field is set.
*/
boolean hasAuthenticationInfo();
/**
*
*
*
* Authentication information.
*
*
* .google.cloud.audit.AuthenticationInfo authentication_info = 3;
*
* @return The authenticationInfo.
*/
com.google.cloud.audit.AuthenticationInfo getAuthenticationInfo();
/**
*
*
*
* Authentication information.
*
*
* .google.cloud.audit.AuthenticationInfo authentication_info = 3;
*/
com.google.cloud.audit.AuthenticationInfoOrBuilder getAuthenticationInfoOrBuilder();
/**
*
*
*
* 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;
*/
java.util.List 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;
*/
com.google.cloud.audit.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;
*/
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;
*/
java.util.List
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;
*/
com.google.cloud.audit.AuthorizationInfoOrBuilder getAuthorizationInfoOrBuilder(int index);
/**
*
*
*
* 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;
*
* @return Whether the policyViolationInfo field is set.
*/
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;
*
* @return The policyViolationInfo.
*/
com.google.cloud.audit.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;
*/
com.google.cloud.audit.PolicyViolationInfoOrBuilder getPolicyViolationInfoOrBuilder();
/**
*
*
*
* Metadata about the operation.
*
*
* .google.cloud.audit.RequestMetadata request_metadata = 4;
*
* @return Whether the requestMetadata field is set.
*/
boolean hasRequestMetadata();
/**
*
*
*
* Metadata about the operation.
*
*
* .google.cloud.audit.RequestMetadata request_metadata = 4;
*
* @return The requestMetadata.
*/
com.google.cloud.audit.RequestMetadata getRequestMetadata();
/**
*
*
*
* Metadata about the operation.
*
*
* .google.cloud.audit.RequestMetadata request_metadata = 4;
*/
com.google.cloud.audit.RequestMetadataOrBuilder getRequestMetadataOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the request field is set.
*/
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;
*
* @return The request.
*/
com.google.protobuf.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;
*/
com.google.protobuf.StructOrBuilder getRequestOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the response field is set.
*/
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;
*
* @return The response.
*/
com.google.protobuf.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;
*/
com.google.protobuf.StructOrBuilder getResponseOrBuilder();
/**
*
*
*
* Other service-specific data about the request, response, and other
* information associated with the current audited event.
*
*
* .google.protobuf.Struct metadata = 18;
*
* @return Whether the metadata field is set.
*/
boolean hasMetadata();
/**
*
*
*
* Other service-specific data about the request, response, and other
* information associated with the current audited event.
*
*
* .google.protobuf.Struct metadata = 18;
*
* @return The metadata.
*/
com.google.protobuf.Struct getMetadata();
/**
*
*
*
* Other service-specific data about the request, response, and other
* information associated with the current audited event.
*
*
* .google.protobuf.Struct metadata = 18;
*/
com.google.protobuf.StructOrBuilder getMetadataOrBuilder();
/**
*
*
*
* 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];
*
* @deprecated google.cloud.audit.AuditLog.service_data is deprecated. See
* google/cloud/audit/audit_log.proto;l=110
* @return Whether the serviceData field is set.
*/
@java.lang.Deprecated
boolean hasServiceData();
/**
*
*
*
* 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];
*
* @deprecated google.cloud.audit.AuditLog.service_data is deprecated. See
* google/cloud/audit/audit_log.proto;l=110
* @return The serviceData.
*/
@java.lang.Deprecated
com.google.protobuf.Any getServiceData();
/**
*
*
*
* 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];
*/
@java.lang.Deprecated
com.google.protobuf.AnyOrBuilder getServiceDataOrBuilder();
}
