Class WeightedBackendService (1.56.0)

public final class WeightedBackendService extends GeneratedMessageV3 implements WeightedBackendServiceOrBuilder

In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple backend services. The volume of traffic for each backend service is proportional to the weight specified in each WeightedBackendService

Protobuf type google.cloud.compute.v1.WeightedBackendService

Static Fields

BACKEND_SERVICE_FIELD_NUMBER

public static final int BACKEND_SERVICE_FIELD_NUMBER
Field Value
Type Description
int

HEADER_ACTION_FIELD_NUMBER

public static final int HEADER_ACTION_FIELD_NUMBER
Field Value
Type Description
int

WEIGHT_FIELD_NUMBER

public static final int WEIGHT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WeightedBackendService getDefaultInstance()
Returns
Type Description
WeightedBackendService

getDescriptor()

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

newBuilder()

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

newBuilder(WeightedBackendService prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBackendService()

public String getBackendService()

The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the load balancer applies any relevant headerActions specified as part of this backendServiceWeight.

optional string backend_service = 306946058;

Returns
Type Description
String

The backendService.

getBackendServiceBytes()

public ByteString getBackendServiceBytes()

The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the load balancer applies any relevant headerActions specified as part of this backendServiceWeight.

optional string backend_service = 306946058;

Returns
Type Description
ByteString

The bytes for backendService.

getDefaultInstanceForType()

public WeightedBackendService getDefaultInstanceForType()
Returns
Type Description
WeightedBackendService

getHeaderAction()

public HttpHeaderAction getHeaderAction()

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
Type Description
HttpHeaderAction

The headerAction.

getHeaderActionOrBuilder()

public HttpHeaderActionOrBuilder getHeaderActionOrBuilder()

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
Type Description
HttpHeaderActionOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getWeight()

public int getWeight()

Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. The value must be from 0 to 1000.

optional uint32 weight = 282149496;

Returns
Type Description
int

The weight.

hasBackendService()

public boolean hasBackendService()

The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the load balancer applies any relevant headerActions specified as part of this backendServiceWeight.

optional string backend_service = 306946058;

Returns
Type Description
boolean

Whether the backendService field is set.

hasHeaderAction()

public boolean hasHeaderAction()

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
Type Description
boolean

Whether the headerAction field is set.

hasWeight()

public boolean hasWeight()

Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. The value must be from 0 to 1000.

optional uint32 weight = 282149496;

Returns
Type Description
boolean

Whether the weight field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public WeightedBackendService.Builder newBuilderForType()
Returns
Type Description
WeightedBackendService.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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