AuditLog class

Common audit log format for Google Cloud Platform API operations. Copied from https://github.com/googleapis/googleapis/blob/master/google/cloud/audit/audit_log.proto, but changing service_data from Any to Struct.

Inheritance

• Object
• GeneratedMessage
• AuditLog

Constructors

AuditLog({Status? status, AuthenticationInfo? authenticationInfo, RequestMetadata? requestMetadata, String? serviceName, String? methodName, Iterable<AuthorizationInfo>? authorizationInfo, String? resourceName, Int64? numResponseItems, Struct? serviceData, Struct? request, Struct? response, Struct? metadata, Struct? resourceOriginalState, ResourceLocation? resourceLocation})

factory

AuditLog.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

AuditLog.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Properties

authenticationInfo ↔ AuthenticationInfo

Authentication information.

getter/setter pair

authorizationInfo → List<AuthorizationInfo>

Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission} tuple.

no setter

eventPlugin → EventPlugin?

Subclasses can override this getter to be notified of changes to protobuf fields.

no setter, inherited

hashCode → int

Calculates a hash code based on the contents of the protobuf.

no setter, inherited

info_ → BuilderInfo

no setter, override

isFrozen → bool

Returns true if this message is marked read-only. Otherwise false.

no setter, inherited

metadata ↔ Struct

Other service-specific data about the request, response, and other information associated with the current audited event.

getter/setter pair

methodName ↔ String

The name of the service method or operation. For API calls, this should be the name of the API method. For example,

getter/setter pair

numResponseItems ↔ Int64

The number of items returned from a List or Query API method, if applicable.

getter/setter pair

request ↔ Struct

The operation request. This may not include all request parameters, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the @type property.

getter/setter pair

requestMetadata ↔ RequestMetadata

Metadata about the operation.

getter/setter pair

resourceLocation ↔ ResourceLocation

The resource location information.

getter/setter pair

resourceName ↔ String

The resource or collection that is the target of the operation. The name is a scheme-less URI, not including the API service name. For example:

getter/setter pair

resourceOriginalState ↔ Struct

The resource's original state before mutation. Present only for operations which have successfully modified the targeted resource(s). In general, this field should contain all changed fields, except those that are already been included in request, response, metadata or service_data fields. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the @type property.

getter/setter pair

response ↔ Struct

The operation response. This may not include all response elements, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the @type property.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serviceData ↔ Struct

Deprecated: Use metadata field instead. Other service-specific data about the request, response, and other activities. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the @type property.

getter/setter pair

serviceName ↔ String

The name of the API service performing the operation. For example, "datastore.googleapis.com".

getter/setter pair

status ↔ Status

The status of the overall operation.

getter/setter pair

unknownFields → UnknownFieldSet

no setter, inherited

Methods

addExtension(Extension extension, Object? value) → void

Adds an extension field value to a repeated field.

inherited

check() → void

inherited

clear() → void

Clears all data that was set in this message.

inherited

clearAuthenticationInfo() → void

clearExtension(Extension extension) → void

Clears an extension field and also removes the extension.

inherited

clearField(int tagNumber) → void

Clears the contents of a given field.

inherited

clearMetadata() → void

clearMethodName() → void

clearNumResponseItems() → void

clearRequest() → void

clearRequestMetadata() → void

clearResourceLocation() → void

clearResourceName() → void

clearResourceOriginalState() → void

clearResponse() → void

clearServiceData() → void

clearServiceName() → void

clearStatus() → void

clone() → AuditLog

Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)

override

copyWith(void updates(AuditLog)) → AuditLog

Apply updates to a copy of this message.

override

createEmptyInstance() → AuditLog

Creates an empty instance of the same message type as this.

override

createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>

Creates a Map representing a map field.

inherited

createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>

Creates List implementing a mutable repeated field.

inherited

ensureAuthenticationInfo() → AuthenticationInfo

ensureMetadata() → Struct

ensureRequest() → Struct

ensureRequestMetadata() → RequestMetadata

ensureResourceLocation() → ResourceLocation

ensureResourceOriginalState() → Struct

ensureResponse() → Struct

ensureServiceData() → Struct

ensureStatus() → Status

extensionsAreInitialized() → bool

inherited

freeze() → GeneratedMessage

Make this message read-only.

inherited

getDefaultForField(int tagNumber) → dynamic

Returns the default value for the given field.

inherited

getExtension(Extension extension) → dynamic

Returns the value of extension.

inherited

getField(int tagNumber) → dynamic

Returns the value of the field associated with tagNumber, or the default value if it is not set.

inherited

getFieldOrNull(int tagNumber) → dynamic

Returns the value of a field, ignoring any defaults.

inherited

getTagNumber(String fieldName) → int?

inherited

hasAuthenticationInfo() → bool

hasExtension(Extension extension) → bool

Returns true if a value of extension is present.

inherited

hasField(int tagNumber) → bool

Whether this message has a field associated with tagNumber.

inherited

hasMetadata() → bool

hasMethodName() → bool

hasNumResponseItems() → bool

hasRequest() → bool

hasRequestMetadata() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

hasResourceLocation() → bool

hasResourceName() → bool

hasResourceOriginalState() → bool

hasResponse() → bool

hasServiceData() → bool

hasServiceName() → bool

hasStatus() → bool

isInitialized() → bool

Whether all required fields in the message and embedded messages are set.

inherited

mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges serialized protocol buffer data into this message.

inherited

mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

inherited

mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.

inherited

mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from a JSON object represented as a Dart map.

inherited

mergeFromMessage(GeneratedMessage other) → void

Merges the contents of the other into this message.

inherited

mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void

Merges field values from json, a JSON object using proto3 encoding.

inherited

mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setExtension(Extension extension, Object value) → void

Sets the value of a non-repeated extension field to value.

inherited

setField(int tagNumber, Object value) → void

Sets the value of a field by its tagNumber.

inherited

toBuilder() → GeneratedMessage

Creates a writable, shallow copy of this message.

inherited

toDebugString() → String

Returns a String representation of this message.

inherited

toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?

Returns an Object representing Proto3 JSON serialization of this.

inherited

toString() → String

Returns a String representation of this message.

inherited

writeToBuffer() → Uint8List

inherited

writeToCodedBufferWriter(CodedBufferWriter output) → void

inherited

writeToJson() → String

Returns a JSON string that encodes this message.

inherited

writeToJsonMap() → Map<String, dynamic>

Returns the JSON encoding of this message as a Dart Map.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

create() → AuditLog

createRepeated() → PbList<AuditLog>

getDefault() → AuditLog