Class AttributeContext.Peer (2.41.0)

public static final class AttributeContext.Peer extends GeneratedMessageV3 implements AttributeContext.PeerOrBuilder

This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in principal and labels as appropriate.

Protobuf type google.rpc.context.AttributeContext.Peer

Static Fields

IP_FIELD_NUMBER

public static final int IP_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

PORT_FIELD_NUMBER

public static final int PORT_FIELD_NUMBER
Field Value
Type Description
int

PRINCIPAL_FIELD_NUMBER

public static final int PRINCIPAL_FIELD_NUMBER
Field Value
Type Description
int

REGION_CODE_FIELD_NUMBER

public static final int REGION_CODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AttributeContext.Peer getDefaultInstance()
Returns
Type Description
AttributeContext.Peer

getDescriptor()

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

newBuilder()

public static AttributeContext.Peer.Builder newBuilder()
Returns
Type Description
AttributeContext.Peer.Builder

newBuilder(AttributeContext.Peer prototype)

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

parseDelimitedFrom(InputStream input)

public static AttributeContext.Peer parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AttributeContext.Peer
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static AttributeContext.Peer parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AttributeContext.Peer
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static AttributeContext.Peer parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AttributeContext.Peer
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static AttributeContext.Peer parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AttributeContext.Peer
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static AttributeContext.Peer parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AttributeContext.Peer
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<AttributeContext.Peer> parser()
Returns
Type Description
Parser<Peer>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

The labels associated with the peer.

map<string, string> labels = 6;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getDefaultInstanceForType()

public AttributeContext.Peer getDefaultInstanceForType()
Returns
Type Description
AttributeContext.Peer

getIp()

public String getIp()

The IP address of the peer.

string ip = 1;

Returns
Type Description
String

The ip.

getIpBytes()

public ByteString getIpBytes()

The IP address of the peer.

string ip = 1;

Returns
Type Description
ByteString

The bytes for ip.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

The labels associated with the peer.

map<string, string> labels = 6;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

The labels associated with the peer.

map<string, string> labels = 6;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

The labels associated with the peer.

map<string, string> labels = 6;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

The labels associated with the peer.

map<string, string> labels = 6;

Parameter
Name Description
key String
Returns
Type Description
String

getParserForType()

public Parser<AttributeContext.Peer> getParserForType()
Returns
Type Description
Parser<Peer>
Overrides

getPort()

public long getPort()

The network port of the peer.

int64 port = 2;

Returns
Type Description
long

The port.

getPrincipal()

public String getPrincipal()

The identity of this peer. Similar to Request.auth.principal, but relative to the peer instead of the request. For example, the identity associated with a load balancer that forwarded the request.

string principal = 7;

Returns
Type Description
String

The principal.

getPrincipalBytes()

public ByteString getPrincipalBytes()

The identity of this peer. Similar to Request.auth.principal, but relative to the peer instead of the request. For example, the identity associated with a load balancer that forwarded the request.

string principal = 7;

Returns
Type Description
ByteString

The bytes for principal.

getRegionCode()

public String getRegionCode()

The CLDR country/region code associated with the above IP address. If the IP address is private, the region_code should reflect the physical location where this peer is running.

string region_code = 8;

Returns
Type Description
String

The regionCode.

getRegionCodeBytes()

public ByteString getRegionCodeBytes()

The CLDR country/region code associated with the above IP address. If the IP address is private, the region_code should reflect the physical location where this peer is running.

string region_code = 8;

Returns
Type Description
ByteString

The bytes for regionCode.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AttributeContext.Peer.Builder newBuilderForType()
Returns
Type Description
AttributeContext.Peer.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public AttributeContext.Peer.Builder toBuilder()
Returns
Type Description
AttributeContext.Peer.Builder

writeTo(CodedOutputStream output)

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