Class BackendService.Builder (1.12.1)

public static final class BackendService.Builder extends GeneratedMessageV3.Builder<BackendService.Builder> implements BackendServiceOrBuilder

Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * Global * Regional For more information, see Backend Services.

Protobuf type google.cloud.compute.v1.BackendService

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BackendService.Builder

Implements

BackendServiceOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllBackends(Iterable<? extends Backend> values)

public BackendService.Builder addAllBackends(Iterable<? extends Backend> values)

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Parameter

Name	Description
values	`Iterable<? extends com.google.cloud.compute.v1.Backend>`

Returns

Type	Description
BackendService.Builder

addAllCustomRequestHeaders(Iterable<String> values)

public BackendService.Builder addAllCustomRequestHeaders(Iterable<String> values)

Headers that the load balancer adds to proxied requests. See Creating custom headers.

repeated string custom_request_headers = 27977992;

Parameter

Name	Description
values	`Iterable<String>` The customRequestHeaders to add.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

addAllCustomResponseHeaders(Iterable<String> values)

public BackendService.Builder addAllCustomResponseHeaders(Iterable<String> values)

Headers that the load balancer adds to proxied responses. See Creating custom headers.

repeated string custom_response_headers = 387539094;

Parameter

Name	Description
values	`Iterable<String>` The customResponseHeaders to add.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

addAllHealthChecks(Iterable<String> values)

public BackendService.Builder addAllHealthChecks(Iterable<String> values)

The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.

repeated string health_checks = 448370606;

Parameter

Name	Description
values	`Iterable<String>` The healthChecks to add.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

addAllLocalityLbPolicies(Iterable<? extends BackendServiceLocalityLoadBalancingPolicyConfig> values)

public BackendService.Builder addAllLocalityLbPolicies(Iterable<? extends BackendServiceLocalityLoadBalancingPolicyConfig> values)

A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true.

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Parameter

Name	Description
values	`Iterable<? extends com.google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig>`

Returns

Type	Description
BackendService.Builder

addAllServiceBindings(Iterable<String> values)

public BackendService.Builder addAllServiceBindings(Iterable<String> values)

URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.

repeated string service_bindings = 133581016;

Parameter

Name	Description
values	`Iterable<String>` The serviceBindings to add.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

addBackends(Backend value)

public BackendService.Builder addBackends(Backend value)

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Parameter

Name	Description
value	`Backend`

Returns

Type	Description
BackendService.Builder

addBackends(Backend.Builder builderForValue)

public BackendService.Builder addBackends(Backend.Builder builderForValue)

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Parameter

Name	Description
builderForValue	`Backend.Builder`

Returns

Type	Description
BackendService.Builder

addBackends(int index, Backend value)

public BackendService.Builder addBackends(int index, Backend value)

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Parameters

Name	Description
index	`int`
value	`Backend`

Returns

Type	Description
BackendService.Builder

addBackends(int index, Backend.Builder builderForValue)

public BackendService.Builder addBackends(int index, Backend.Builder builderForValue)

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Parameters

Name	Description
index	`int`
builderForValue	`Backend.Builder`

Returns

Type	Description
BackendService.Builder

addBackendsBuilder()

public Backend.Builder addBackendsBuilder()

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Returns

Type	Description
Backend.Builder

addBackendsBuilder(int index)

public Backend.Builder addBackendsBuilder(int index)

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Backend.Builder

addCustomRequestHeaders(String value)

public BackendService.Builder addCustomRequestHeaders(String value)

Headers that the load balancer adds to proxied requests. See Creating custom headers.

repeated string custom_request_headers = 27977992;

Parameter

Name	Description
value	`String` The customRequestHeaders to add.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

addCustomRequestHeadersBytes(ByteString value)

public BackendService.Builder addCustomRequestHeadersBytes(ByteString value)

Headers that the load balancer adds to proxied requests. See Creating custom headers.

repeated string custom_request_headers = 27977992;

Parameter

Name	Description
value	`ByteString` The bytes of the customRequestHeaders to add.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

addCustomResponseHeaders(String value)

public BackendService.Builder addCustomResponseHeaders(String value)

Headers that the load balancer adds to proxied responses. See Creating custom headers.

repeated string custom_response_headers = 387539094;

Parameter

Name	Description
value	`String` The customResponseHeaders to add.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

addCustomResponseHeadersBytes(ByteString value)

public BackendService.Builder addCustomResponseHeadersBytes(ByteString value)

Headers that the load balancer adds to proxied responses. See Creating custom headers.

repeated string custom_response_headers = 387539094;

Parameter

Name	Description
value	`ByteString` The bytes of the customResponseHeaders to add.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

addHealthChecks(String value)

public BackendService.Builder addHealthChecks(String value)

repeated string health_checks = 448370606;

Parameter

Name	Description
value	`String` The healthChecks to add.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

addHealthChecksBytes(ByteString value)

public BackendService.Builder addHealthChecksBytes(ByteString value)

repeated string health_checks = 448370606;

Parameter

Name	Description
value	`ByteString` The bytes of the healthChecks to add.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

addLocalityLbPolicies(BackendServiceLocalityLoadBalancingPolicyConfig value)

public BackendService.Builder addLocalityLbPolicies(BackendServiceLocalityLoadBalancingPolicyConfig value)

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Parameter

Name	Description
value	`BackendServiceLocalityLoadBalancingPolicyConfig`

Returns

Type	Description
BackendService.Builder

addLocalityLbPolicies(BackendServiceLocalityLoadBalancingPolicyConfig.Builder builderForValue)

public BackendService.Builder addLocalityLbPolicies(BackendServiceLocalityLoadBalancingPolicyConfig.Builder builderForValue)

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Parameter

Name	Description
builderForValue	`BackendServiceLocalityLoadBalancingPolicyConfig.Builder`

Returns

Type	Description
BackendService.Builder

addLocalityLbPolicies(int index, BackendServiceLocalityLoadBalancingPolicyConfig value)

public BackendService.Builder addLocalityLbPolicies(int index, BackendServiceLocalityLoadBalancingPolicyConfig value)

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Parameters

Name	Description
index	`int`
value	`BackendServiceLocalityLoadBalancingPolicyConfig`

Returns

Type	Description
BackendService.Builder

addLocalityLbPolicies(int index, BackendServiceLocalityLoadBalancingPolicyConfig.Builder builderForValue)

public BackendService.Builder addLocalityLbPolicies(int index, BackendServiceLocalityLoadBalancingPolicyConfig.Builder builderForValue)

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Parameters

Name	Description
index	`int`
builderForValue	`BackendServiceLocalityLoadBalancingPolicyConfig.Builder`

Returns

Type	Description
BackendService.Builder

addLocalityLbPoliciesBuilder()

public BackendServiceLocalityLoadBalancingPolicyConfig.Builder addLocalityLbPoliciesBuilder()

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Returns

Type	Description
BackendServiceLocalityLoadBalancingPolicyConfig.Builder

addLocalityLbPoliciesBuilder(int index)

