class AuditLog extends Message

Common audit log format for Google Cloud Platform API operations.

Protobuf type Google\Cloud\Audit\AuditLog

Methods

__construct()

No description

string
getServiceName()

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

setServiceName(string $var)

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

string
getMethodName()

The name of the service method or operation.

setMethodName(string $var)

The name of the service method or operation.

string
getResourceName()

The resource or collection that is the target of the operation.

setResourceName(string $var)

The resource or collection that is the target of the operation.

int|string
getNumResponseItems()

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

setNumResponseItems(int|string $var)

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

getStatus()

The status of the overall operation.

setStatus(Status $var)

The status of the overall operation.

getAuthenticationInfo()

Authentication information.

setAuthenticationInfo(AuthenticationInfo $var)

Authentication information.

RepeatedField
getAuthorizationInfo()

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

setAuthorizationInfo(array|RepeatedField $var)

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

getRequestMetadata()

Metadata about the operation.

setRequestMetadata(RequestMetadata $var)

Metadata about the operation.

getRequest()

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.

setRequest(Struct $var)

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.

getResponse()

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.

setResponse(Struct $var)

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.

Any
getServiceData()

Other service-specific data about the request, response, and other activities.

setServiceData(Any $var)

Other service-specific data about the request, response, and other activities.

Details

at line 108
__construct()

at line 120
string getServiceName()

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

Generated from protobuf field string service_name = 7;

Return Value

string

at line 132
setServiceName(string $var)

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

Generated from protobuf field string service_name = 7;

Parameters

string $var

at line 148
string getMethodName()

The name of the service method or operation.

For API calls, this should be the name of the API method. For example, "google.datastore.v1.Datastore.RunQuery" "google.logging.v1.LoggingService.DeleteLog"

Generated from protobuf field string method_name = 8;

Return Value

string

at line 163
setMethodName(string $var)

The name of the service method or operation.

For API calls, this should be the name of the API method. For example, "google.datastore.v1.Datastore.RunQuery" "google.logging.v1.LoggingService.DeleteLog"

Generated from protobuf field string method_name = 8;

Parameters

string $var

at line 179
string getResourceName()

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: "shelves/SHELF_ID/books" "shelves/SHELF_ID/books/BOOK_ID"

Generated from protobuf field string resource_name = 11;

Return Value

string

at line 194
setResourceName(string $var)

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: "shelves/SHELF_ID/books" "shelves/SHELF_ID/books/BOOK_ID"

Generated from protobuf field string resource_name = 11;

Parameters

string $var

at line 207
int|string getNumResponseItems()

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

Generated from protobuf field int64 num_response_items = 12;

Return Value

int|string

at line 219
setNumResponseItems(int|string $var)

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

Generated from protobuf field int64 num_response_items = 12;

Parameters

int|string $var

at line 231
Status getStatus()

The status of the overall operation.

Generated from protobuf field .google.rpc.Status status = 2;

Return Value

Status

at line 242
setStatus(Status $var)

The status of the overall operation.

Generated from protobuf field .google.rpc.Status status = 2;

Parameters

Status $var

at line 254
AuthenticationInfo getAuthenticationInfo()

Authentication information.

Generated from protobuf field .google.cloud.audit.AuthenticationInfo authentication_info = 3;

Return Value

AuthenticationInfo

at line 265
setAuthenticationInfo(AuthenticationInfo $var)

Authentication information.

Generated from protobuf field .google.cloud.audit.AuthenticationInfo authentication_info = 3;

Parameters

AuthenticationInfo $var

at line 279
RepeatedField getAuthorizationInfo()

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

Generated from protobuf field repeated .google.cloud.audit.AuthorizationInfo authorization_info = 9;

Return Value

RepeatedField

at line 292
setAuthorizationInfo(array|RepeatedField $var)

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

Generated from protobuf field repeated .google.cloud.audit.AuthorizationInfo authorization_info = 9;

Parameters

array|RepeatedField $var

at line 304
RequestMetadata getRequestMetadata()

Metadata about the operation.

Generated from protobuf field .google.cloud.audit.RequestMetadata request_metadata = 4;

Return Value

RequestMetadata

at line 315
setRequestMetadata(RequestMetadata $var)

Metadata about the operation.

Generated from protobuf field .google.cloud.audit.RequestMetadata request_metadata = 4;

Parameters

RequestMetadata $var

at line 332
Struct getRequest()

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.

Generated from protobuf field .google.protobuf.Struct request = 16;

Return Value

Struct

at line 348
setRequest(Struct $var)

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.

Generated from protobuf field .google.protobuf.Struct request = 16;

Parameters

Struct $var

at line 365
Struct getResponse()

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.

Generated from protobuf field .google.protobuf.Struct response = 17;

Return Value

Struct

at line 381
setResponse(Struct $var)

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.

Generated from protobuf field .google.protobuf.Struct response = 17;

Parameters

Struct $var

at line 394
Any getServiceData()

Other service-specific data about the request, response, and other activities.

Generated from protobuf field .google.protobuf.Any service_data = 15;

Return Value

Any

at line 406
setServiceData(Any $var)

Other service-specific data about the request, response, and other activities.

Generated from protobuf field .google.protobuf.Any service_data = 15;

Parameters

Any $var