Class RequestMetadata (2.38.0)

public final class RequestMetadata extends GeneratedMessageV3 implements RequestMetadataOrBuilder

Metadata about the request.

Protobuf type google.cloud.audit.RequestMetadata

Static Fields

CALLER_IP_FIELD_NUMBER

public static final int CALLER_IP_FIELD_NUMBER
Field Value
Type Description
int

CALLER_NETWORK_FIELD_NUMBER

public static final int CALLER_NETWORK_FIELD_NUMBER
Field Value
Type Description
int

CALLER_SUPPLIED_USER_AGENT_FIELD_NUMBER

public static final int CALLER_SUPPLIED_USER_AGENT_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_ATTRIBUTES_FIELD_NUMBER

public static final int DESTINATION_ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ATTRIBUTES_FIELD_NUMBER

public static final int REQUEST_ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RequestMetadata getDefaultInstance()
Returns
Type Description
RequestMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RequestMetadata.Builder newBuilder()
Returns
Type Description
RequestMetadata.Builder

newBuilder(RequestMetadata prototype)

public static RequestMetadata.Builder newBuilder(RequestMetadata prototype)
Parameter
Name Description
prototype RequestMetadata
Returns
Type Description
RequestMetadata.Builder

parseDelimitedFrom(InputStream input)

public static RequestMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RequestMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RequestMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RequestMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RequestMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RequestMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RequestMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RequestMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RequestMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RequestMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RequestMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RequestMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RequestMetadata> parser()
Returns
Type Description
Parser<RequestMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

string caller_ip = 1;

Returns
Type Description
String

The callerIp.

getCallerIpBytes()

public ByteString getCallerIpBytes()

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
ByteString

The bytes for callerIp.

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"

string caller_network = 3;

Returns
Type Description
String

The callerNetwork.

getCallerNetworkBytes()

public ByteString getCallerNetworkBytes()

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
ByteString

The bytes for callerNetwork.

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.

string caller_supplied_user_agent = 2;

Returns
Type Description
String

The callerSuppliedUserAgent.

getCallerSuppliedUserAgentBytes()

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

getDefaultInstanceForType()

public RequestMetadata getDefaultInstanceForType()
Returns
Type Description
RequestMetadata

getDestinationAttributes()

public 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 AttributeContext.PeerOrBuilder getDestinationAttributesOrBuilder()

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

getParserForType()

public Parser<RequestMetadata> getParserForType()
Returns
Type Description
Parser<RequestMetadata>
Overrides

getRequestAttributes()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDestinationAttributes()

public boolean hasDestinationAttributes()

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
boolean

Whether the destinationAttributes field is set.

hasRequestAttributes()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RequestMetadata.Builder newBuilderForType()
Returns
Type Description
RequestMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RequestMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RequestMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RequestMetadata.Builder toBuilder()
Returns
Type Description
RequestMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException