Class AttributeContext.Peer.Builder (2.38.0)

public static final class AttributeContext.Peer.Builder extends GeneratedMessageV3.Builder<AttributeContext.Peer.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

public AttributeContext.Peer.Builder clear()
Returns
Type Description
AttributeContext.Peer.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

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

clearIp()

public AttributeContext.Peer.Builder clearIp()

The IP address of the peer.

string ip = 1;

Returns
Type Description
AttributeContext.Peer.Builder

This builder for chaining.

clearLabels()

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPort()

public AttributeContext.Peer.Builder clearPort()

The network port of the peer.

int64 port = 2;

Returns
Type Description
AttributeContext.Peer.Builder

This builder for chaining.

clearPrincipal()

public AttributeContext.Peer.Builder clearPrincipal()

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

This builder for chaining.

clearRegionCode()

public AttributeContext.Peer.Builder clearRegionCode()

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

This builder for chaining.

clone()

public AttributeContext.Peer.Builder clone()
Returns
Type Description
AttributeContext.Peer.Builder
Overrides

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

getDefaultInstanceForType()

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

getDescriptorForType()

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

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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(AttributeContext.Peer other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllLabels(Map<String,String> values)

public AttributeContext.Peer.Builder putAllLabels(Map<String,String> values)

The labels associated with the peer.

map<string, string> labels = 6;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
AttributeContext.Peer.Builder

putLabels(String key, String value)

public AttributeContext.Peer.Builder putLabels(String key, String value)

The labels associated with the peer.

map<string, string> labels = 6;

Parameters
Name Description
key String
value String
Returns
Type Description
AttributeContext.Peer.Builder

removeLabels(String key)

public AttributeContext.Peer.Builder removeLabels(String key)

The labels associated with the peer.

map<string, string> labels = 6;

Parameter
Name Description
key String
Returns
Type Description
AttributeContext.Peer.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setIp(String value)

public AttributeContext.Peer.Builder setIp(String value)

The IP address of the peer.

string ip = 1;

Parameter
Name Description
value String

The ip to set.

Returns
Type Description
AttributeContext.Peer.Builder

This builder for chaining.

setIpBytes(ByteString value)

public AttributeContext.Peer.Builder setIpBytes(ByteString value)

The IP address of the peer.

string ip = 1;

Parameter
Name Description
value ByteString

The bytes for ip to set.

Returns
Type Description
AttributeContext.Peer.Builder

This builder for chaining.

setPort(long value)

public AttributeContext.Peer.Builder setPort(long value)

The network port of the peer.

int64 port = 2;

Parameter
Name Description
value long

The port to set.

Returns
Type Description
AttributeContext.Peer.Builder

This builder for chaining.

setPrincipal(String value)

public AttributeContext.Peer.Builder setPrincipal(String value)

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;

Parameter
Name Description
value String

The principal to set.

Returns
Type Description
AttributeContext.Peer.Builder

This builder for chaining.

setPrincipalBytes(ByteString value)

public AttributeContext.Peer.Builder setPrincipalBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for principal to set.

Returns
Type Description
AttributeContext.Peer.Builder

This builder for chaining.

setRegionCode(String value)

public AttributeContext.Peer.Builder setRegionCode(String value)

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;

Parameter
Name Description
value String

The regionCode to set.

Returns
Type Description
AttributeContext.Peer.Builder

This builder for chaining.

setRegionCodeBytes(ByteString value)

public AttributeContext.Peer.Builder setRegionCodeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for regionCode to set.

Returns
Type Description
AttributeContext.Peer.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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