public final class RequestMetadata extends GeneratedMessageV3 implements RequestMetadataOrBuilder
Metadata about the request.
Protobuf type google.cloud.audit.RequestMetadata
Static Fields
public static final int CALLER_IP_FIELD_NUMBER
Field Value
public static final int CALLER_NETWORK_FIELD_NUMBER
Field Value
public static final int CALLER_SUPPLIED_USER_AGENT_FIELD_NUMBER
Field Value
public static final int DESTINATION_ATTRIBUTES_FIELD_NUMBER
Field Value
public static final int REQUEST_ATTRIBUTES_FIELD_NUMBER
Field Value
Static Methods
public static RequestMetadata getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static RequestMetadata.Builder newBuilder()
Returns
public static RequestMetadata.Builder newBuilder(RequestMetadata prototype)
Parameter
Returns
public static RequestMetadata parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static RequestMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RequestMetadata parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
public static RequestMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RequestMetadata parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static RequestMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RequestMetadata parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static RequestMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RequestMetadata parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static RequestMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RequestMetadata parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static RequestMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<RequestMetadata> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
| Type | Description |
String | The callerIp.
|
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;
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;
| Type | Description |
String | The callerNetwork.
|
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;
| Type | Description |
ByteString | The bytes for callerNetwork.
|
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;
| Type | Description |
String | The callerSuppliedUserAgent.
|
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;
| Type | Description |
ByteString | The bytes for callerSuppliedUserAgent.
|
public RequestMetadata getDefaultInstanceForType()
Returns
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;
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;
public Parser<RequestMetadata> getParserForType()
Returns
Overrides
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;
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;
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
| Type | Description |
boolean | Whether the destinationAttributes field is set.
|
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;
| Type | Description |
boolean | Whether the requestAttributes field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public RequestMetadata.Builder newBuilderForType()
Returns
protected RequestMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public RequestMetadata.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
