Interface RequestMetadataOrBuilder (2.27.0)

public interface RequestMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCallerIp()

public abstract String 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.

string caller_ip = 1;

Returns
Type	Description
`String`	The callerIp.

getCallerIpBytes()

public abstract ByteString getCallerIpBytes()

string caller_ip = 1;

Returns
Type	Description
`ByteString`	The bytes for callerIp.

getCallerNetwork()

public abstract String 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"

string caller_network = 3;

Returns
Type	Description
`String`	The callerNetwork.

getCallerNetworkBytes()

public abstract ByteString getCallerNetworkBytes()

 "//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID"

string caller_network = 3;

Returns
Type	Description
`ByteString`	The bytes for callerNetwork.

getCallerSuppliedUserAgent()

public abstract 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.

string caller_supplied_user_agent = 2;

Returns
Type	Description
`String`	The callerSuppliedUserAgent.

getCallerSuppliedUserAgentBytes()

public abstract ByteString getCallerSuppliedUserAgentBytes()

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.

string caller_supplied_user_agent = 2;

Returns
Type	Description
`ByteString`	The bytes for callerSuppliedUserAgent.

getDestinationAttributes()

public abstract AttributeContext.Peer 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.

.google.rpc.context.AttributeContext.Peer destination_attributes = 8;

Returns
Type	Description
`AttributeContext.Peer`	The destinationAttributes.

getDestinationAttributesOrBuilder()

public abstract AttributeContext.PeerOrBuilder getDestinationAttributesOrBuilder()

.google.rpc.context.AttributeContext.Peer destination_attributes = 8;

Returns
Type	Description
`AttributeContext.PeerOrBuilder`

getRequestAttributes()

public abstract AttributeContext.Request 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.

.google.rpc.context.AttributeContext.Request request_attributes = 7;

Returns
Type	Description
`AttributeContext.Request`	The requestAttributes.

getRequestAttributesOrBuilder()

public abstract AttributeContext.RequestOrBuilder getRequestAttributesOrBuilder()

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.

.google.rpc.context.AttributeContext.Request request_attributes = 7;

Returns
Type	Description
`AttributeContext.RequestOrBuilder`

hasDestinationAttributes()

public abstract boolean hasDestinationAttributes()

.google.rpc.context.AttributeContext.Peer destination_attributes = 8;

Returns
Type	Description
`boolean`	Whether the destinationAttributes field is set.

hasRequestAttributes()

public abstract boolean hasRequestAttributes()

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.

.google.rpc.context.AttributeContext.Request request_attributes = 7;

Returns
Type	Description
`boolean`	Whether the requestAttributes field is set.