public BackendServiceLocalityLoadBalancingPolicyConfig.Builder addLocalityLbPoliciesBuilder(int index)

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendServiceLocalityLoadBalancingPolicyConfig.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BackendService.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
BackendService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addServiceBindings(String value)

public BackendService.Builder addServiceBindings(String value)

URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.

repeated string service_bindings = 133581016;

Parameter

Name	Description
value	`String` The serviceBindings to add.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

addServiceBindingsBytes(ByteString value)

public BackendService.Builder addServiceBindingsBytes(ByteString value)

URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.

repeated string service_bindings = 133581016;

Parameter

Name	Description
value	`ByteString` The bytes of the serviceBindings to add.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

build()

public BackendService build()

Returns

Type	Description
BackendService

buildPartial()

public BackendService buildPartial()

Returns

Type	Description
BackendService

clear()

public BackendService.Builder clear()

Returns

Type	Description
BackendService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAffinityCookieTtlSec()

public BackendService.Builder clearAffinityCookieTtlSec()

Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

optional int32 affinity_cookie_ttl_sec = 369996954;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearBackends()

public BackendService.Builder clearBackends()

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Returns

Type	Description
BackendService.Builder

clearCdnPolicy()

public BackendService.Builder clearCdnPolicy()

Cloud CDN configuration for this BackendService. Only available for specified load balancer types.

optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;

Returns

Type	Description
BackendService.Builder

clearCircuitBreakers()

public BackendService.Builder clearCircuitBreakers()

optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;

Returns

Type	Description
BackendService.Builder

clearConnectionDraining()

public BackendService.Builder clearConnectionDraining()

optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;

Returns

Type	Description
BackendService.Builder

clearConnectionTrackingPolicy()

public BackendService.Builder clearConnectionTrackingPolicy()

Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.

optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;

Returns

Type	Description
BackendService.Builder

clearConsistentHash()

public BackendService.Builder clearConsistentHash()

Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;

Returns

Type	Description
BackendService.Builder

clearCreationTimestamp()

public BackendService.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearCustomRequestHeaders()

public BackendService.Builder clearCustomRequestHeaders()

Headers that the load balancer adds to proxied requests. See Creating custom headers.

repeated string custom_request_headers = 27977992;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearCustomResponseHeaders()

public BackendService.Builder clearCustomResponseHeaders()

Headers that the load balancer adds to proxied responses. See Creating custom headers.

repeated string custom_response_headers = 387539094;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearDescription()

public BackendService.Builder clearDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearEdgeSecurityPolicy()

public BackendService.Builder clearEdgeSecurityPolicy()

[Output Only] The resource URL for the edge security policy associated with this backend service.

optional string edge_security_policy = 41036943;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearEnableCDN()

public BackendService.Builder clearEnableCDN()

If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.

optional bool enable_c_d_n = 250733499;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearFailoverPolicy()

public BackendService.Builder clearFailoverPolicy()

Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing.

optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;

Returns

Type	Description
BackendService.Builder

clearField(Descriptors.FieldDescriptor field)

public BackendService.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
BackendService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFingerprint()

public BackendService.Builder clearFingerprint()

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.

optional string fingerprint = 234678500;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearHealthChecks()

public BackendService.Builder clearHealthChecks()

repeated string health_checks = 448370606;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearIap()

public BackendService.Builder clearIap()

The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.

optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;

Returns

Type	Description
BackendService.Builder

clearId()

public BackendService.Builder clearId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearKind()

public BackendService.Builder clearKind()

[Output Only] Type of resource. Always compute#backendService for backend services.

optional string kind = 3292052;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearLoadBalancingScheme()

public BackendService.Builder clearLoadBalancingScheme()

Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer. Check the LoadBalancingScheme enum for the list of possible values.

optional string load_balancing_scheme = 363890244;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearLocalityLbPolicies()

public BackendService.Builder clearLocalityLbPolicies()

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Returns

Type	Description
BackendService.Builder

clearLocalityLbPolicy()

public BackendService.Builder clearLocalityLbPolicy()

The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Check the LocalityLbPolicy enum for the list of possible values.

optional string locality_lb_policy = 131431487;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearLogConfig()

public BackendService.Builder clearLogConfig()

This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;

Returns

Type	Description
BackendService.Builder

clearMaxStreamDuration()

public BackendService.Builder clearMaxStreamDuration()

Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.

optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;

Returns

Type	Description
BackendService.Builder

clearName()

public BackendService.Builder clearName()

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearNetwork()

public BackendService.Builder clearNetwork()

The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.

optional string network = 232872494;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BackendService.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
BackendService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOutlierDetection()

public BackendService.Builder clearOutlierDetection()

Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;

Returns

Type	Description
BackendService.Builder

clearPort()

public BackendService.Builder clearPort()

Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.

optional int32 port = 3446913;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearPortName()

public BackendService.Builder clearPortName()

A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.

optional string port_name = 41534345;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearProtocol()

public BackendService.Builder clearProtocol()

The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. Check the Protocol enum for the list of possible values.

optional string protocol = 84577944;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearRegion()

public BackendService.Builder clearRegion()

