Common Protos for Google Cloud APIs Client - Class RequestMetadata (0.5.1)

Reference documentation and code samples for the Common Protos for Google Cloud APIs Client class RequestMetadata.

Metadata about the request.

Generated from protobuf message google.cloud.audit.RequestMetadata

Namespace

Google \ Cloud \ Audit

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ caller_ip string

The IP address of the caller. For a caller from the internet, this will be the public IPv4 or IPv6 address. For calls made from inside Google's internal production network from one GCP service to another, caller_ip will be redacted to "private". For a caller from a Compute Engine VM with a external IP address, caller_ip will be the VM's external IP address. For a caller from a Compute Engine VM without a external IP address, if the VM is in the same organization (or project) as the accessed resource, caller_ip will be the VM's internal IPv4 address, otherwise caller_ip will be redacted to "gce-internal-ip". See https://cloud.google.com/compute/docs/vpc/ for more information.
↳ caller_supplied_user_agent string

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.
↳ caller_network string

The network of the caller. Set only if the network host project is part of the same GCP organization (or project) as the accessed resource. See https://cloud.google.com/compute/docs/vpc/ for more information. This is a scheme-less URI full resource name. For example: "//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID"
↳ request_attributes Google\Rpc\Context\AttributeContext\Request

Request attributes used in IAM condition evaluation. This field contains request attributes like request time and access levels associated with the request. To get the whole view of the attributes used in IAM condition evaluation, the user must also look into AuditLog.authentication_info.resource_attributes.
↳ destination_attributes Google\Rpc\Context\AttributeContext\Peer

The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop. Only two fields are used in this message, Peer.port and Peer.ip. These fields are optionally populated by those services utilizing the IAM condition feature.

getCallerIp

The IP address of the caller.

For a caller from the internet, this will be the public IPv4 or IPv6 address. For calls made from inside Google's internal production network from one GCP service to another, caller_ip will be redacted to "private". For a caller from a Compute Engine VM with a external IP address, caller_ip will be the VM's external IP address. For a caller from a Compute Engine VM without a external IP address, if the VM is in the same organization (or project) as the accessed resource, caller_ip will be the VM's internal IPv4 address, otherwise caller_ip will be redacted to "gce-internal-ip". See https://cloud.google.com/compute/docs/vpc/ for more information.

Returns
Type Description
string

setCallerIp

The IP address of the caller.

For a caller from the internet, this will be the public IPv4 or IPv6 address. For calls made from inside Google's internal production network from one GCP service to another, caller_ip will be redacted to "private". For a caller from a Compute Engine VM with a external IP address, caller_ip will be the VM's external IP address. For a caller from a Compute Engine VM without a external IP address, if the VM is in the same organization (or project) as the accessed resource, caller_ip will be the VM's internal IPv4 address, otherwise caller_ip will be redacted to "gce-internal-ip". See https://cloud.google.com/compute/docs/vpc/ for more information.

Parameter
Name Description
var string
Returns
Type Description
$this

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.
Returns
Type Description
string

setCallerSuppliedUserAgent

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.
Parameter
Name Description
var string
Returns
Type Description
$this

getCallerNetwork

The network of the caller.

Set only if the network host project is part of the same GCP organization (or project) as the accessed resource. See https://cloud.google.com/compute/docs/vpc/ for more information. This is a scheme-less URI full resource name. For example: "//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID"

Returns
Type Description
string

setCallerNetwork

The network of the caller.

Set only if the network host project is part of the same GCP organization (or project) as the accessed resource. See https://cloud.google.com/compute/docs/vpc/ for more information. This is a scheme-less URI full resource name. For example: "//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID"

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestAttributes

Request attributes used in IAM condition evaluation. This field contains request attributes like request time and access levels associated with the request.

To get the whole view of the attributes used in IAM condition evaluation, the user must also look into AuditLog.authentication_info.resource_attributes.

Returns
Type Description
Google\Rpc\Context\AttributeContext\Request|null

hasRequestAttributes

clearRequestAttributes

setRequestAttributes

Request attributes used in IAM condition evaluation. This field contains request attributes like request time and access levels associated with the request.

To get the whole view of the attributes used in IAM condition evaluation, the user must also look into AuditLog.authentication_info.resource_attributes.

Parameter
Name Description
var Google\Rpc\Context\AttributeContext\Request
Returns
Type Description
$this

getDestinationAttributes

The destination of a network activity, such as accepting a TCP connection.

In a multi hop network activity, the destination represents the receiver of the last hop. Only two fields are used in this message, Peer.port and Peer.ip. These fields are optionally populated by those services utilizing the IAM condition feature.

Returns
Type Description
Google\Rpc\Context\AttributeContext\Peer|null

hasDestinationAttributes

clearDestinationAttributes

setDestinationAttributes

The destination of a network activity, such as accepting a TCP connection.

In a multi hop network activity, the destination represents the receiver of the last hop. Only two fields are used in this message, Peer.port and Peer.ip. These fields are optionally populated by those services utilizing the IAM condition feature.

Parameter
Name Description
var Google\Rpc\Context\AttributeContext\Peer
Returns
Type Description
$this