Package com.google.cloud.audit

Class RequestMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.cloud.audit.RequestMetadata
All Implemented Interfaces:
RequestMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class RequestMetadata extends com.google.protobuf.GeneratedMessageV3 implements RequestMetadataOrBuilder
 Metadata about the request.
Protobuf type google.cloud.audit.RequestMetadata
See Also:

  • Field Details

    • CALLER_IP_FIELD_NUMBER

      public static final int CALLER_IP_FIELD_NUMBER
      See Also:

    • CALLER_SUPPLIED_USER_AGENT_FIELD_NUMBER

      public static final int CALLER_SUPPLIED_USER_AGENT_FIELD_NUMBER
      See Also:

    • CALLER_NETWORK_FIELD_NUMBER

      public static final int CALLER_NETWORK_FIELD_NUMBER
      See Also:

    • REQUEST_ATTRIBUTES_FIELD_NUMBER

      public static final int REQUEST_ATTRIBUTES_FIELD_NUMBER
      See Also:

    • DESTINATION_ATTRIBUTES_FIELD_NUMBER

      public static final int DESTINATION_ATTRIBUTES_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • 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;
      Specified by:
      getCallerIp in interface RequestMetadataOrBuilder
      Returns:
      The callerIp.

    • getCallerIpBytes

      public com.google.protobuf.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;
      Specified by:
      getCallerIpBytes in interface RequestMetadataOrBuilder
      Returns:
      The bytes for callerIp.

    • 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;
      Specified by:
      getCallerSuppliedUserAgent in interface RequestMetadataOrBuilder
      Returns:
      The callerSuppliedUserAgent.

    • getCallerSuppliedUserAgentBytes

      public com.google.protobuf.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;
      Specified by:
      getCallerSuppliedUserAgentBytes in interface RequestMetadataOrBuilder
      Returns:
      The bytes for callerSuppliedUserAgent.

    • 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;
      Specified by:
      getCallerNetwork in interface RequestMetadataOrBuilder
      Returns:
      The callerNetwork.

    • getCallerNetworkBytes

      public com.google.protobuf.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;
      Specified by:
      getCallerNetworkBytes in interface RequestMetadataOrBuilder
      Returns:
      The bytes for callerNetwork.

    • 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;
      Specified by:
      hasRequestAttributes in interface RequestMetadataOrBuilder
      Returns:
      Whether the requestAttributes field is set.

    • 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;
      Specified by:
      getRequestAttributes in interface RequestMetadataOrBuilder
      Returns:
      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;
      Specified by:
      getRequestAttributesOrBuilder in interface RequestMetadataOrBuilder

    • 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;
      Specified by:
      hasDestinationAttributes in interface RequestMetadataOrBuilder
      Returns:
      Whether the destinationAttributes field is set.

    • 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;
      Specified by:
      getDestinationAttributes in interface RequestMetadataOrBuilder
      Returns:
      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;
      Specified by:
      getDestinationAttributesOrBuilder in interface RequestMetadataOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RequestMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestMetadata parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RequestMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RequestMetadata parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RequestMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RequestMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RequestMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RequestMetadata.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RequestMetadata.Builder newBuilder()

    • newBuilder

      public static RequestMetadata.Builder newBuilder(RequestMetadata prototype)

    • toBuilder

      public RequestMetadata.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RequestMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static RequestMetadata getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RequestMetadata> parser()

    • getParserForType

      public com.google.protobuf.Parser<RequestMetadata> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public RequestMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder