1. class
  2. Google
  3. \
  4. Cloud
  5. \
  6. Audit
  7. \
  8. RequestMetadata

RequestMetadata

class RequestMetadata extends Message

Metadata about the request.

Generated from protobuf message google.cloud.audit.RequestMetadata

Methods

__construct(array $data = NULL)

Constructor.

string
getCallerIp()

The IP address of the caller.

$this
setCallerIp(string $var)

The IP address of the caller.

string
getCallerSuppliedUserAgent()

The user agent of the caller.

$this
setCallerSuppliedUserAgent(string $var)

The user agent of the caller.

Details

at line 59
__construct(array $data = NULL)

Constructor.

Parameters

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

@type string $caller_ip
      The IP address of the caller.
@type string $caller_supplied_user_agent
      The user agent of the caller.
      This information is not authenticated and should be treated accordingly.
      For example:
      +   `google-api-python-client/1.4.0`:
          The request was made by the Google API client for Python.
      +   `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`:
          The request was made by the Google Cloud SDK CLI (gcloud).
      +   `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`:
          The request was made from the `my-project` App Engine app.

}

at line 70
string getCallerIp()

The IP address of the caller.

Generated from protobuf field string caller_ip = 1;

Return Value

string

at line 82
$this setCallerIp(string $var)

The IP address of the caller.

Generated from protobuf field string caller_ip = 1;

Parameters

string $var

Return Value

$this

at line 104
string getCallerSuppliedUserAgent()

The user agent of the caller.

This information is not authenticated and should be treated accordingly. For example: + google-api-python-client/1.4.0: The request was made by the Google API client for Python. + Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62: The request was made by the Google Cloud SDK CLI (gcloud). + AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project: The request was made from the my-project App Engine app.

Generated from protobuf field string caller_supplied_user_agent = 2;

Return Value

string

at line 124
$this setCallerSuppliedUserAgent(string $var)

The user agent of the caller.

This information is not authenticated and should be treated accordingly. For example: + google-api-python-client/1.4.0: The request was made by the Google API client for Python. + Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62: The request was made by the Google Cloud SDK CLI (gcloud). + AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project: The request was made from the my-project App Engine app.

Generated from protobuf field string caller_supplied_user_agent = 2;

Parameters

string $var

Return Value

$this