[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string region = 138946292;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearSecurityPolicy()

public BackendService.Builder clearSecurityPolicy()

[Output Only] The resource URL for the security policy associated with this backend service.

optional string security_policy = 171082513;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearSecuritySettings()

public BackendService.Builder clearSecuritySettings()

This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;

Returns

Type	Description
BackendService.Builder

clearSelfLink()

public BackendService.Builder clearSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearServiceBindings()

public BackendService.Builder clearServiceBindings()

URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.

repeated string service_bindings = 133581016;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearSessionAffinity()

public BackendService.Builder clearSessionAffinity()

Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity. Check the SessionAffinity enum for the list of possible values.

optional string session_affinity = 463888561;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clearSubsetting()

public BackendService.Builder clearSubsetting()

optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;

Returns

Type	Description
BackendService.Builder

clearTimeoutSec()

public BackendService.Builder clearTimeoutSec()

The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.

optional int32 timeout_sec = 79994995;

Returns

Type	Description
BackendService.Builder	This builder for chaining.

clone()

public BackendService.Builder clone()

Returns

Type	Description
BackendService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAffinityCookieTtlSec()

public int getAffinityCookieTtlSec()

optional int32 affinity_cookie_ttl_sec = 369996954;

Returns

Type	Description
int	The affinityCookieTtlSec.

getBackends(int index)

public Backend getBackends(int index)

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Backend

getBackendsBuilder(int index)

public Backend.Builder getBackendsBuilder(int index)

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Backend.Builder

getBackendsBuilderList()

public List<Backend.Builder> getBackendsBuilderList()

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Returns

Type	Description
List<Builder>

getBackendsCount()

public int getBackendsCount()

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Returns

Type	Description
int

getBackendsList()

public List<Backend> getBackendsList()

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Returns

Type	Description
List<Backend>

getBackendsOrBuilder(int index)

public BackendOrBuilder getBackendsOrBuilder(int index)

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendOrBuilder

getBackendsOrBuilderList()

public List<? extends BackendOrBuilder> getBackendsOrBuilderList()

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Returns

Type	Description
List<? extends com.google.cloud.compute.v1.BackendOrBuilder>

getCdnPolicy()

public BackendServiceCdnPolicy getCdnPolicy()

Cloud CDN configuration for this BackendService. Only available for specified load balancer types.

optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;

Returns

Type	Description
BackendServiceCdnPolicy	The cdnPolicy.

getCdnPolicyBuilder()

public BackendServiceCdnPolicy.Builder getCdnPolicyBuilder()

Cloud CDN configuration for this BackendService. Only available for specified load balancer types.

optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;

Returns

Type	Description
BackendServiceCdnPolicy.Builder

getCdnPolicyOrBuilder()

public BackendServiceCdnPolicyOrBuilder getCdnPolicyOrBuilder()

Cloud CDN configuration for this BackendService. Only available for specified load balancer types.

optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;

Returns

Type	Description
BackendServiceCdnPolicyOrBuilder

getCircuitBreakers()

public CircuitBreakers getCircuitBreakers()

optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;

Returns

Type	Description
CircuitBreakers	The circuitBreakers.

getCircuitBreakersBuilder()

public CircuitBreakers.Builder getCircuitBreakersBuilder()

optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;

Returns

Type	Description
CircuitBreakers.Builder

getCircuitBreakersOrBuilder()

public CircuitBreakersOrBuilder getCircuitBreakersOrBuilder()

optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;

Returns

Type	Description
CircuitBreakersOrBuilder

getConnectionDraining()

public ConnectionDraining getConnectionDraining()

optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;

Returns

Type	Description
ConnectionDraining	The connectionDraining.

getConnectionDrainingBuilder()

public ConnectionDraining.Builder getConnectionDrainingBuilder()

optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;

Returns

Type	Description
ConnectionDraining.Builder

getConnectionDrainingOrBuilder()

public ConnectionDrainingOrBuilder getConnectionDrainingOrBuilder()

optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;

Returns

Type	Description
ConnectionDrainingOrBuilder

getConnectionTrackingPolicy()

public BackendServiceConnectionTrackingPolicy getConnectionTrackingPolicy()

Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.

optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;

Returns

Type	Description
BackendServiceConnectionTrackingPolicy	The connectionTrackingPolicy.

getConnectionTrackingPolicyBuilder()

public BackendServiceConnectionTrackingPolicy.Builder getConnectionTrackingPolicyBuilder()

Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.

optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;

Returns

Type	Description
BackendServiceConnectionTrackingPolicy.Builder

getConnectionTrackingPolicyOrBuilder()

public BackendServiceConnectionTrackingPolicyOrBuilder getConnectionTrackingPolicyOrBuilder()

Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.

optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;

Returns

Type	Description
BackendServiceConnectionTrackingPolicyOrBuilder

getConsistentHash()

public ConsistentHashLoadBalancerSettings getConsistentHash()

optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;

Returns

Type	Description
ConsistentHashLoadBalancerSettings	The consistentHash.

getConsistentHashBuilder()

public ConsistentHashLoadBalancerSettings.Builder getConsistentHashBuilder()

optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

getConsistentHashOrBuilder()

public ConsistentHashLoadBalancerSettingsOrBuilder getConsistentHashOrBuilder()

optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;

Returns

Type	Description
ConsistentHashLoadBalancerSettingsOrBuilder

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns

Type	Description
String	The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns

Type	Description
ByteString	The bytes for creationTimestamp.

getCustomRequestHeaders(int index)

public String getCustomRequestHeaders(int index)

Headers that the load balancer adds to proxied requests. See Creating custom headers.

repeated string custom_request_headers = 27977992;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The customRequestHeaders at the given index.

getCustomRequestHeadersBytes(int index)

public ByteString getCustomRequestHeadersBytes(int index)

Headers that the load balancer adds to proxied requests. See Creating custom headers.

repeated string custom_request_headers = 27977992;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the customRequestHeaders at the given index.

getCustomRequestHeadersCount()

public int getCustomRequestHeadersCount()

Headers that the load balancer adds to proxied requests. See Creating custom headers.

repeated string custom_request_headers = 27977992;

Returns

Type	Description
int	The count of customRequestHeaders.

getCustomRequestHeadersList()

public ProtocolStringList getCustomRequestHeadersList()

Headers that the load balancer adds to proxied requests. See Creating custom headers.

repeated string custom_request_headers = 27977992;

Returns

Type	Description
ProtocolStringList	A list containing the customRequestHeaders.

getCustomResponseHeaders(int index)

public String getCustomResponseHeaders(int index)

Headers that the load balancer adds to proxied responses. See Creating custom headers.

repeated string custom_response_headers = 387539094;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The customResponseHeaders at the given index.

getCustomResponseHeadersBytes(int index)

public ByteString getCustomResponseHeadersBytes(int index)

Headers that the load balancer adds to proxied responses. See Creating custom headers.

repeated string custom_response_headers = 387539094;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the customResponseHeaders at the given index.

getCustomResponseHeadersCount()

public int getCustomResponseHeadersCount()

Headers that the load balancer adds to proxied responses. See Creating custom headers.

repeated string custom_response_headers = 387539094;

Returns

Type	Description
int	The count of customResponseHeaders.

getCustomResponseHeadersList()

public ProtocolStringList getCustomResponseHeadersList()

Headers that the load balancer adds to proxied responses. See Creating custom headers.

repeated string custom_response_headers = 387539094;

Returns

Type	Description
ProtocolStringList	A list containing the customResponseHeaders.

getDefaultInstanceForType()

public BackendService getDefaultInstanceForType()

Returns

Type	Description
BackendService

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns

Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEdgeSecurityPolicy()

public String getEdgeSecurityPolicy()

[Output Only] The resource URL for the edge security policy associated with this backend service.

optional string edge_security_policy = 41036943;

Returns

Type	Description
String	The edgeSecurityPolicy.

getEdgeSecurityPolicyBytes()

public ByteString getEdgeSecurityPolicyBytes()

[Output Only] The resource URL for the edge security policy associated with this backend service.

optional string edge_security_policy = 41036943;

Returns

Type	Description
ByteString	The bytes for edgeSecurityPolicy.

getEnableCDN()

public boolean getEnableCDN()

If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.

optional bool enable_c_d_n = 250733499;

Returns

Type	Description
boolean	The enableCDN.

getFailoverPolicy()

public BackendServiceFailoverPolicy getFailoverPolicy()

optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;

Returns

Type	Description
BackendServiceFailoverPolicy	The failoverPolicy.

getFailoverPolicyBuilder()

public BackendServiceFailoverPolicy.Builder getFailoverPolicyBuilder()

optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;

Returns

Type	Description
BackendServiceFailoverPolicy.Builder

getFailoverPolicyOrBuilder()

public BackendServiceFailoverPolicyOrBuilder getFailoverPolicyOrBuilder()

optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;

Returns

Type	Description
BackendServiceFailoverPolicyOrBuilder

getFingerprint()

public String getFingerprint()

optional string fingerprint = 234678500;

Returns

Type	Description
String	The fingerprint.

getFingerprintBytes()

public ByteString getFingerprintBytes()

optional string fingerprint = 234678500;

Returns

Type	Description
ByteString	The bytes for fingerprint.

getHealthChecks(int index)

public String getHealthChecks(int index)

repeated string health_checks = 448370606;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The healthChecks at the given index.

getHealthChecksBytes(int index)

public ByteString getHealthChecksBytes(int index)

repeated string health_checks = 448370606;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the healthChecks at the given index.

getHealthChecksCount()

public int getHealthChecksCount()

repeated string health_checks = 448370606;

Returns

Type	Description
int	The count of healthChecks.

getHealthChecksList()

public ProtocolStringList getHealthChecksList()

repeated string health_checks = 448370606;

Returns

Type	Description
ProtocolStringList	A list containing the healthChecks.

getIap()

public BackendServiceIAP getIap()

The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.

optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;

Returns

Type	Description
BackendServiceIAP	The iap.

getIapBuilder()

public BackendServiceIAP.Builder getIapBuilder()

The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.

optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;

Returns

Type	Description
BackendServiceIAP.Builder

getIapOrBuilder()

public BackendServiceIAPOrBuilder getIapOrBuilder()

The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.

optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;

Returns

Type	Description
BackendServiceIAPOrBuilder

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns

Type	Description
long	The id.

getKind()

public String getKind()

[Output Only] Type of resource. Always compute#backendService for backend services.

optional string kind = 3292052;

Returns

Type	Description
String	The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of resource. Always compute#backendService for backend services.

optional string kind = 3292052;

Returns

Type	Description
ByteString	The bytes for kind.

getLoadBalancingScheme()

public String getLoadBalancingScheme()

optional string load_balancing_scheme = 363890244;

Returns

Type	Description
String	The loadBalancingScheme.

getLoadBalancingSchemeBytes()

public ByteString getLoadBalancingSchemeBytes()

optional string load_balancing_scheme = 363890244;

Returns

Type	Description
ByteString	The bytes for loadBalancingScheme.

getLocalityLbPolicies(int index)

public BackendServiceLocalityLoadBalancingPolicyConfig getLocalityLbPolicies(int index)

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendServiceLocalityLoadBalancingPolicyConfig

getLocalityLbPoliciesBuilder(int index)

public BackendServiceLocalityLoadBalancingPolicyConfig.Builder getLocalityLbPoliciesBuilder(int index)

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendServiceLocalityLoadBalancingPolicyConfig.Builder

getLocalityLbPoliciesBuilderList()

public List<BackendServiceLocalityLoadBalancingPolicyConfig.Builder> getLocalityLbPoliciesBuilderList()

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Returns

Type	Description
List<Builder>

getLocalityLbPoliciesCount()

public int getLocalityLbPoliciesCount()

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Returns

Type	Description
int

getLocalityLbPoliciesList()

public List<BackendServiceLocalityLoadBalancingPolicyConfig> getLocalityLbPoliciesList()

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Returns

Type	Description
List<BackendServiceLocalityLoadBalancingPolicyConfig>

getLocalityLbPoliciesOrBuilder(int index)

public BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder getLocalityLbPoliciesOrBuilder(int index)

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder

getLocalityLbPoliciesOrBuilderList()

public List<? extends BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder> getLocalityLbPoliciesOrBuilderList()

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Returns

Type	Description
List<? extends com.google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder>

getLocalityLbPolicy()

public String getLocalityLbPolicy()

optional string locality_lb_policy = 131431487;

Returns

Type	Description
String	The localityLbPolicy.

getLocalityLbPolicyBytes()

public ByteString getLocalityLbPolicyBytes()

optional string locality_lb_policy = 131431487;

Returns

Type	Description
ByteString	The bytes for localityLbPolicy.

getLogConfig()

public BackendServiceLogConfig getLogConfig()

This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;

Returns

Type	Description
BackendServiceLogConfig	The logConfig.

getLogConfigBuilder()

public BackendServiceLogConfig.Builder getLogConfigBuilder()

This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;

Returns

Type	Description
BackendServiceLogConfig.Builder

getLogConfigOrBuilder()

public BackendServiceLogConfigOrBuilder getLogConfigOrBuilder()

This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;

Returns

Type	Description
BackendServiceLogConfigOrBuilder

getMaxStreamDuration()

public Duration getMaxStreamDuration()

optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;

Returns

Type	Description
Duration	The maxStreamDuration.

getMaxStreamDurationBuilder()

public Duration.Builder getMaxStreamDurationBuilder()

optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;

Returns

Type	Description
Duration.Builder

getMaxStreamDurationOrBuilder()

public DurationOrBuilder getMaxStreamDurationOrBuilder()

optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;

Returns

Type	Description
DurationOrBuilder

getName()

public String getName()

optional string name = 3373707;

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

optional string name = 3373707;

Returns

Type	Description
ByteString	The bytes for name.

getNetwork()

public String getNetwork()

The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.

optional string network = 232872494;

Returns

Type	Description
String	The network.

getNetworkBytes()

public ByteString getNetworkBytes()

The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.

optional string network = 232872494;

Returns

Type	Description
ByteString	The bytes for network.

getOutlierDetection()

public OutlierDetection getOutlierDetection()

optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;

Returns

Type	Description
OutlierDetection	The outlierDetection.

getOutlierDetectionBuilder()

public OutlierDetection.Builder getOutlierDetectionBuilder()

optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;

Returns

Type	Description
OutlierDetection.Builder

getOutlierDetectionOrBuilder()

public OutlierDetectionOrBuilder getOutlierDetectionOrBuilder()

optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;

Returns

Type	Description
OutlierDetectionOrBuilder

getPort()

public int getPort()

Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.

optional int32 port = 3446913;

Returns

Type	Description
int	The port.

getPortName()

public String getPortName()

optional string port_name = 41534345;

Returns

Type	Description
String	The portName.

getPortNameBytes()

public ByteString getPortNameBytes()

optional string port_name = 41534345;

Returns

Type	Description
ByteString	The bytes for portName.

getProtocol()

public String getProtocol()

optional string protocol = 84577944;

Returns

Type	Description
String	The protocol.

getProtocolBytes()

public ByteString getProtocolBytes()

optional string protocol = 84577944;

Returns

Type	Description
ByteString	The bytes for protocol.

getRegion()

public String getRegion()

optional string region = 138946292;

Returns

Type	Description
String	The region.

getRegionBytes()

public ByteString getRegionBytes()

optional string region = 138946292;

Returns

Type	Description
ByteString	The bytes for region.

getSecurityPolicy()

public String getSecurityPolicy()

[Output Only] The resource URL for the security policy associated with this backend service.

optional string security_policy = 171082513;

Returns

Type	Description
String	The securityPolicy.

getSecurityPolicyBytes()

public ByteString getSecurityPolicyBytes()

[Output Only] The resource URL for the security policy associated with this backend service.

optional string security_policy = 171082513;

Returns

Type	Description
ByteString	The bytes for securityPolicy.

getSecuritySettings()

public SecuritySettings getSecuritySettings()

This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;

Returns

Type	Description
SecuritySettings	The securitySettings.

getSecuritySettingsBuilder()

public SecuritySettings.Builder getSecuritySettingsBuilder()

This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;

Returns

Type	Description
SecuritySettings.Builder

getSecuritySettingsOrBuilder()

public SecuritySettingsOrBuilder getSecuritySettingsOrBuilder()

This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;

Returns

Type	Description
SecuritySettingsOrBuilder

getSelfLink()

public String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns

Type	Description
String	The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns

Type	Description
ByteString	The bytes for selfLink.

getServiceBindings(int index)

public String getServiceBindings(int index)

URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.

repeated string service_bindings = 133581016;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The serviceBindings at the given index.

getServiceBindingsBytes(int index)

public ByteString getServiceBindingsBytes(int index)

URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.

repeated string service_bindings = 133581016;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the serviceBindings at the given index.

getServiceBindingsCount()

public int getServiceBindingsCount()

URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.

repeated string service_bindings = 133581016;

Returns

Type	Description
int	The count of serviceBindings.

getServiceBindingsList()

public ProtocolStringList getServiceBindingsList()

URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.

repeated string service_bindings = 133581016;

Returns

Type	Description
ProtocolStringList	A list containing the serviceBindings.

getSessionAffinity()

public String getSessionAffinity()

optional string session_affinity = 463888561;

Returns

Type	Description
String	The sessionAffinity.

getSessionAffinityBytes()

public ByteString getSessionAffinityBytes()

optional string session_affinity = 463888561;

Returns

Type	Description
ByteString	The bytes for sessionAffinity.

getSubsetting()

public Subsetting getSubsetting()

optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;

Returns

Type	Description
Subsetting	The subsetting.

getSubsettingBuilder()

public Subsetting.Builder getSubsettingBuilder()

optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;

Returns

Type	Description
Subsetting.Builder

getSubsettingOrBuilder()

public SubsettingOrBuilder getSubsettingOrBuilder()

optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;

Returns

Type	Description
SubsettingOrBuilder

getTimeoutSec()

public int getTimeoutSec()

optional int32 timeout_sec = 79994995;

Returns

Type	Description
int	The timeoutSec.

hasAffinityCookieTtlSec()

public boolean hasAffinityCookieTtlSec()

optional int32 affinity_cookie_ttl_sec = 369996954;

Returns

Type	Description
boolean	Whether the affinityCookieTtlSec field is set.

hasCdnPolicy()

public boolean hasCdnPolicy()

Cloud CDN configuration for this BackendService. Only available for specified load balancer types.

optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;

Returns

Type	Description
boolean	Whether the cdnPolicy field is set.

hasCircuitBreakers()

public boolean hasCircuitBreakers()

optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;

Returns

Type	Description
boolean	Whether the circuitBreakers field is set.

hasConnectionDraining()

public boolean hasConnectionDraining()

optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;

Returns

Type	Description
boolean	Whether the connectionDraining field is set.

hasConnectionTrackingPolicy()

public boolean hasConnectionTrackingPolicy()

Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.

optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;

Returns

Type	Description
boolean	Whether the connectionTrackingPolicy field is set.

hasConsistentHash()

public boolean hasConsistentHash()

optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;

Returns

Type	Description
boolean	Whether the consistentHash field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns

Type	Description
boolean	Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns

Type	Description
boolean	Whether the description field is set.

hasEdgeSecurityPolicy()

public boolean hasEdgeSecurityPolicy()

[Output Only] The resource URL for the edge security policy associated with this backend service.

optional string edge_security_policy = 41036943;

Returns

Type	Description
boolean	Whether the edgeSecurityPolicy field is set.

hasEnableCDN()

public boolean hasEnableCDN()

If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.

optional bool enable_c_d_n = 250733499;

Returns

Type	Description
boolean	Whether the enableCDN field is set.

hasFailoverPolicy()

public boolean hasFailoverPolicy()

optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;

Returns

Type	Description
boolean	Whether the failoverPolicy field is set.

hasFingerprint()

public boolean hasFingerprint()

optional string fingerprint = 234678500;

Returns

Type	Description
boolean	Whether the fingerprint field is set.

hasIap()

public boolean hasIap()

The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.

optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;

Returns

Type	Description
boolean	Whether the iap field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns

Type	Description
boolean	Whether the id field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of resource. Always compute#backendService for backend services.

optional string kind = 3292052;

Returns

Type	Description
boolean	Whether the kind field is set.

hasLoadBalancingScheme()

public boolean hasLoadBalancingScheme()

optional string load_balancing_scheme = 363890244;

Returns

Type	Description
boolean	Whether the loadBalancingScheme field is set.

hasLocalityLbPolicy()

public boolean hasLocalityLbPolicy()

optional string locality_lb_policy = 131431487;

Returns

Type	Description
boolean	Whether the localityLbPolicy field is set.

hasLogConfig()

public boolean hasLogConfig()

This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;

Returns

Type	Description
boolean	Whether the logConfig field is set.

hasMaxStreamDuration()

public boolean hasMaxStreamDuration()

optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;

Returns

Type	Description
boolean	Whether the maxStreamDuration field is set.

hasName()

public boolean hasName()

optional string name = 3373707;

Returns

Type	Description
boolean	Whether the name field is set.

hasNetwork()

public boolean hasNetwork()

The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.

optional string network = 232872494;

Returns

Type	Description
boolean	Whether the network field is set.

hasOutlierDetection()

public boolean hasOutlierDetection()

optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;

Returns

Type	Description
boolean	Whether the outlierDetection field is set.

hasPort()

public boolean hasPort()

Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.

optional int32 port = 3446913;

Returns

Type	Description
boolean	Whether the port field is set.

hasPortName()

public boolean hasPortName()

optional string port_name = 41534345;

Returns

Type	Description
boolean	Whether the portName field is set.

hasProtocol()

public boolean hasProtocol()

optional string protocol = 84577944;

Returns

Type	Description
boolean	Whether the protocol field is set.

hasRegion()

public boolean hasRegion()

optional string region = 138946292;

Returns

Type	Description
boolean	Whether the region field is set.

hasSecurityPolicy()

public boolean hasSecurityPolicy()

[Output Only] The resource URL for the security policy associated with this backend service.

optional string security_policy = 171082513;

Returns

Type	Description
boolean	Whether the securityPolicy field is set.

hasSecuritySettings()

public boolean hasSecuritySettings()

This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;

Returns

Type	Description
boolean	Whether the securitySettings field is set.

hasSelfLink()

public boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns

Type	Description
boolean	Whether the selfLink field is set.

hasSessionAffinity()

public boolean hasSessionAffinity()

optional string session_affinity = 463888561;

Returns

Type	Description
boolean	Whether the sessionAffinity field is set.

hasSubsetting()

public boolean hasSubsetting()

optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;

Returns

Type	Description
boolean	Whether the subsetting field is set.

hasTimeoutSec()

public boolean hasTimeoutSec()

optional int32 timeout_sec = 79994995;

Returns

Type	Description
boolean	Whether the timeoutSec field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCdnPolicy(BackendServiceCdnPolicy value)

public BackendService.Builder mergeCdnPolicy(BackendServiceCdnPolicy value)

Cloud CDN configuration for this BackendService. Only available for specified load balancer types.

optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;

Parameter

Name	Description
value	`BackendServiceCdnPolicy`

Returns

Type	Description
BackendService.Builder

mergeCircuitBreakers(CircuitBreakers value)

public BackendService.Builder mergeCircuitBreakers(CircuitBreakers value)

optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;

Parameter

Name	Description
value	`CircuitBreakers`

Returns

Type	Description
BackendService.Builder

mergeConnectionDraining(ConnectionDraining value)

public BackendService.Builder mergeConnectionDraining(ConnectionDraining value)

optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;

Parameter

Name	Description
value	`ConnectionDraining`

Returns

Type	Description
BackendService.Builder

mergeConnectionTrackingPolicy(BackendServiceConnectionTrackingPolicy value)

public BackendService.Builder mergeConnectionTrackingPolicy(BackendServiceConnectionTrackingPolicy value)

Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.

optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;

Parameter

Name	Description
value	`BackendServiceConnectionTrackingPolicy`

Returns

Type	Description
BackendService.Builder

mergeConsistentHash(ConsistentHashLoadBalancerSettings value)

public BackendService.Builder mergeConsistentHash(ConsistentHashLoadBalancerSettings value)

optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;

Parameter

Name	Description
value	`ConsistentHashLoadBalancerSettings`

Returns

Type	Description
BackendService.Builder

mergeFailoverPolicy(BackendServiceFailoverPolicy value)

public BackendService.Builder mergeFailoverPolicy(BackendServiceFailoverPolicy value)

optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;

Parameter

Name	Description
value	`BackendServiceFailoverPolicy`

Returns

Type	Description
BackendService.Builder

mergeFrom(BackendService other)

public BackendService.Builder mergeFrom(BackendService other)

Parameter

Name	Description
other	`BackendService`

Returns

Type	Description
BackendService.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BackendService.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
BackendService.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public BackendService.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
BackendService.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeIap(BackendServiceIAP value)

public BackendService.Builder mergeIap(BackendServiceIAP value)

The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.

optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;

Parameter

Name	Description
value	`BackendServiceIAP`

Returns

Type	Description
BackendService.Builder

mergeLogConfig(BackendServiceLogConfig value)

public BackendService.Builder mergeLogConfig(BackendServiceLogConfig value)

This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;

Parameter

Name	Description
value	`BackendServiceLogConfig`

Returns

Type	Description
BackendService.Builder

mergeMaxStreamDuration(Duration value)

public BackendService.Builder mergeMaxStreamDuration(Duration value)

optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;

Parameter

Name	Description
value	`Duration`

Returns

Type	Description
BackendService.Builder

mergeOutlierDetection(OutlierDetection value)

public BackendService.Builder mergeOutlierDetection(OutlierDetection value)

optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;

Parameter

Name	Description
value	`OutlierDetection`

Returns

Type	Description
BackendService.Builder

mergeSecuritySettings(SecuritySettings value)

public BackendService.Builder mergeSecuritySettings(SecuritySettings value)

This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;

Parameter

Name	Description
value	`SecuritySettings`

Returns

Type	Description
BackendService.Builder

mergeSubsetting(Subsetting value)

public BackendService.Builder mergeSubsetting(Subsetting value)

optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;

Parameter

Name	Description
value	`Subsetting`

Returns

Type	Description
BackendService.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BackendService.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
BackendService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeBackends(int index)

public BackendService.Builder removeBackends(int index)

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendService.Builder

removeLocalityLbPolicies(int index)

public BackendService.Builder removeLocalityLbPolicies(int index)

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BackendService.Builder

setAffinityCookieTtlSec(int value)

public BackendService.Builder setAffinityCookieTtlSec(int value)

optional int32 affinity_cookie_ttl_sec = 369996954;

Parameter

Name	Description
value	`int` The affinityCookieTtlSec to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setBackends(int index, Backend value)

public BackendService.Builder setBackends(int index, Backend value)

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Parameters

Name	Description
index	`int`
value	`Backend`

Returns

Type	Description
BackendService.Builder

setBackends(int index, Backend.Builder builderForValue)

public BackendService.Builder setBackends(int index, Backend.Builder builderForValue)

The list of backends that serve this BackendService.

repeated .google.cloud.compute.v1.Backend backends = 510839903;

Parameters

Name	Description
index	`int`
builderForValue	`Backend.Builder`

Returns

Type	Description
BackendService.Builder

setCdnPolicy(BackendServiceCdnPolicy value)

public BackendService.Builder setCdnPolicy(BackendServiceCdnPolicy value)

Cloud CDN configuration for this BackendService. Only available for specified load balancer types.

optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;

Parameter

Name	Description
value	`BackendServiceCdnPolicy`

Returns

Type	Description
BackendService.Builder

setCdnPolicy(BackendServiceCdnPolicy.Builder builderForValue)

public BackendService.Builder setCdnPolicy(BackendServiceCdnPolicy.Builder builderForValue)

Cloud CDN configuration for this BackendService. Only available for specified load balancer types.

optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;

Parameter

Name	Description
builderForValue	`BackendServiceCdnPolicy.Builder`

Returns

Type	Description
BackendService.Builder

setCircuitBreakers(CircuitBreakers value)

public BackendService.Builder setCircuitBreakers(CircuitBreakers value)

optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;

Parameter

Name	Description
value	`CircuitBreakers`

Returns

Type	Description
BackendService.Builder

setCircuitBreakers(CircuitBreakers.Builder builderForValue)

public BackendService.Builder setCircuitBreakers(CircuitBreakers.Builder builderForValue)

optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;

Parameter

Name	Description
builderForValue	`CircuitBreakers.Builder`

Returns

Type	Description
BackendService.Builder

setConnectionDraining(ConnectionDraining value)

public BackendService.Builder setConnectionDraining(ConnectionDraining value)

optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;

Parameter

Name	Description
value	`ConnectionDraining`

Returns

Type	Description
BackendService.Builder

setConnectionDraining(ConnectionDraining.Builder builderForValue)

public BackendService.Builder setConnectionDraining(ConnectionDraining.Builder builderForValue)

optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;

Parameter

Name	Description
builderForValue	`ConnectionDraining.Builder`

Returns

Type	Description
BackendService.Builder

setConnectionTrackingPolicy(BackendServiceConnectionTrackingPolicy value)

public BackendService.Builder setConnectionTrackingPolicy(BackendServiceConnectionTrackingPolicy value)

Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.

optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;

Parameter

Name	Description
value	`BackendServiceConnectionTrackingPolicy`

Returns

Type	Description
BackendService.Builder

setConnectionTrackingPolicy(BackendServiceConnectionTrackingPolicy.Builder builderForValue)

public BackendService.Builder setConnectionTrackingPolicy(BackendServiceConnectionTrackingPolicy.Builder builderForValue)

Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.

optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;

Parameter

Name	Description
builderForValue	`BackendServiceConnectionTrackingPolicy.Builder`

Returns

Type	Description
BackendService.Builder

setConsistentHash(ConsistentHashLoadBalancerSettings value)

public BackendService.Builder setConsistentHash(ConsistentHashLoadBalancerSettings value)

optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;

Parameter

Name	Description
value	`ConsistentHashLoadBalancerSettings`

Returns

Type	Description
BackendService.Builder

setConsistentHash(ConsistentHashLoadBalancerSettings.Builder builderForValue)

public BackendService.Builder setConsistentHash(ConsistentHashLoadBalancerSettings.Builder builderForValue)

optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;

Parameter

Name	Description
builderForValue	`ConsistentHashLoadBalancerSettings.Builder`

Returns

Type	Description
BackendService.Builder

setCreationTimestamp(String value)

public BackendService.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter

Name	Description
value	`String` The creationTimestamp to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setCreationTimestampBytes(ByteString value)

public BackendService.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter

Name	Description
value	`ByteString` The bytes for creationTimestamp to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setCustomRequestHeaders(int index, String value)

public BackendService.Builder setCustomRequestHeaders(int index, String value)

Headers that the load balancer adds to proxied requests. See Creating custom headers.

repeated string custom_request_headers = 27977992;

Parameters

Name	Description
index	`int` The index to set the value at.
value	`String` The customRequestHeaders to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setCustomResponseHeaders(int index, String value)

public BackendService.Builder setCustomResponseHeaders(int index, String value)

Headers that the load balancer adds to proxied responses. See Creating custom headers.

repeated string custom_response_headers = 387539094;

Parameters

Name	Description
index	`int` The index to set the value at.
value	`String` The customResponseHeaders to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setDescription(String value)

public BackendService.Builder setDescription(String value)

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Parameter

Name	Description
value	`String` The description to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public BackendService.Builder setDescriptionBytes(ByteString value)

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Parameter

Name	Description
value	`ByteString` The bytes for description to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setEdgeSecurityPolicy(String value)

public BackendService.Builder setEdgeSecurityPolicy(String value)

[Output Only] The resource URL for the edge security policy associated with this backend service.

optional string edge_security_policy = 41036943;

Parameter

Name	Description
value	`String` The edgeSecurityPolicy to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setEdgeSecurityPolicyBytes(ByteString value)

public BackendService.Builder setEdgeSecurityPolicyBytes(ByteString value)

[Output Only] The resource URL for the edge security policy associated with this backend service.

optional string edge_security_policy = 41036943;

Parameter

Name	Description
value	`ByteString` The bytes for edgeSecurityPolicy to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setEnableCDN(boolean value)

public BackendService.Builder setEnableCDN(boolean value)

If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.

optional bool enable_c_d_n = 250733499;

Parameter

Name	Description
value	`boolean` The enableCDN to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setFailoverPolicy(BackendServiceFailoverPolicy value)

public BackendService.Builder setFailoverPolicy(BackendServiceFailoverPolicy value)

optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;

Parameter

Name	Description
value	`BackendServiceFailoverPolicy`

Returns

Type	Description
BackendService.Builder

setFailoverPolicy(BackendServiceFailoverPolicy.Builder builderForValue)

public BackendService.Builder setFailoverPolicy(BackendServiceFailoverPolicy.Builder builderForValue)

optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;

Parameter

Name	Description
builderForValue	`BackendServiceFailoverPolicy.Builder`

Returns

Type	Description
BackendService.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public BackendService.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
BackendService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFingerprint(String value)

public BackendService.Builder setFingerprint(String value)

optional string fingerprint = 234678500;

Parameter

Name	Description
value	`String` The fingerprint to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setFingerprintBytes(ByteString value)

public BackendService.Builder setFingerprintBytes(ByteString value)

optional string fingerprint = 234678500;

Parameter

Name	Description
value	`ByteString` The bytes for fingerprint to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setHealthChecks(int index, String value)

public BackendService.Builder setHealthChecks(int index, String value)

repeated string health_checks = 448370606;

Parameters

Name	Description
index	`int` The index to set the value at.
value	`String` The healthChecks to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setIap(BackendServiceIAP value)

public BackendService.Builder setIap(BackendServiceIAP value)

The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.

optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;

Parameter

Name	Description
value	`BackendServiceIAP`

Returns

Type	Description
BackendService.Builder

setIap(BackendServiceIAP.Builder builderForValue)

public BackendService.Builder setIap(BackendServiceIAP.Builder builderForValue)

The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.

optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;

Parameter

Name	Description
builderForValue	`BackendServiceIAP.Builder`

Returns

Type	Description
BackendService.Builder

setId(long value)

public BackendService.Builder setId(long value)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Parameter

Name	Description
value	`long` The id to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setKind(String value)

public BackendService.Builder setKind(String value)

[Output Only] Type of resource. Always compute#backendService for backend services.

optional string kind = 3292052;

Parameter

Name	Description
value	`String` The kind to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setKindBytes(ByteString value)

public BackendService.Builder setKindBytes(ByteString value)

[Output Only] Type of resource. Always compute#backendService for backend services.

optional string kind = 3292052;

Parameter

Name	Description
value	`ByteString` The bytes for kind to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setLoadBalancingScheme(String value)

public BackendService.Builder setLoadBalancingScheme(String value)

optional string load_balancing_scheme = 363890244;

Parameter

Name	Description
value	`String` The loadBalancingScheme to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setLoadBalancingSchemeBytes(ByteString value)

public BackendService.Builder setLoadBalancingSchemeBytes(ByteString value)

optional string load_balancing_scheme = 363890244;

Parameter

Name	Description
value	`ByteString` The bytes for loadBalancingScheme to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setLocalityLbPolicies(int index, BackendServiceLocalityLoadBalancingPolicyConfig value)

public BackendService.Builder setLocalityLbPolicies(int index, BackendServiceLocalityLoadBalancingPolicyConfig value)

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Parameters

Name	Description
index	`int`
value	`BackendServiceLocalityLoadBalancingPolicyConfig`

Returns

Type	Description
BackendService.Builder

setLocalityLbPolicies(int index, BackendServiceLocalityLoadBalancingPolicyConfig.Builder builderForValue)

public BackendService.Builder setLocalityLbPolicies(int index, BackendServiceLocalityLoadBalancingPolicyConfig.Builder builderForValue)

repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;

Parameters

Name	Description
index	`int`
builderForValue	`BackendServiceLocalityLoadBalancingPolicyConfig.Builder`

Returns

Type	Description
BackendService.Builder

setLocalityLbPolicy(String value)

public BackendService.Builder setLocalityLbPolicy(String value)

optional string locality_lb_policy = 131431487;

Parameter

Name	Description
value	`String` The localityLbPolicy to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setLocalityLbPolicyBytes(ByteString value)

public BackendService.Builder setLocalityLbPolicyBytes(ByteString value)

optional string locality_lb_policy = 131431487;

Parameter

Name	Description
value	`ByteString` The bytes for localityLbPolicy to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setLogConfig(BackendServiceLogConfig value)

public BackendService.Builder setLogConfig(BackendServiceLogConfig value)

This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;

Parameter

Name	Description
value	`BackendServiceLogConfig`

Returns

Type	Description
BackendService.Builder

setLogConfig(BackendServiceLogConfig.Builder builderForValue)

public BackendService.Builder setLogConfig(BackendServiceLogConfig.Builder builderForValue)

This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.

optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;

Parameter

Name	Description
builderForValue	`BackendServiceLogConfig.Builder`

Returns

Type	Description
BackendService.Builder

setMaxStreamDuration(Duration value)

public BackendService.Builder setMaxStreamDuration(Duration value)

optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;

Parameter

Name	Description
value	`Duration`

Returns

Type	Description
BackendService.Builder

setMaxStreamDuration(Duration.Builder builderForValue)

public BackendService.Builder setMaxStreamDuration(Duration.Builder builderForValue)

optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;

Parameter

Name	Description
builderForValue	`Duration.Builder`

Returns

Type	Description
BackendService.Builder

setName(String value)

public BackendService.Builder setName(String value)

optional string name = 3373707;

Parameter

Name	Description
value	`String` The name to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setNameBytes(ByteString value)

public BackendService.Builder setNameBytes(ByteString value)

optional string name = 3373707;

Parameter

Name	Description
value	`ByteString` The bytes for name to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setNetwork(String value)

public BackendService.Builder setNetwork(String value)

The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.

optional string network = 232872494;

Parameter

Name	Description
value	`String` The network to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setNetworkBytes(ByteString value)

public BackendService.Builder setNetworkBytes(ByteString value)

The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.

optional string network = 232872494;

Parameter

Name	Description
value	`ByteString` The bytes for network to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setOutlierDetection(OutlierDetection value)

public BackendService.Builder setOutlierDetection(OutlierDetection value)

optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;

Parameter

Name	Description
value	`OutlierDetection`

Returns

Type	Description
BackendService.Builder

setOutlierDetection(OutlierDetection.Builder builderForValue)

public BackendService.Builder setOutlierDetection(OutlierDetection.Builder builderForValue)

optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;

Parameter

Name	Description
builderForValue	`OutlierDetection.Builder`

Returns

Type	Description
BackendService.Builder

setPort(int value)

public BackendService.Builder setPort(int value)

Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.

optional int32 port = 3446913;

Parameter

Name	Description
value	`int` The port to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setPortName(String value)

public BackendService.Builder setPortName(String value)

optional string port_name = 41534345;

Parameter

Name	Description
value	`String` The portName to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setPortNameBytes(ByteString value)

public BackendService.Builder setPortNameBytes(ByteString value)

optional string port_name = 41534345;

Parameter

Name	Description
value	`ByteString` The bytes for portName to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setProtocol(String value)

public BackendService.Builder setProtocol(String value)

optional string protocol = 84577944;

Parameter

Name	Description
value	`String` The protocol to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setProtocolBytes(ByteString value)

public BackendService.Builder setProtocolBytes(ByteString value)

optional string protocol = 84577944;

Parameter

Name	Description
value	`ByteString` The bytes for protocol to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setRegion(String value)

public BackendService.Builder setRegion(String value)

optional string region = 138946292;

Parameter

Name	Description
value	`String` The region to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setRegionBytes(ByteString value)

public BackendService.Builder setRegionBytes(ByteString value)

optional string region = 138946292;

Parameter

Name	Description
value	`ByteString` The bytes for region to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
BackendService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSecurityPolicy(String value)

public BackendService.Builder setSecurityPolicy(String value)

[Output Only] The resource URL for the security policy associated with this backend service.

optional string security_policy = 171082513;

Parameter

Name	Description
value	`String` The securityPolicy to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setSecurityPolicyBytes(ByteString value)

public BackendService.Builder setSecurityPolicyBytes(ByteString value)

[Output Only] The resource URL for the security policy associated with this backend service.

optional string security_policy = 171082513;

Parameter

Name	Description
value	`ByteString` The bytes for securityPolicy to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setSecuritySettings(SecuritySettings value)

public BackendService.Builder setSecuritySettings(SecuritySettings value)

This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;

Parameter

Name	Description
value	`SecuritySettings`

Returns

Type	Description
BackendService.Builder

setSecuritySettings(SecuritySettings.Builder builderForValue)

public BackendService.Builder setSecuritySettings(SecuritySettings.Builder builderForValue)

This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.

optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;

Parameter

Name	Description
builderForValue	`SecuritySettings.Builder`

Returns

Type	Description
BackendService.Builder

setSelfLink(String value)

public BackendService.Builder setSelfLink(String value)

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Parameter

Name	Description
value	`String` The selfLink to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setSelfLinkBytes(ByteString value)

public BackendService.Builder setSelfLinkBytes(ByteString value)

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Parameter

Name	Description
value	`ByteString` The bytes for selfLink to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setServiceBindings(int index, String value)

public BackendService.Builder setServiceBindings(int index, String value)

URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.

repeated string service_bindings = 133581016;

Parameters

Name	Description
index	`int` The index to set the value at.
value	`String` The serviceBindings to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setSessionAffinity(String value)

public BackendService.Builder setSessionAffinity(String value)

optional string session_affinity = 463888561;

Parameter

Name	Description
value	`String` The sessionAffinity to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setSessionAffinityBytes(ByteString value)

public BackendService.Builder setSessionAffinityBytes(ByteString value)

optional string session_affinity = 463888561;

Parameter

Name	Description
value	`ByteString` The bytes for sessionAffinity to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setSubsetting(Subsetting value)

public BackendService.Builder setSubsetting(Subsetting value)

optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;

Parameter

Name	Description
value	`Subsetting`

Returns

Type	Description
BackendService.Builder

setSubsetting(Subsetting.Builder builderForValue)

public BackendService.Builder setSubsetting(Subsetting.Builder builderForValue)

optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;

Parameter

Name	Description
builderForValue	`Subsetting.Builder`

Returns

Type	Description
BackendService.Builder

setTimeoutSec(int value)

public BackendService.Builder setTimeoutSec(int value)

optional int32 timeout_sec = 79994995;

Parameter

Name	Description
value	`int` The timeoutSec to set.

Returns

Type	Description
BackendService.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BackendService.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
BackendService.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)