Class ServiceLbPolicy (0.23.0)

public final class ServiceLbPolicy extends GeneratedMessageV3 implements ServiceLbPolicyOrBuilder

ServiceLbPolicy holds global load balancing and traffic distribution configuration that can be applied to a BackendService.

Protobuf type google.cloud.networkservices.v1.ServiceLbPolicy

Static Fields

AUTO_CAPACITY_DRAIN_FIELD_NUMBER

public static final int AUTO_CAPACITY_DRAIN_FIELD_NUMBER
Field Value
Type Description
int

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

FAILOVER_CONFIG_FIELD_NUMBER

public static final int FAILOVER_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LOAD_BALANCING_ALGORITHM_FIELD_NUMBER

public static final int LOAD_BALANCING_ALGORITHM_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 ServiceLbPolicy getDefaultInstance()
Returns
Type Description
ServiceLbPolicy

getDescriptor()

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

newBuilder()

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

newBuilder(ServiceLbPolicy prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Set of label tags associated with the ServiceLbPolicy resource.

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

getAutoCapacityDrain()

public ServiceLbPolicy.AutoCapacityDrain getAutoCapacityDrain()

Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.

.google.cloud.networkservices.v1.ServiceLbPolicy.AutoCapacityDrain auto_capacity_drain = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ServiceLbPolicy.AutoCapacityDrain

The autoCapacityDrain.

getAutoCapacityDrainOrBuilder()

public ServiceLbPolicy.AutoCapacityDrainOrBuilder getAutoCapacityDrainOrBuilder()

Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.

.google.cloud.networkservices.v1.ServiceLbPolicy.AutoCapacityDrain auto_capacity_drain = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ServiceLbPolicy.AutoCapacityDrainOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when this 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 this resource was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public ServiceLbPolicy getDefaultInstanceForType()
Returns
Type Description
ServiceLbPolicy

getDescription()

public String getDescription()

Optional. A free-text description of the resource. Max length 1024 characters.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. A free-text description of the resource. Max length 1024 characters.

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

Returns
Type Description
ByteString

The bytes for description.

getFailoverConfig()

public ServiceLbPolicy.FailoverConfig getFailoverConfig()

Optional. Configuration related to health based failover.

.google.cloud.networkservices.v1.ServiceLbPolicy.FailoverConfig failover_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ServiceLbPolicy.FailoverConfig

The failoverConfig.

getFailoverConfigOrBuilder()

public ServiceLbPolicy.FailoverConfigOrBuilder getFailoverConfigOrBuilder()

Optional. Configuration related to health based failover.

.google.cloud.networkservices.v1.ServiceLbPolicy.FailoverConfig failover_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ServiceLbPolicy.FailoverConfigOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Set of label tags associated with the ServiceLbPolicy resource.

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

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Set of label tags associated with the ServiceLbPolicy resource.

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 label tags associated with the ServiceLbPolicy resource.

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 label tags associated with the ServiceLbPolicy resource.

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

Parameter
Name Description
key String
Returns
Type Description
String

getLoadBalancingAlgorithm()

public ServiceLbPolicy.LoadBalancingAlgorithm getLoadBalancingAlgorithm()

Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION.

.google.cloud.networkservices.v1.ServiceLbPolicy.LoadBalancingAlgorithm load_balancing_algorithm = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ServiceLbPolicy.LoadBalancingAlgorithm

The loadBalancingAlgorithm.

getLoadBalancingAlgorithmValue()

public int getLoadBalancingAlgorithmValue()

Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION.

.google.cloud.networkservices.v1.ServiceLbPolicy.LoadBalancingAlgorithm load_balancing_algorithm = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for loadBalancingAlgorithm.

getName()

public String getName()

Identifier. Name of the ServiceLbPolicy resource. It matches pattern projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Name of the ServiceLbPolicy resource. It matches pattern projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when this resource was last 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 this resource was last updated.

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

Returns
Type Description
TimestampOrBuilder

hasAutoCapacityDrain()

public boolean hasAutoCapacityDrain()

Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.

.google.cloud.networkservices.v1.ServiceLbPolicy.AutoCapacityDrain auto_capacity_drain = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the autoCapacityDrain field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp when this 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.

hasFailoverConfig()

public boolean hasFailoverConfig()

Optional. Configuration related to health based failover.

.google.cloud.networkservices.v1.ServiceLbPolicy.FailoverConfig failover_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the failoverConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when this resource was last 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 ServiceLbPolicy.Builder newBuilderForType()
Returns
Type Description
ServiceLbPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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