PHPFUI/InstaDoc

AuditContext provides information that is needed for audit logging.

Generated from protobuf message google.rpc.context.AuditContext

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Public
Protected

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type string $audit_log
      Serialized audit log.
@type \Google\Protobuf\Struct $scrubbed_request
      An API request message that is scrubbed based on the method annotation.
      This field should only be filled if audit_log field is present.
      Service Control will use this to assemble a complete log for Cloud Audit
      Logs and Google internal audit logs.
@type \Google\Protobuf\Struct $scrubbed_response
      An API response message that is scrubbed based on the method annotation.
      This field should only be filled if audit_log field is present.
      Service Control will use this to assemble a complete log for Cloud Audit
      Logs and Google internal audit logs.
@type int $scrubbed_response_item_count
      Number of scrubbed response items.
@type string $target_resource
      Audit resource name which is scrubbed.

}

public Google\Protobuf\Internal\Message::__debugInfo()

public Google\Protobuf\Internal\Message::byteSize()

ignore

public Google\Protobuf\Internal\Message::clear()

Clear all containing fields.

return null

public clearScrubbedRequest()

public clearScrubbedResponse()

public Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getAuditLog()

Serialized audit log.

Generated from protobuf field bytes audit_log = 1;

return string

public getScrubbedRequest()

An API request message that is scrubbed based on the method annotation.

This field should only be filled if audit_log field is present. Service Control will use this to assemble a complete log for Cloud Audit Logs and Google internal audit logs.

Generated from protobuf field .google.protobuf.Struct scrubbed_request = 2;

return \Google\Protobuf\Struct|null

public getScrubbedResponse()

An API response message that is scrubbed based on the method annotation.

This field should only be filled if audit_log field is present. Service Control will use this to assemble a complete log for Cloud Audit Logs and Google internal audit logs.

Generated from protobuf field .google.protobuf.Struct scrubbed_response = 3;

return \Google\Protobuf\Struct|null

public getScrubbedResponseItemCount()

Number of scrubbed response items.

Generated from protobuf field int32 scrubbed_response_item_count = 4;

return int

public getTargetResource()

Audit resource name which is scrubbed.

Generated from protobuf field string target_resource = 5;

return string

public hasScrubbedRequest()

public hasScrubbedResponse()

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $data)

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

public Google\Protobuf\Internal\Message::parseFromStream( $input)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

Serialize the message to json string.

return string Serialized json protobuf data.

public Google\Protobuf\Internal\Message::serializeToStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToString()

Serialize the message to string.

return string Serialized binary protobuf data.

public setAuditLog( $var)

Serialized audit log.

Generated from protobuf field bytes audit_log = 1;

param string $var
return $this

public setScrubbedRequest( $var)

An API request message that is scrubbed based on the method annotation.

This field should only be filled if audit_log field is present. Service Control will use this to assemble a complete log for Cloud Audit Logs and Google internal audit logs.

Generated from protobuf field .google.protobuf.Struct scrubbed_request = 2;

param \Google\Protobuf\Struct $var
return $this

public setScrubbedResponse( $var)

An API response message that is scrubbed based on the method annotation.

This field should only be filled if audit_log field is present. Service Control will use this to assemble a complete log for Cloud Audit Logs and Google internal audit logs.

Generated from protobuf field .google.protobuf.Struct scrubbed_response = 3;

param \Google\Protobuf\Struct $var
return $this

public setScrubbedResponseItemCount( $var)

Number of scrubbed response items.

Generated from protobuf field int32 scrubbed_response_item_count = 4;

param int $var
return $this

public setTargetResource( $var)

Audit resource name which is scrubbed.

Generated from protobuf field string target_resource = 5;

param string $var
return $this

Properties

protected $audit_log = ''

Serialized audit log.

Generated from protobuf field bytes audit_log = 1;

protected $scrubbed_request = NULL

An API request message that is scrubbed based on the method annotation.

This field should only be filled if audit_log field is present. Service Control will use this to assemble a complete log for Cloud Audit Logs and Google internal audit logs.

Generated from protobuf field .google.protobuf.Struct scrubbed_request = 2;

protected $scrubbed_response = NULL

An API response message that is scrubbed based on the method annotation.

This field should only be filled if audit_log field is present. Service Control will use this to assemble a complete log for Cloud Audit Logs and Google internal audit logs.

Generated from protobuf field .google.protobuf.Struct scrubbed_response = 3;

protected $scrubbed_response_item_count = 0

Number of scrubbed response items.

Generated from protobuf field int32 scrubbed_response_item_count = 4;

protected $target_resource = ''

Audit resource name which is scrubbed.

Generated from protobuf field string target_resource = 5;

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

protected Google\Protobuf\Internal\Message::readOneof( $number)

protected Google\Protobuf\Internal\Message::readWrapperValue( $member)

protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)

protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)

protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)