com.google.api.services.servicecontrol.v2.model

Class RequestMetadata

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.servicecontrol.v2.model.RequestMetadata

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class RequestMetadata
extends com.google.api.client.json.GenericJson

Metadata about the request.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Service Control API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
RequestMetadata()

Method Summary

Modifier and Type	Method and Description
RequestMetadata	clone()
String	getCallerIp() The IP address of the caller.
String	getCallerNetwork() The network of the caller.
String	getCallerSuppliedUserAgent() The user agent of the caller.
Peer	getDestinationAttributes() The destination of a network activity, such as accepting a TCP connection.
Request	getRequestAttributes() Request attributes used in IAM condition evaluation.
RequestMetadata	set(String fieldName, Object value)
RequestMetadata	setCallerIp(String callerIp) The IP address of the caller.
RequestMetadata	setCallerNetwork(String callerNetwork) The network of the caller.
RequestMetadata	setCallerSuppliedUserAgent(String callerSuppliedUserAgent) The user agent of the caller.
RequestMetadata	setDestinationAttributes(Peer destinationAttributes) The destination of a network activity, such as accepting a TCP connection.
RequestMetadata	setRequestAttributes(Request requestAttributes) Request attributes used in IAM condition evaluation.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

RequestMetadata

public RequestMetadata()

Method Detail

getCallerIp

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

Returns:

value or null for none

setCallerIp

public RequestMetadata setCallerIp(String callerIp)

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.

Parameters:

callerIp - callerIp or null for none

getCallerNetwork

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

Returns:

value or null for none

setCallerNetwork

public RequestMetadata setCallerNetwork(String callerNetwork)

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"

Parameters:

callerNetwork - callerNetwork or null for none

getCallerSuppliedUserAgent

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

Returns:

value or null for none

setCallerSuppliedUserAgent

public RequestMetadata setCallerSuppliedUserAgent(String callerSuppliedUserAgent)

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.

Parameters:

callerSuppliedUserAgent - callerSuppliedUserAgent or null for none

getDestinationAttributes

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

Returns:

value or null for none

setDestinationAttributes

public RequestMetadata setDestinationAttributes(Peer destinationAttributes)

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.

Parameters:

destinationAttributes - destinationAttributes or null for none

getRequestAttributes

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

Returns:

value or null for none

setRequestAttributes

public RequestMetadata setRequestAttributes(Request requestAttributes)

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`.

Parameters:

requestAttributes - requestAttributes or null for none

set

public RequestMetadata set(String fieldName,
                           Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public RequestMetadata clone()

Overrides:

clone in class com.google.api.client.json.GenericJson