Class RequestMetadata

public final class RequestMetadata extends GeneratedMessageV3 implements RequestMetadataOrBuilder

Metadata about the request.

Protobuf type google.cloud.audit.RequestMetadata

Fields

CALLER_IP_FIELD_NUMBER

public static final int CALLER_IP_FIELD_NUMBER
Field Value
TypeDescription
int

CALLER_NETWORK_FIELD_NUMBER

public static final int CALLER_NETWORK_FIELD_NUMBER
Field Value
TypeDescription
int

CALLER_SUPPLIED_USER_AGENT_FIELD_NUMBER

public static final int CALLER_SUPPLIED_USER_AGENT_FIELD_NUMBER
Field Value
TypeDescription
int

DESTINATION_ATTRIBUTES_FIELD_NUMBER

public static final int DESTINATION_ATTRIBUTES_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_ATTRIBUTES_FIELD_NUMBER

public static final int REQUEST_ATTRIBUTES_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCallerIp()

public String getCallerIp()

The IP address of the caller. For caller from internet, this will be public IPv4 or IPv6 address. For caller from a Compute Engine VM with external IP address, this will be the VM's external IP address. For caller from a Compute Engine VM without 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 the 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
TypeDescription
String

The callerIp.

getCallerIpBytes()

public ByteString getCallerIpBytes()

The IP address of the caller. For caller from internet, this will be public IPv4 or IPv6 address. For caller from a Compute Engine VM with external IP address, this will be the VM's external IP address. For caller from a Compute Engine VM without 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 the 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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for callerSuppliedUserAgent.

getDefaultInstance()

public static RequestMetadata getDefaultInstance()
Returns
TypeDescription
RequestMetadata

getDefaultInstanceForType()

public RequestMetadata getDefaultInstanceForType()
Returns
TypeDescription
RequestMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

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

getParserForType()

public Parser<RequestMetadata> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
AttributeContext.RequestOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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
TypeDescription
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
TypeDescription
boolean

Whether the requestAttributes field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static RequestMetadata.Builder newBuilder()
Returns
TypeDescription
RequestMetadata.Builder

newBuilder(RequestMetadata prototype)

public static RequestMetadata.Builder newBuilder(RequestMetadata prototype)
Parameter
NameDescription
prototypeRequestMetadata
Returns
TypeDescription
RequestMetadata.Builder

newBuilderForType()

public RequestMetadata.Builder newBuilderForType()
Returns
TypeDescription
RequestMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RequestMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RequestMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static RequestMetadata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RequestMetadata parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RequestMetadata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RequestMetadata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RequestMetadata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RequestMetadata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RequestMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RequestMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RequestMetadata> parser()
Returns
TypeDescription
Parser<RequestMetadata>

toBuilder()

public RequestMetadata.Builder toBuilder()
Returns
TypeDescription
RequestMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException