Class AuditLogConfig (1.34.0)

public final class AuditLogConfig extends GeneratedMessageV3 implements AuditLogConfigOrBuilder

Provides the configuration for logging a type of permissions. Example:

 {
   "audit_log_configs": [
     {
       "log_type": "DATA_READ",
       "exempted_members": [
         "user:jose@example.com"
       ]
     },
     {
       "log_type": "DATA_WRITE"
     }
   ]
 }

This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Protobuf type google.iam.v1.AuditLogConfig

Static Fields

EXEMPTED_MEMBERS_FIELD_NUMBER

public static final int EXEMPTED_MEMBERS_FIELD_NUMBER
Field Value
Type Description
int

LOG_TYPE_FIELD_NUMBER

public static final int LOG_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AuditLogConfig getDefaultInstance()
Returns
Type Description
AuditLogConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AuditLogConfig.Builder newBuilder()
Returns
Type Description
AuditLogConfig.Builder

newBuilder(AuditLogConfig prototype)

public static AuditLogConfig.Builder newBuilder(AuditLogConfig prototype)
Parameter
Name Description
prototype AuditLogConfig
Returns
Type Description
AuditLogConfig.Builder

parseDelimitedFrom(InputStream input)

public static AuditLogConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AuditLogConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuditLogConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuditLogConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AuditLogConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AuditLogConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AuditLogConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuditLogConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AuditLogConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AuditLogConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AuditLogConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuditLogConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AuditLogConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AuditLogConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AuditLogConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuditLogConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AuditLogConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AuditLogConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AuditLogConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuditLogConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AuditLogConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AuditLogConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AuditLogConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AuditLogConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AuditLogConfig> parser()
Returns
Type Description
Parser<AuditLogConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public AuditLogConfig getDefaultInstanceForType()
Returns
Type Description
AuditLogConfig

getExemptedMembers(int index)

public String getExemptedMembers(int index)

Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

repeated string exempted_members = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The exemptedMembers at the given index.

getExemptedMembersBytes(int index)

public ByteString getExemptedMembersBytes(int index)

Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

repeated string exempted_members = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the exemptedMembers at the given index.

getExemptedMembersCount()

public int getExemptedMembersCount()

Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

repeated string exempted_members = 2;

Returns
Type Description
int

The count of exemptedMembers.

getExemptedMembersList()

public ProtocolStringList getExemptedMembersList()

Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

repeated string exempted_members = 2;

Returns
Type Description
ProtocolStringList

A list containing the exemptedMembers.

getLogType()

public AuditLogConfig.LogType getLogType()

The log type that this config enables.

.google.iam.v1.AuditLogConfig.LogType log_type = 1;

Returns
Type Description
AuditLogConfig.LogType

The logType.

getLogTypeValue()

public int getLogTypeValue()

The log type that this config enables.

.google.iam.v1.AuditLogConfig.LogType log_type = 1;

Returns
Type Description
int

The enum numeric value on the wire for logType.

getParserForType()

public Parser<AuditLogConfig> getParserForType()
Returns
Type Description
Parser<AuditLogConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AuditLogConfig.Builder newBuilderForType()
Returns
Type Description
AuditLogConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AuditLogConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AuditLogConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AuditLogConfig.Builder toBuilder()
Returns
Type Description
AuditLogConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException