Class AuditConfig (1.7.0)

  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
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

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

getSerializedSize()

  public 
  
 int 
  
 getSerializedSize 
 () 
 
Returns
Type Description
int
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
Type Description
ByteString

The bytes for service.

getUnknownFields()

  public 
  
 final 
  
 UnknownFieldSet 
  
 getUnknownFields 
 () 
 
Returns
Type Description
UnknownFieldSet
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 
  
 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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

  public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 ) 
 
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException
Design a Mobile Site
View Site in Mobile | Classic
Share by: