Class WeightedBackendService.Builder (1.45.0)

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

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WeightedBackendService.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WeightedBackendService.Builder
Overrides

build()

public WeightedBackendService build()
Returns
TypeDescription
WeightedBackendService

buildPartial()

public WeightedBackendService buildPartial()
Returns
TypeDescription
WeightedBackendService

clear()

public WeightedBackendService.Builder clear()
Returns
TypeDescription
WeightedBackendService.Builder
Overrides

clearBackendService()

public WeightedBackendService.Builder clearBackendService()

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
TypeDescription
WeightedBackendService.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public WeightedBackendService.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
WeightedBackendService.Builder
Overrides

clearHeaderAction()

public WeightedBackendService.Builder clearHeaderAction()

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
TypeDescription
WeightedBackendService.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public WeightedBackendService.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
WeightedBackendService.Builder
Overrides

clearWeight()

public WeightedBackendService.Builder clearWeight()

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
TypeDescription
WeightedBackendService.Builder

This builder for chaining.

clone()

public WeightedBackendService.Builder clone()
Returns
TypeDescription
WeightedBackendService.Builder
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
TypeDescription
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
TypeDescription
ByteString

The bytes for backendService.

getDefaultInstanceForType()

public WeightedBackendService getDefaultInstanceForType()
Returns
TypeDescription
WeightedBackendService

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
HttpHeaderAction

The headerAction.

getHeaderActionBuilder()

public HttpHeaderAction.Builder getHeaderActionBuilder()

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
TypeDescription
HttpHeaderAction.Builder

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
TypeDescription
HttpHeaderActionOrBuilder

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the weight field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(WeightedBackendService other)

public WeightedBackendService.Builder mergeFrom(WeightedBackendService other)
Parameter
NameDescription
otherWeightedBackendService
Returns
TypeDescription
WeightedBackendService.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WeightedBackendService.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WeightedBackendService.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public WeightedBackendService.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
WeightedBackendService.Builder
Overrides

mergeHeaderAction(HttpHeaderAction value)

public WeightedBackendService.Builder mergeHeaderAction(HttpHeaderAction value)

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;

Parameter
NameDescription
valueHttpHeaderAction
Returns
TypeDescription
WeightedBackendService.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WeightedBackendService.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WeightedBackendService.Builder
Overrides

setBackendService(String value)

public WeightedBackendService.Builder setBackendService(String value)

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;

Parameter
NameDescription
valueString

The backendService to set.

Returns
TypeDescription
WeightedBackendService.Builder

This builder for chaining.

setBackendServiceBytes(ByteString value)

public WeightedBackendService.Builder setBackendServiceBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for backendService to set.

Returns
TypeDescription
WeightedBackendService.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public WeightedBackendService.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WeightedBackendService.Builder
Overrides

setHeaderAction(HttpHeaderAction value)

public WeightedBackendService.Builder setHeaderAction(HttpHeaderAction value)

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;

Parameter
NameDescription
valueHttpHeaderAction
Returns
TypeDescription
WeightedBackendService.Builder

setHeaderAction(HttpHeaderAction.Builder builderForValue)

public WeightedBackendService.Builder setHeaderAction(HttpHeaderAction.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueHttpHeaderAction.Builder
Returns
TypeDescription
WeightedBackendService.Builder

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

public WeightedBackendService.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
WeightedBackendService.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final WeightedBackendService.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WeightedBackendService.Builder
Overrides

setWeight(int value)

public WeightedBackendService.Builder setWeight(int value)

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;

Parameter
NameDescription
valueint

The weight to set.

Returns
TypeDescription
WeightedBackendService.Builder

This builder for chaining.