Google\Cloud\Audit\AuditLog | Google ApiCore

class AuditLog extends Message

Common audit log format for Google Cloud Platform API operations.

Generated from protobuf message google.cloud.audit.AuditLog

Methods

__construct(array $data = NULL)

Constructor.

string

getServiceName()

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

$this

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.

$this

setMethodName(string $var)

The name of the service method or operation.

string

getResourceName()

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

$this

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.

$this

setNumResponseItems(int|string $var)

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

Status

getStatus()

The status of the overall operation.

$this

setStatus(Status $var)

The status of the overall operation.

AuthenticationInfo

getAuthenticationInfo()

Authentication information.

$this

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.

$this

setAuthorizationInfo(AuthorizationInfo[]|RepeatedField $var)

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

RequestMetadata

getRequestMetadata()

Metadata about the operation.

$this

setRequestMetadata(RequestMetadata $var)

Metadata about the operation.

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.

$this

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.

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.

$this

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.

$this

setServiceData(Any $var)

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

Details

at line 161
`__construct(array $data = NULL)`

Constructor.

Parameters

array

$data

{ Optional. Data for populating the Message object.

@type string $service_name
      The name of the API service performing the operation. For example,
      `"datastore.googleapis.com"`.
@type string $method_name
      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"
@type string $resource_name
      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"
@type int|string $num_response_items
      The number of items returned from a List or Query API method,
      if applicable.
@type \Google\Rpc\Status $status
      The status of the overall operation.
@type \Google\Cloud\Audit\AuthenticationInfo $authentication_info
      Authentication information.
@type \Google\Cloud\Audit\AuthorizationInfo[]|\Google\Protobuf\Internal\RepeatedField $authorization_info
      Authorization information. If there are multiple
      resources or permissions involved, then there is
      one AuthorizationInfo element for each {resource, permission} tuple.
@type \Google\Cloud\Audit\RequestMetadata $request_metadata
      Metadata about the operation.
@type \Google\Protobuf\Struct $request
      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 `&#64;type` property.
@type \Google\Protobuf\Struct $response
      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 `&#64;type` property.
@type \Google\Protobuf\Any $service_data
      Other service-specific data about the request, response, and other
      activities.

}

at line 173
`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 186
`$this 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

Return Value

$this

at line 204
`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 220
`$this 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

Return Value

$this

at line 238
`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 254
`$this 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

Return Value

$this

at line 269
`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 282
`$this 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

Return Value

$this

at line 296
`Status getStatus()`

The status of the overall operation.

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

Return Value

Status

at line 308
`$this setStatus(Status $var)`

The status of the overall operation.

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

Parameters

Status

$var

Return Value

$this

at line 322
`AuthenticationInfo getAuthenticationInfo()`

Authentication information.

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

Return Value

AuthenticationInfo

at line 334
`$this setAuthenticationInfo(AuthenticationInfo $var)`

Authentication information.

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

Parameters

AuthenticationInfo

$var

Return Value

$this

at line 350
`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 364
`$this setAuthorizationInfo(AuthorizationInfo[]|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

AuthorizationInfo[]|RepeatedField

$var

Return Value

$this

at line 378
`RequestMetadata getRequestMetadata()`

Metadata about the operation.

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

Return Value

RequestMetadata

at line 390
`$this setRequestMetadata(RequestMetadata $var)`

Metadata about the operation.

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

Parameters

RequestMetadata

$var

Return Value

$this

at line 409
`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 426
`$this 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

Return Value

$this

at line 445
`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 462
`$this 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

Return Value

$this

at line 477
`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 490
`$this 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

Return Value

$this

AuditLog

Methods

Details

at line 161 __construct(array $data = NULL)

Parameters

at line 173 string getServiceName()

Return Value

at line 186 $this setServiceName(string $var)

Parameters

Return Value

at line 204 string getMethodName()

Return Value

at line 220 $this setMethodName(string $var)

Parameters

Return Value

at line 238 string getResourceName()

Return Value

at line 254 $this setResourceName(string $var)

Parameters

Return Value

at line 269 int|string getNumResponseItems()

Return Value

at line 282 $this setNumResponseItems(int|string $var)

Parameters

Return Value

at line 296 Status getStatus()

Return Value

at line 308 $this setStatus(Status $var)

Parameters

Return Value

at line 322 AuthenticationInfo getAuthenticationInfo()

Return Value

at line 334 $this setAuthenticationInfo(AuthenticationInfo $var)

Parameters

Return Value

at line 350 RepeatedField getAuthorizationInfo()

Return Value

at line 364 $this setAuthorizationInfo(AuthorizationInfo[]|RepeatedField $var)

Parameters

Return Value

at line 378 RequestMetadata getRequestMetadata()

Return Value

at line 390 $this setRequestMetadata(RequestMetadata $var)

Parameters

Return Value

at line 409 Struct getRequest()

Return Value

at line 426 $this setRequest(Struct $var)

Parameters

Return Value

at line 445 Struct getResponse()

Return Value

at line 462 $this setResponse(Struct $var)

Parameters

Return Value

at line 477 Any getServiceData()

Return Value

at line 490 $this setServiceData(Any $var)

Parameters

Return Value

at line 161
`__construct(array $data = NULL)`

at line 173
`string getServiceName()`

at line 186
`$this setServiceName(string $var)`

at line 204
`string getMethodName()`

at line 220
`$this setMethodName(string $var)`

at line 238
`string getResourceName()`

at line 254
`$this setResourceName(string $var)`

at line 269
`int|string getNumResponseItems()`

at line 282
`$this setNumResponseItems(int|string $var)`

at line 296
`Status getStatus()`

at line 308
`$this setStatus(Status $var)`

at line 322
`AuthenticationInfo getAuthenticationInfo()`

at line 334
`$this setAuthenticationInfo(AuthenticationInfo $var)`

at line 350
`RepeatedField getAuthorizationInfo()`

at line 364
`$this setAuthorizationInfo(AuthorizationInfo[]|RepeatedField $var)`

at line 378
`RequestMetadata getRequestMetadata()`

at line 390
`$this setRequestMetadata(RequestMetadata $var)`

at line 409
`Struct getRequest()`

at line 426
`$this setRequest(Struct $var)`

at line 445
`Struct getResponse()`

at line 462
`$this setResponse(Struct $var)`

at line 477
`Any getServiceData()`

at line 490
`$this setServiceData(Any $var)`