Class AuditConfig (1.17.1)

Version 1.17.1

• 1.45.0 (latest)
• 1.44.0
• 1.43.0
• 1.41.0
• 1.40.1
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.1
• 1.33.0
• 1.32.1
• 1.31.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.0
• 1.18.1
• 1.17.1
• 1.16.1
• 1.10.0
• 1.9.3
• 1.8.0
• 1.7.0
• 1.6.23
• 1.5.1
• 1.4.1
• 1.3.4
• 1.2.12

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 [e-mail] from DATA_READ logging, and [e-mail] from DATA_WRITE logging.

Protobuf type google.iam.v1.AuditConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AuditConfig

Implements

AuditConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AUDIT_LOG_CONFIGS_FIELD_NUMBER

public static final int AUDIT_LOG_CONFIGS_FIELD_NUMBER

Field Value
Type	Description
int

SERVICE_FIELD_NUMBER

public static final int SERVICE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static AuditConfig getDefaultInstance()

Returns
Type	Description
AuditConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static AuditConfig.Builder newBuilder()

Returns
Type	Description
AuditConfig.Builder

newBuilder(AuditConfig prototype)

public static AuditConfig.Builder newBuilder(AuditConfig prototype)

Parameter
Name	Description
prototype	AuditConfig

Returns
Type	Description
AuditConfig.Builder

parseDelimitedFrom(InputStream input)

public static AuditConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AuditConfig

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuditConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuditConfig

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static AuditConfig parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
AuditConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AuditConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuditConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AuditConfig parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
AuditConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AuditConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuditConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AuditConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
AuditConfig

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AuditConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuditConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static AuditConfig parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AuditConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuditConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuditConfig

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static AuditConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
AuditConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AuditConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuditConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<AuditConfig> parser()

Returns
Type	Description
Parser<AuditConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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
Name	Description
index	int

Returns
Type	Description
AuditLogConfig

getAuditLogConfigsCount()

public int getAuditLogConfigsCount()

The configuration for logging of each type of permission.

repeated .google.iam.v1.AuditLogConfig audit_log_configs = 3;

Returns
Type	Description
int

getAuditLogConfigsList()

public List<AuditLogConfig> getAuditLogConfigsList()

The configuration for logging of each type of permission.

repeated .google.iam.v1.AuditLogConfig audit_log_configs = 3;

Returns
Type	Description
List<AuditLogConfig>

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
Name	Description
index	int

Returns
Type	Description
AuditLogConfigOrBuilder

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
Type	Description
AuditConfig

getParserForType()

public Parser<AuditConfig> getParserForType()

Returns
Type	Description
Parser<AuditConfig>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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
Type	Description
ByteString	The bytes for service.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public AuditConfig.Builder newBuilderForType()

Returns
Type	Description
AuditConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AuditConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
AuditConfig.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public AuditConfig.Builder toBuilder()

Returns
Type	Description
AuditConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException