public final class AuditConfig extends GeneratedMessageV3 implements AuditConfigOrBuilder
Specifies the audit configuration for a service.
The configuration determines which permission types are logged, and what
identities, if any, are exempted from logging.
An AuditConfig must have one or more AuditLogConfigs.
If there are AuditConfigs for both allServices
and a specific service,
the union of the two AuditConfigs is used for that service: the log_types
specified in each AuditConfig are enabled, and the exempted_members in each
AuditLogConfig are exempted.
Example Policy with multiple AuditConfigs:
{
"audit_configs": [
{
"service": "allServices",
"audit_log_configs": [
{
"log_type": "DATA_READ",
"exempted_members": [
"user:jose@example.com"
]
},
{
"log_type": "DATA_WRITE"
},
{
"log_type": "ADMIN_READ"
}
]
},
{
"service": "sampleservice.googleapis.com",
"audit_log_configs": [
{
"log_type": "DATA_READ"
},
{
"log_type": "DATA_WRITE",
"exempted_members": [
"user:aliya@example.com"
]
}
]
}
]
}
For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
logging. It also exempts jose@example.com from DATA_READ logging, and
aliya@example.com from DATA_WRITE logging.
Protobuf type google.iam.v1.AuditConfig
Static Fields
AUDIT_LOG_CONFIGS_FIELD_NUMBER
public static final int AUDIT_LOG_CONFIGS_FIELD_NUMBER
Field Value
SERVICE_FIELD_NUMBER
public static final int SERVICE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AuditConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AuditConfig.Builder newBuilder()
Returns
newBuilder(AuditConfig prototype)
public static AuditConfig.Builder newBuilder(AuditConfig prototype)
Parameter
Returns
public static AuditConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AuditConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AuditConfig parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AuditConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AuditConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AuditConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AuditConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AuditConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AuditConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AuditConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AuditConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AuditConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AuditConfig> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAuditLogConfigs(int index)
public AuditLogConfig getAuditLogConfigs(int index)
The configuration for logging of each type of permission.
repeated .google.iam.v1.AuditLogConfig audit_log_configs = 3;
Parameter
Returns
getAuditLogConfigsCount()
public int getAuditLogConfigsCount()
The configuration for logging of each type of permission.
repeated .google.iam.v1.AuditLogConfig audit_log_configs = 3;
Returns
getAuditLogConfigsList()
public List<AuditLogConfig> getAuditLogConfigsList()
The configuration for logging of each type of permission.
repeated .google.iam.v1.AuditLogConfig audit_log_configs = 3;
Returns
getAuditLogConfigsOrBuilder(int index)
public AuditLogConfigOrBuilder getAuditLogConfigsOrBuilder(int index)
The configuration for logging of each type of permission.
repeated .google.iam.v1.AuditLogConfig audit_log_configs = 3;
Parameter
Returns
getAuditLogConfigsOrBuilderList()
public List<? extends AuditLogConfigOrBuilder> getAuditLogConfigsOrBuilderList()
The configuration for logging of each type of permission.
repeated .google.iam.v1.AuditLogConfig audit_log_configs = 3;
Returns
Type | Description |
List<? extends com.google.iam.v1.AuditLogConfigOrBuilder> | |
getDefaultInstanceForType()
public AuditConfig getDefaultInstanceForType()
Returns
getParserForType()
public Parser<AuditConfig> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getService()
public String getService()
Specifies a service that will be enabled for audit logging.
For example, storage.googleapis.com
, cloudsql.googleapis.com
.
allServices
is a special value that covers all services.
string service = 1;
Returns
Type | Description |
String | The service.
|
getServiceBytes()
public ByteString getServiceBytes()
Specifies a service that will be enabled for audit logging.
For example, storage.googleapis.com
, cloudsql.googleapis.com
.
allServices
is a special value that covers all services.
string service = 1;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AuditConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AuditConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AuditConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions