Reference documentation and code samples for the Common Protos for Google Cloud APIs Client class AuditLog.
Common audit log format for Google Cloud Platform API operations.
Generated from protobuf message google.cloud.audit.AuditLog
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ service_name
string
The name of the API service performing the operation. For example, "compute.googleapis.com"
.
↳ method_name
string
The name of the service method or operation. For API calls, this should be the name of the API method. For example, "google.cloud.bigquery.v2.TableService.InsertTable" "google.logging.v2.ConfigServiceV2.CreateSink"
↳ resource_name
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: "projects/PROJECT_ID/zones/us-central1-a/instances" "projects/PROJECT_ID/datasets/DATASET_ID"
↳ resource_location
↳ resource_original_state
Google\Protobuf\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.
↳ num_response_items
int|string
The number of items returned from a List or Query API method, if applicable.
↳ status
↳ authentication_info
↳ authorization_info
array< Google\Cloud\Audit\AuthorizationInfo
>
Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission} tuple.
↳ request_metadata
↳ request
Google\Protobuf\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.
↳ response
Google\Protobuf\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.
↳ metadata
Google\Protobuf\Struct
Other service-specific data about the request, response, and other information associated with the current audited event.
↳ service_data
Google\Protobuf\Any
Deprecated. Use the metadata
field instead. Other service-specific data about the request, response, and other activities.
getServiceName
The name of the API service performing the operation. For example, "compute.googleapis.com"
.
string
setServiceName
The name of the API service performing the operation. For example, "compute.googleapis.com"
.
var
string
$this
getMethodName
The name of the service method or operation.
For API calls, this should be the name of the API method. For example, "google.cloud.bigquery.v2.TableService.InsertTable" "google.logging.v2.ConfigServiceV2.CreateSink"
string
setMethodName
The name of the service method or operation.
For API calls, this should be the name of the API method. For example, "google.cloud.bigquery.v2.TableService.InsertTable" "google.logging.v2.ConfigServiceV2.CreateSink"
var
string
$this
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: "projects/PROJECT_ID/zones/us-central1-a/instances" "projects/PROJECT_ID/datasets/DATASET_ID"
string
setResourceName
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: "projects/PROJECT_ID/zones/us-central1-a/instances" "projects/PROJECT_ID/datasets/DATASET_ID"
var
string
$this
getResourceLocation
The resource location information.
hasResourceLocation
clearResourceLocation
setResourceLocation
The resource location information.
$this
getResourceOriginalState
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.
hasResourceOriginalState
clearResourceOriginalState
setResourceOriginalState
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.
$this
getNumResponseItems
The number of items returned from a List or Query API method, if applicable.
int|string
setNumResponseItems
The number of items returned from a List or Query API method, if applicable.
var
int|string
$this
getStatus
The status of the overall operation.
hasStatus
clearStatus
setStatus
The status of the overall operation.
$this
getAuthenticationInfo
Authentication information.
hasAuthenticationInfo
clearAuthenticationInfo
setAuthenticationInfo
Authentication information.
$this
getAuthorizationInfo
Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission} tuple.
setAuthorizationInfo
Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission} tuple.
$this
getRequestMetadata
Metadata about the operation.
hasRequestMetadata
clearRequestMetadata
setRequestMetadata
Metadata about the operation.
$this
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.
hasRequest
clearRequest
setRequest
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.
$this
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.
hasResponse
clearResponse
setResponse
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.
$this
getMetadata
Other service-specific data about the request, response, and other information associated with the current audited event.
hasMetadata
clearMetadata
setMetadata
Other service-specific data about the request, response, and other information associated with the current audited event.
$this
getServiceData
Deprecated. Use the metadata
field instead.
Other service-specific data about the request, response, and other activities.
hasServiceData
clearServiceData
setServiceData
Deprecated. Use the metadata
field instead.
Other service-specific data about the request, response, and other activities.
$this
