Class AuditConfig.Builder (1.44.0)

public static final class AuditConfig.Builder extends GeneratedMessageV3.Builder<AuditConfig.Builder> 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&#64;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&#64;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

Inheritance

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

Implements

AuditConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllAuditLogConfigs(Iterable<? extends AuditLogConfig> values)

public AuditConfig.Builder addAllAuditLogConfigs(Iterable<? extends AuditLogConfig> values)

The configuration for logging of each type of permission.

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

Parameter
Name	Description
`values`	`Iterable<? extends com.google.iam.v1.AuditLogConfig>`

Returns
Type	Description
`AuditConfig.Builder`

addAuditLogConfigs(AuditLogConfig value)

public AuditConfig.Builder addAuditLogConfigs(AuditLogConfig value)

The configuration for logging of each type of permission.

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

Parameter
Name	Description
`value`	`AuditLogConfig`

Returns
Type	Description
`AuditConfig.Builder`

addAuditLogConfigs(AuditLogConfig.Builder builderForValue)

public AuditConfig.Builder addAuditLogConfigs(AuditLogConfig.Builder builderForValue)

The configuration for logging of each type of permission.

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

Parameter
Name	Description
`builderForValue`	`AuditLogConfig.Builder`

Returns
Type	Description
`AuditConfig.Builder`

addAuditLogConfigs(int index, AuditLogConfig value)

public AuditConfig.Builder addAuditLogConfigs(int index, AuditLogConfig value)

The configuration for logging of each type of permission.

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

Parameters
Name	Description
`index`	`int`
`value`	`AuditLogConfig`

Returns
Type	Description
`AuditConfig.Builder`

addAuditLogConfigs(int index, AuditLogConfig.Builder builderForValue)

public AuditConfig.Builder addAuditLogConfigs(int index, AuditLogConfig.Builder builderForValue)

The configuration for logging of each type of permission.

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`AuditLogConfig.Builder`

Returns
Type	Description
`AuditConfig.Builder`

addAuditLogConfigsBuilder()

public AuditLogConfig.Builder addAuditLogConfigsBuilder()

The configuration for logging of each type of permission.

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

Returns
Type	Description
`AuditLogConfig.Builder`

addAuditLogConfigsBuilder(int index)

public AuditLogConfig.Builder addAuditLogConfigsBuilder(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.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AuditConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`AuditConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public AuditConfig build()

Returns
Type	Description
`AuditConfig`

buildPartial()

public AuditConfig buildPartial()

Returns
Type	Description
`AuditConfig`

clear()

public AuditConfig.Builder clear()

Returns
Type	Description
`AuditConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAuditLogConfigs()

public AuditConfig.Builder clearAuditLogConfigs()

The configuration for logging of each type of permission.

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

Returns
Type	Description
`AuditConfig.Builder`

clearField(Descriptors.FieldDescriptor field)

public AuditConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`AuditConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public AuditConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`AuditConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearService()

public AuditConfig.Builder clearService()

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
`AuditConfig.Builder`	This builder for chaining.

clone()

public AuditConfig.Builder clone()

Returns
Type	Description
`AuditConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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`

getAuditLogConfigsBuilder(int index)

public AuditLogConfig.Builder getAuditLogConfigsBuilder(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.Builder`

getAuditLogConfigsBuilderList()

public List<AuditLogConfig.Builder> getAuditLogConfigsBuilderList()

The configuration for logging of each type of permission.

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

Returns
Type	Description
`List<Builder>`

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`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(AuditConfig other)

public AuditConfig.Builder mergeFrom(AuditConfig other)

Parameter
Name	Description
`other`	`AuditConfig`

Returns
Type	Description
`AuditConfig.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AuditConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`AuditConfig.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public AuditConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`AuditConfig.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AuditConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`AuditConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeAuditLogConfigs(int index)

public AuditConfig.Builder removeAuditLogConfigs(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
`AuditConfig.Builder`

setAuditLogConfigs(int index, AuditLogConfig value)

public AuditConfig.Builder setAuditLogConfigs(int index, AuditLogConfig value)

The configuration for logging of each type of permission.

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

Parameters
Name	Description
`index`	`int`
`value`	`AuditLogConfig`

Returns
Type	Description
`AuditConfig.Builder`

setAuditLogConfigs(int index, AuditLogConfig.Builder builderForValue)

public AuditConfig.Builder setAuditLogConfigs(int index, AuditLogConfig.Builder builderForValue)

The configuration for logging of each type of permission.

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`AuditLogConfig.Builder`

Returns
Type	Description
`AuditConfig.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public AuditConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`AuditConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AuditConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`AuditConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setService(String value)

public AuditConfig.Builder setService(String value)

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;

Parameter
Name	Description
`value`	`String` The service to set.

Returns
Type	Description
`AuditConfig.Builder`	This builder for chaining.

setServiceBytes(ByteString value)

public AuditConfig.Builder setServiceBytes(ByteString value)

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;

Parameter
Name	Description
`value`	`ByteString` The bytes for service to set.

Returns
Type	Description
`AuditConfig.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AuditConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`AuditConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)