Class RequestMetadata.Builder (2.45.1) 

public static final class RequestMetadata.Builder extends GeneratedMessageV3.Builder<RequestMetadata.Builder> implements RequestMetadataOrBuilder

Metadata about the request.

Protobuf type google.cloud.audit.RequestMetadata

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RequestMetadata.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RequestMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RequestMetadata.Builder
Overrides

build()

public RequestMetadata build()
Returns
Type Description
RequestMetadata

buildPartial()

public RequestMetadata buildPartial()
Returns
Type Description
RequestMetadata

clear()

public RequestMetadata.Builder clear()
Returns
Type Description
RequestMetadata.Builder
Overrides

clearCallerIp()

public RequestMetadata.Builder clearCallerIp()

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
RequestMetadata.Builder

This builder for chaining.

clearCallerNetwork()

public RequestMetadata.Builder clearCallerNetwork()

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
RequestMetadata.Builder

This builder for chaining.

clearCallerSuppliedUserAgent()

public RequestMetadata.Builder clearCallerSuppliedUserAgent()

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
RequestMetadata.Builder

This builder for chaining.

clearDestinationAttributes()

public RequestMetadata.Builder clearDestinationAttributes()

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
RequestMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

public RequestMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RequestMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RequestMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RequestMetadata.Builder
Overrides

clearRequestAttributes()

public RequestMetadata.Builder clearRequestAttributes()

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
RequestMetadata.Builder

clone()

public RequestMetadata.Builder clone()
Returns
Type Description
RequestMetadata.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getDestinationAttributesBuilder()

public AttributeContext.Peer.Builder getDestinationAttributesBuilder()

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

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

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.

getRequestAttributesBuilder()

public AttributeContext.Request.Builder getRequestAttributesBuilder()

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

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDestinationAttributes(AttributeContext.Peer value)

public RequestMetadata.Builder mergeDestinationAttributes(AttributeContext.Peer value)

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;

Parameter
Name Description
value AttributeContext.Peer
Returns
Type Description
RequestMetadata.Builder

mergeFrom(RequestMetadata other)

public RequestMetadata.Builder mergeFrom(RequestMetadata other)
Parameter
Name Description
other RequestMetadata
Returns
Type Description
RequestMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RequestMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RequestMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RequestMetadata.Builder
Overrides

mergeRequestAttributes(AttributeContext.Request value)

public RequestMetadata.Builder mergeRequestAttributes(AttributeContext.Request value)

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;

Parameter
Name Description
value AttributeContext.Request
Returns
Type Description
RequestMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RequestMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RequestMetadata.Builder
Overrides

setCallerIp(String value)

public RequestMetadata.Builder setCallerIp(String value)

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;

Parameter
Name Description
value String

The callerIp to set.
Returns
Type Description
RequestMetadata.Builder

This builder for chaining.

setCallerIpBytes(ByteString value)

public RequestMetadata.Builder setCallerIpBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for callerIp to set.
Returns
Type Description
RequestMetadata.Builder

This builder for chaining.

setCallerNetwork(String value)

public RequestMetadata.Builder setCallerNetwork(String value)

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;

Parameter
Name Description
value String

The callerNetwork to set.
Returns
Type Description
RequestMetadata.Builder

This builder for chaining.

setCallerNetworkBytes(ByteString value)

public RequestMetadata.Builder setCallerNetworkBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for callerNetwork to set.
Returns
Type Description
RequestMetadata.Builder

This builder for chaining.

setCallerSuppliedUserAgent(String value)

public RequestMetadata.Builder setCallerSuppliedUserAgent(String value)

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;

Parameter
Name Description
value String

The callerSuppliedUserAgent to set.
Returns
Type Description
RequestMetadata.Builder

This builder for chaining.

setCallerSuppliedUserAgentBytes(ByteString value)

public RequestMetadata.Builder setCallerSuppliedUserAgentBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for callerSuppliedUserAgent to set.
Returns
Type Description
RequestMetadata.Builder

This builder for chaining.

setDestinationAttributes(AttributeContext.Peer value)

public RequestMetadata.Builder setDestinationAttributes(AttributeContext.Peer value)

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;

Parameter
Name Description
value AttributeContext.Peer
Returns
Type Description
RequestMetadata.Builder

setDestinationAttributes(AttributeContext.Peer.Builder builderForValue)

public RequestMetadata.Builder setDestinationAttributes(AttributeContext.Peer.Builder builderForValue)

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;

Parameter
Name Description
builderForValue AttributeContext.Peer.Builder
Returns
Type Description
RequestMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RequestMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RequestMetadata.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RequestMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RequestMetadata.Builder
Overrides

setRequestAttributes(AttributeContext.Request value)

public RequestMetadata.Builder setRequestAttributes(AttributeContext.Request value)

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;

Parameter
Name Description
value AttributeContext.Request
Returns
Type Description
RequestMetadata.Builder

setRequestAttributes(AttributeContext.Request.Builder builderForValue)

public RequestMetadata.Builder setRequestAttributes(AttributeContext.Request.Builder builderForValue)

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;

Parameter
Name Description
builderForValue AttributeContext.Request.Builder
Returns
Type Description
RequestMetadata.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final RequestMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RequestMetadata.Builder
Overrides