Class LbTrafficExtension (0.2.0)

public final class LbTrafficExtension extends GeneratedMessageV3 implements LbTrafficExtensionOrBuilder

LbTrafficExtension is a resource that lets the extension service modify the headers and payloads of both requests and responses without impacting the choice of backend services or any other security policies associated with the backend service.

Protobuf type google.cloud.networkservices.v1.LbTrafficExtension

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EXTENSION_CHAINS_FIELD_NUMBER

public static final int EXTENSION_CHAINS_FIELD_NUMBER
Field Value
Type Description
int

FORWARDING_RULES_FIELD_NUMBER

public static final int FORWARDING_RULES_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LOAD_BALANCING_SCHEME_FIELD_NUMBER

public static final int LOAD_BALANCING_SCHEME_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LbTrafficExtension getDefaultInstance()
Returns
Type Description
LbTrafficExtension

getDescriptor()

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

newBuilder()

public static LbTrafficExtension.Builder newBuilder()
Returns
Type Description
LbTrafficExtension.Builder

newBuilder(LbTrafficExtension prototype)

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

parseDelimitedFrom(InputStream input)

public static LbTrafficExtension parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LbTrafficExtension
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static LbTrafficExtension parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LbTrafficExtension
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static LbTrafficExtension parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LbTrafficExtension
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static LbTrafficExtension parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LbTrafficExtension
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static LbTrafficExtension parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LbTrafficExtension
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<LbTrafficExtension> parser()
Returns
Type Description
Parser<LbTrafficExtension>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Set of labels associated with the LbTrafficExtension resource.

The format must comply with the requirements for labels for Google Cloud resources.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

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

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public LbTrafficExtension getDefaultInstanceForType()
Returns
Type Description
LbTrafficExtension

getDescription()

public String getDescription()

Optional. A human-readable description of the resource.

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. A human-readable description of the resource.

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getExtensionChains(int index)

public ExtensionChain getExtensionChains(int index)

Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.

repeated .google.cloud.networkservices.v1.ExtensionChain extension_chains = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ExtensionChain

getExtensionChainsCount()

public int getExtensionChainsCount()

Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.

repeated .google.cloud.networkservices.v1.ExtensionChain extension_chains = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getExtensionChainsList()

public List<ExtensionChain> getExtensionChainsList()

Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.

repeated .google.cloud.networkservices.v1.ExtensionChain extension_chains = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<ExtensionChain>

getExtensionChainsOrBuilder(int index)

public ExtensionChainOrBuilder getExtensionChainsOrBuilder(int index)

Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.

repeated .google.cloud.networkservices.v1.ExtensionChain extension_chains = 7 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ExtensionChainOrBuilder

getExtensionChainsOrBuilderList()

public List<? extends ExtensionChainOrBuilder> getExtensionChainsOrBuilderList()

Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.

repeated .google.cloud.networkservices.v1.ExtensionChain extension_chains = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.networkservices.v1.ExtensionChainOrBuilder>

getForwardingRules(int index)

public String getForwardingRules(int index)

Required. A list of references to the forwarding rules to which this service extension is attached to. At least one forwarding rule is required. There can be only one LBTrafficExtension resource per forwarding rule.

repeated string forwarding_rules = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The forwardingRules at the given index.

getForwardingRulesBytes(int index)

public ByteString getForwardingRulesBytes(int index)

Required. A list of references to the forwarding rules to which this service extension is attached to. At least one forwarding rule is required. There can be only one LBTrafficExtension resource per forwarding rule.

repeated string forwarding_rules = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the forwardingRules at the given index.

getForwardingRulesCount()

public int getForwardingRulesCount()

Required. A list of references to the forwarding rules to which this service extension is attached to. At least one forwarding rule is required. There can be only one LBTrafficExtension resource per forwarding rule.

repeated string forwarding_rules = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of forwardingRules.

getForwardingRulesList()

public ProtocolStringList getForwardingRulesList()

Required. A list of references to the forwarding rules to which this service extension is attached to. At least one forwarding rule is required. There can be only one LBTrafficExtension resource per forwarding rule.

repeated string forwarding_rules = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProtocolStringList

A list containing the forwardingRules.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Set of labels associated with the LbTrafficExtension resource.

The format must comply with the requirements for labels for Google Cloud resources.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Set of labels associated with the LbTrafficExtension resource.

The format must comply with the requirements for labels for Google Cloud resources.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Set of labels associated with the LbTrafficExtension resource.

The format must comply with the requirements for labels for Google Cloud resources.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Set of labels associated with the LbTrafficExtension resource.

The format must comply with the requirements for labels for Google Cloud resources.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getLoadBalancingScheme()

public LoadBalancingScheme getLoadBalancingScheme()

Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: INTERNAL_MANAGED, EXTERNAL_MANAGED. For more information, refer to Choosing a load balancer.

.google.cloud.networkservices.v1.LoadBalancingScheme load_balancing_scheme = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LoadBalancingScheme

The loadBalancingScheme.

getLoadBalancingSchemeValue()

public int getLoadBalancingSchemeValue()

Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: INTERNAL_MANAGED, EXTERNAL_MANAGED. For more information, refer to Choosing a load balancer.

.google.cloud.networkservices.v1.LoadBalancingScheme load_balancing_scheme = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for loadBalancingScheme.

getMetadata()

public Struct getMetadata()

Optional. The metadata provided here is included in the ProcessingRequest.metadata_context.filter_metadata map field. The metadata is available under the key com.google.lb_traffic_extension.<resource_name>. The following variables are supported in the metadata:

{forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.

.google.protobuf.Struct metadata = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The metadata.

getMetadataOrBuilder()

public StructOrBuilder getMetadataOrBuilder()

Optional. The metadata provided here is included in the ProcessingRequest.metadata_context.filter_metadata map field. The metadata is available under the key com.google.lb_traffic_extension.<resource_name>. The following variables are supported in the metadata:

{forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.

.google.protobuf.Struct metadata = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getName()

public String getName()

Required. Identifier. Name of the LbTrafficExtension resource in the following format: projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Identifier. Name of the LbTrafficExtension resource in the following format: projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<LbTrafficExtension> getParserForType()
Returns
Type Description
Parser<LbTrafficExtension>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasMetadata()

public boolean hasMetadata()

Optional. The metadata provided here is included in the ProcessingRequest.metadata_context.filter_metadata map field. The metadata is available under the key com.google.lb_traffic_extension.<resource_name>. The following variables are supported in the metadata:

{forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.

.google.protobuf.Struct metadata = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the metadata field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

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 LbTrafficExtension.Builder newBuilderForType()
Returns
Type Description
LbTrafficExtension.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public LbTrafficExtension.Builder toBuilder()
Returns
Type Description
LbTrafficExtension.Builder

writeTo(CodedOutputStream output)

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