- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public interface BackendServiceOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAffinityCookieTtlSec()
public abstract int getAffinityCookieTtlSec()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 one day (86,400). 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;
| Type | Description |
| int | The affinityCookieTtlSec. |
getBackends(int index)
public abstract Backend getBackends(int index)The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;
| Name | Description |
| index | int |
| Type | Description |
| Backend |
getBackendsCount()
public abstract int getBackendsCount()The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;
| Type | Description |
| int |
getBackendsList()
public abstract List<Backend> getBackendsList()The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;
| Type | Description |
| List<Backend> |
getBackendsOrBuilder(int index)
public abstract BackendOrBuilder getBackendsOrBuilder(int index)The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;
| Name | Description |
| index | int |
| Type | Description |
| BackendOrBuilder |
getBackendsOrBuilderList()
public abstract List<? extends BackendOrBuilder> getBackendsOrBuilderList()The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;
| Type | Description |
| List<? extends com.google.cloud.compute.v1.BackendOrBuilder> |
getCdnPolicy()
public abstract BackendServiceCdnPolicy getCdnPolicy()Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;
| Type | Description |
| BackendServiceCdnPolicy | The cdnPolicy. |
getCdnPolicyOrBuilder()
public abstract BackendServiceCdnPolicyOrBuilder getCdnPolicyOrBuilder()Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;
| Type | Description |
| BackendServiceCdnPolicyOrBuilder |
getCircuitBreakers()
public abstract CircuitBreakers getCircuitBreakers()optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
| Type | Description |
| CircuitBreakers | The circuitBreakers. |
getCircuitBreakersOrBuilder()
public abstract CircuitBreakersOrBuilder getCircuitBreakersOrBuilder()optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
| Type | Description |
| CircuitBreakersOrBuilder |
getConnectionDraining()
public abstract ConnectionDraining getConnectionDraining()optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
| Type | Description |
| ConnectionDraining | The connectionDraining. |
getConnectionDrainingOrBuilder()
public abstract ConnectionDrainingOrBuilder getConnectionDrainingOrBuilder()optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
| Type | Description |
| ConnectionDrainingOrBuilder |
getConnectionTrackingPolicy()
public abstract 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;
| Type | Description |
| BackendServiceConnectionTrackingPolicy | The connectionTrackingPolicy. |
getConnectionTrackingPolicyOrBuilder()
public abstract 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;
| Type | Description |
| BackendServiceConnectionTrackingPolicyOrBuilder |
getConsistentHash()
public abstract ConsistentHashLoadBalancerSettings getConsistentHash()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;
| Type | Description |
| ConsistentHashLoadBalancerSettings | The consistentHash. |
getConsistentHashOrBuilder()
public abstract ConsistentHashLoadBalancerSettingsOrBuilder getConsistentHashOrBuilder()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;
| Type | Description |
| ConsistentHashLoadBalancerSettingsOrBuilder |
getCreationTimestamp()
public abstract String getCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type | Description |
| String | The creationTimestamp. |
getCreationTimestampBytes()
public abstract ByteString getCreationTimestampBytes()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type | Description |
| ByteString | The bytes for creationTimestamp. |
getCustomRequestHeaders(int index)
public abstract String getCustomRequestHeaders(int index)Headers that the load balancer adds to proxied requests. See Creating custom headers.
repeated string custom_request_headers = 27977992;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The customRequestHeaders at the given index. |
getCustomRequestHeadersBytes(int index)
public abstract ByteString getCustomRequestHeadersBytes(int index)Headers that the load balancer adds to proxied requests. See Creating custom headers.
repeated string custom_request_headers = 27977992;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the customRequestHeaders at the given index. |
getCustomRequestHeadersCount()
public abstract int getCustomRequestHeadersCount()Headers that the load balancer adds to proxied requests. See Creating custom headers.
repeated string custom_request_headers = 27977992;
| Type | Description |
| int | The count of customRequestHeaders. |
getCustomRequestHeadersList()
public abstract List<String> getCustomRequestHeadersList()Headers that the load balancer adds to proxied requests. See Creating custom headers.
repeated string custom_request_headers = 27977992;
| Type | Description |
| List<String> | A list containing the customRequestHeaders. |
getCustomResponseHeaders(int index)
public abstract String getCustomResponseHeaders(int index)Headers that the load balancer adds to proxied responses. See Creating custom headers.
repeated string custom_response_headers = 387539094;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The customResponseHeaders at the given index. |
getCustomResponseHeadersBytes(int index)
public abstract ByteString getCustomResponseHeadersBytes(int index)Headers that the load balancer adds to proxied responses. See Creating custom headers.
repeated string custom_response_headers = 387539094;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the customResponseHeaders at the given index. |
getCustomResponseHeadersCount()
public abstract int getCustomResponseHeadersCount()Headers that the load balancer adds to proxied responses. See Creating custom headers.
repeated string custom_response_headers = 387539094;
| Type | Description |
| int | The count of customResponseHeaders. |
getCustomResponseHeadersList()
public abstract List<String> getCustomResponseHeadersList()Headers that the load balancer adds to proxied responses. See Creating custom headers.
repeated string custom_response_headers = 387539094;
| Type | Description |
| List<String> | A list containing the customResponseHeaders. |
getDescription()
public abstract String getDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| String | The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| ByteString | The bytes for description. |
getEdgeSecurityPolicy()
public abstract String getEdgeSecurityPolicy()[Output Only] The resource URL for the edge security policy associated with this backend service.
optional string edge_security_policy = 41036943;
| Type | Description |
| String | The edgeSecurityPolicy. |
getEdgeSecurityPolicyBytes()
public abstract ByteString getEdgeSecurityPolicyBytes()[Output Only] The resource URL for the edge security policy associated with this backend service.
optional string edge_security_policy = 41036943;
| Type | Description |
| ByteString | The bytes for edgeSecurityPolicy. |
getEnableCDN()
public abstract 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;
| Type | Description |
| boolean | The enableCDN. |
getFailoverPolicy()
public abstract BackendServiceFailoverPolicy getFailoverPolicy()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;
| Type | Description |
| BackendServiceFailoverPolicy | The failoverPolicy. |
getFailoverPolicyOrBuilder()
public abstract BackendServiceFailoverPolicyOrBuilder getFailoverPolicyOrBuilder()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;
| Type | Description |
| BackendServiceFailoverPolicyOrBuilder |
getFingerprint()
public abstract String getFingerprint()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;
| Type | Description |
| String | The fingerprint. |
getFingerprintBytes()
public abstract ByteString getFingerprintBytes()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;
| Type | Description |
| ByteString | The bytes for fingerprint. |
getHealthChecks(int index)
public abstract String getHealthChecks(int index)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;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The healthChecks at the given index. |
getHealthChecksBytes(int index)
public abstract ByteString getHealthChecksBytes(int index)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;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the healthChecks at the given index. |
getHealthChecksCount()
public abstract int getHealthChecksCount()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;
| Type | Description |
| int | The count of healthChecks. |
getHealthChecksList()
public abstract List<String> getHealthChecksList()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;
| Type | Description |
| List<String> | A list containing the healthChecks. |
getIap()
public abstract 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;
| Type | Description |
| BackendServiceIAP | The iap. |
getIapOrBuilder()
public abstract 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;
| Type | Description |
| BackendServiceIAPOrBuilder |
getId()
public abstract long getId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Type | Description |
| long | The id. |
getKind()
public abstract String getKind()[Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;
| Type | Description |
| String | The kind. |
getKindBytes()
public abstract ByteString getKindBytes()[Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;
| Type | Description |
| ByteString | The bytes for kind. |
getLoadBalancingScheme()
public abstract String getLoadBalancingScheme()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;
| Type | Description |
| String | The loadBalancingScheme. |
getLoadBalancingSchemeBytes()
public abstract ByteString getLoadBalancingSchemeBytes()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;
| Type | Description |
| ByteString | The bytes for loadBalancingScheme. |
getLocalityLbPolicies(int index)
public abstract BackendServiceLocalityLoadBalancingPolicyConfig getLocalityLbPolicies(int index)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;
| Name | Description |
| index | int |
| Type | Description |
| BackendServiceLocalityLoadBalancingPolicyConfig |
getLocalityLbPoliciesCount()
public abstract int getLocalityLbPoliciesCount()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;
| Type | Description |
| int |
getLocalityLbPoliciesList()
public abstract List<BackendServiceLocalityLoadBalancingPolicyConfig> getLocalityLbPoliciesList()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;
| Type | Description |
| List<BackendServiceLocalityLoadBalancingPolicyConfig> |
getLocalityLbPoliciesOrBuilder(int index)
public abstract BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder getLocalityLbPoliciesOrBuilder(int index)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;
| Name | Description |
| index | int |
| Type | Description |
| BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder |
getLocalityLbPoliciesOrBuilderList()
public abstract List<? extends BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder> getLocalityLbPoliciesOrBuilderList()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;
| Type | Description |
| List<? extends com.google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder> |
getLocalityLbPolicy()
public abstract String getLocalityLbPolicy()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;
| Type | Description |
| String | The localityLbPolicy. |
getLocalityLbPolicyBytes()
public abstract ByteString getLocalityLbPolicyBytes()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;
| Type | Description |
| ByteString | The bytes for localityLbPolicy. |
getLogConfig()
public abstract 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;
| Type | Description |
| BackendServiceLogConfig | The logConfig. |
getLogConfigOrBuilder()
public abstract 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;
| Type | Description |
| BackendServiceLogConfigOrBuilder |
getMaxStreamDuration()
public abstract Duration getMaxStreamDuration()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;
| Type | Description |
| Duration | The maxStreamDuration. |
getMaxStreamDurationOrBuilder()
public abstract DurationOrBuilder getMaxStreamDurationOrBuilder()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;
| Type | Description |
| DurationOrBuilder |
getName()
public abstract String getName() 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;
| Type | Description |
| String | The name. |
getNameBytes()
public abstract ByteString getNameBytes() 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;
| Type | Description |
| ByteString | The bytes for name. |
getNetwork()
public abstract 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;
| Type | Description |
| String | The network. |
getNetworkBytes()
public abstract 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;
| Type | Description |
| ByteString | The bytes for network. |
getOutlierDetection()
public abstract OutlierDetection getOutlierDetection()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;
| Type | Description |
| OutlierDetection | The outlierDetection. |
getOutlierDetectionOrBuilder()
public abstract OutlierDetectionOrBuilder getOutlierDetectionOrBuilder()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;
| Type | Description |
| OutlierDetectionOrBuilder |
getPort()
public abstract 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;
| Type | Description |
| int | The port. |
getPortName()
public abstract String getPortName()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;
| Type | Description |
| String | The portName. |
getPortNameBytes()
public abstract ByteString getPortNameBytes()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;
| Type | Description |
| ByteString | The bytes for portName. |
getProtocol()
public abstract String getProtocol()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;
| Type | Description |
| String | The protocol. |
getProtocolBytes()
public abstract ByteString getProtocolBytes()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;
| Type | Description |
| ByteString | The bytes for protocol. |
getRegion()
public abstract String getRegion()[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;
| Type | Description |
| String | The region. |
getRegionBytes()
public abstract ByteString getRegionBytes()[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;
| Type | Description |
| ByteString | The bytes for region. |
getSecurityPolicy()
public abstract String getSecurityPolicy()[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;
| Type | Description |
| String | The securityPolicy. |
getSecurityPolicyBytes()
public abstract ByteString getSecurityPolicyBytes()[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;
| Type | Description |
| ByteString | The bytes for securityPolicy. |
getSecuritySettings()
public abstract 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;
| Type | Description |
| SecuritySettings | The securitySettings. |
getSecuritySettingsOrBuilder()
public abstract 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;
| Type | Description |
| SecuritySettingsOrBuilder |
getSelfLink()
public abstract String getSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type | Description |
| String | The selfLink. |
getSelfLinkBytes()
public abstract ByteString getSelfLinkBytes()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type | Description |
| ByteString | The bytes for selfLink. |
getSessionAffinity()
public abstract String getSessionAffinity()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;
| Type | Description |
| String | The sessionAffinity. |
getSessionAffinityBytes()
public abstract ByteString getSessionAffinityBytes()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;
| Type | Description |
| ByteString | The bytes for sessionAffinity. |
getSubsetting()
public abstract Subsetting getSubsetting()optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
| Type | Description |
| Subsetting | The subsetting. |
getSubsettingOrBuilder()
public abstract SubsettingOrBuilder getSubsettingOrBuilder()optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
| Type | Description |
| SubsettingOrBuilder |
getTimeoutSec()
public abstract int getTimeoutSec()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;
| Type | Description |
| int | The timeoutSec. |
hasAffinityCookieTtlSec()
public abstract boolean hasAffinityCookieTtlSec()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 one day (86,400). 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;
| Type | Description |
| boolean | Whether the affinityCookieTtlSec field is set. |
hasCdnPolicy()
public abstract boolean hasCdnPolicy()Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;
| Type | Description |
| boolean | Whether the cdnPolicy field is set. |
hasCircuitBreakers()
public abstract boolean hasCircuitBreakers()optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
| Type | Description |
| boolean | Whether the circuitBreakers field is set. |
hasConnectionDraining()
public abstract boolean hasConnectionDraining()optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
| Type | Description |
| boolean | Whether the connectionDraining field is set. |
hasConnectionTrackingPolicy()
public abstract 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;
| Type | Description |
| boolean | Whether the connectionTrackingPolicy field is set. |
hasConsistentHash()
public abstract boolean hasConsistentHash()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;
| Type | Description |
| boolean | Whether the consistentHash field is set. |
hasCreationTimestamp()
public abstract boolean hasCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type | Description |
| boolean | Whether the creationTimestamp field is set. |
hasDescription()
public abstract boolean hasDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| boolean | Whether the description field is set. |
hasEdgeSecurityPolicy()
public abstract boolean hasEdgeSecurityPolicy()[Output Only] The resource URL for the edge security policy associated with this backend service.
optional string edge_security_policy = 41036943;
| Type | Description |
| boolean | Whether the edgeSecurityPolicy field is set. |
hasEnableCDN()
public abstract 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;
| Type | Description |
| boolean | Whether the enableCDN field is set. |
hasFailoverPolicy()
public abstract boolean hasFailoverPolicy()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;
| Type | Description |
| boolean | Whether the failoverPolicy field is set. |
hasFingerprint()
public abstract boolean hasFingerprint()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;
| Type | Description |
| boolean | Whether the fingerprint field is set. |
hasIap()
public abstract 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;
| Type | Description |
| boolean | Whether the iap field is set. |
hasId()
public abstract boolean hasId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Type | Description |
| boolean | Whether the id field is set. |
hasKind()
public abstract boolean hasKind()[Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;
| Type | Description |
| boolean | Whether the kind field is set. |
hasLoadBalancingScheme()
public abstract boolean hasLoadBalancingScheme()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;
| Type | Description |
| boolean | Whether the loadBalancingScheme field is set. |
hasLocalityLbPolicy()
public abstract boolean hasLocalityLbPolicy()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;
| Type | Description |
| boolean | Whether the localityLbPolicy field is set. |
hasLogConfig()
public abstract 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;
| Type | Description |
| boolean | Whether the logConfig field is set. |
hasMaxStreamDuration()
public abstract boolean hasMaxStreamDuration()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;
| Type | Description |
| boolean | Whether the maxStreamDuration field is set. |
hasName()
public abstract boolean hasName() 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;
| Type | Description |
| boolean | Whether the name field is set. |
hasNetwork()
public abstract 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;
| Type | Description |
| boolean | Whether the network field is set. |
hasOutlierDetection()
public abstract boolean hasOutlierDetection()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;
| Type | Description |
| boolean | Whether the outlierDetection field is set. |
hasPort()
public abstract 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;
| Type | Description |
| boolean | Whether the port field is set. |
hasPortName()
public abstract boolean hasPortName()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;
| Type | Description |
| boolean | Whether the portName field is set. |
hasProtocol()
public abstract boolean hasProtocol()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;
| Type | Description |
| boolean | Whether the protocol field is set. |
hasRegion()
public abstract boolean hasRegion()[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;
| Type | Description |
| boolean | Whether the region field is set. |
hasSecurityPolicy()
public abstract boolean hasSecurityPolicy()[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;
| Type | Description |
| boolean | Whether the securityPolicy field is set. |
hasSecuritySettings()
public abstract 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;
| Type | Description |
| boolean | Whether the securitySettings field is set. |
hasSelfLink()
public abstract boolean hasSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type | Description |
| boolean | Whether the selfLink field is set. |
hasSessionAffinity()
public abstract boolean hasSessionAffinity()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;
| Type | Description |
| boolean | Whether the sessionAffinity field is set. |
hasSubsetting()
public abstract boolean hasSubsetting()optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
| Type | Description |
| boolean | Whether the subsetting field is set. |
hasTimeoutSec()
public abstract boolean hasTimeoutSec()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;
| Type | Description |
| boolean | Whether the timeoutSec field is set. |