Package com.google.cloud.compute.v1
Interface BackendServiceOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
BackendService
,BackendService.Builder
public interface BackendServiceOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description boolean
containsMetadatas(String key)
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHint
getAffinityCookieTtlSec()
Lifetime of cookies in seconds.Backend
getBackends(int index)
The list of backends that serve this BackendService.int
getBackendsCount()
The list of backends that serve this BackendService.List<Backend>
getBackendsList()
The list of backends that serve this BackendService.BackendOrBuilder
getBackendsOrBuilder(int index)
The list of backends that serve this BackendService.List<? extends BackendOrBuilder>
getBackendsOrBuilderList()
The list of backends that serve this BackendService.BackendServiceCdnPolicy
getCdnPolicy()
Cloud CDN configuration for this BackendService.BackendServiceCdnPolicyOrBuilder
getCdnPolicyOrBuilder()
Cloud CDN configuration for this BackendService.CircuitBreakers
getCircuitBreakers()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
CircuitBreakersOrBuilder
getCircuitBreakersOrBuilder()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
String
getCompressionMode()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.com.google.protobuf.ByteString
getCompressionModeBytes()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.ConnectionDraining
getConnectionDraining()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
ConnectionDrainingOrBuilder
getConnectionDrainingOrBuilder()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
BackendServiceConnectionTrackingPolicy
getConnectionTrackingPolicy()
Connection Tracking configuration for this BackendService.BackendServiceConnectionTrackingPolicyOrBuilder
getConnectionTrackingPolicyOrBuilder()
Connection Tracking configuration for this BackendService.ConsistentHashLoadBalancerSettings
getConsistentHash()
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.ConsistentHashLoadBalancerSettingsOrBuilder
getConsistentHashOrBuilder()
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.String
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.com.google.protobuf.ByteString
getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.String
getCustomRequestHeaders(int index)
Headers that the load balancer adds to proxied requests.com.google.protobuf.ByteString
getCustomRequestHeadersBytes(int index)
Headers that the load balancer adds to proxied requests.int
getCustomRequestHeadersCount()
Headers that the load balancer adds to proxied requests.List<String>
getCustomRequestHeadersList()
Headers that the load balancer adds to proxied requests.String
getCustomResponseHeaders(int index)
Headers that the load balancer adds to proxied responses.com.google.protobuf.ByteString
getCustomResponseHeadersBytes(int index)
Headers that the load balancer adds to proxied responses.int
getCustomResponseHeadersCount()
Headers that the load balancer adds to proxied responses.List<String>
getCustomResponseHeadersList()
Headers that the load balancer adds to proxied responses.String
getDescription()
An optional description of this resource.com.google.protobuf.ByteString
getDescriptionBytes()
An optional description of this resource.String
getEdgeSecurityPolicy()
[Output Only] The resource URL for the edge security policy associated with this backend service.com.google.protobuf.ByteString
getEdgeSecurityPolicyBytes()
[Output Only] The resource URL for the edge security policy associated with this backend service.boolean
getEnableCDN()
If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.BackendServiceFailoverPolicy
getFailoverPolicy()
Requires at least one backend instance group to be defined as a backup (failover) backend.BackendServiceFailoverPolicyOrBuilder
getFailoverPolicyOrBuilder()
Requires at least one backend instance group to be defined as a backup (failover) backend.String
getFingerprint()
Fingerprint of this resource.com.google.protobuf.ByteString
getFingerprintBytes()
Fingerprint of this resource.String
getHealthChecks(int index)
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.com.google.protobuf.ByteString
getHealthChecksBytes(int index)
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.int
getHealthChecksCount()
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.List<String>
getHealthChecksList()
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.BackendServiceIAP
getIap()
The configurations for Identity-Aware Proxy on this resource.BackendServiceIAPOrBuilder
getIapOrBuilder()
The configurations for Identity-Aware Proxy on this resource.long
getId()
[Output Only] The unique identifier for the resource.String
getKind()
[Output Only] Type of resource.com.google.protobuf.ByteString
getKindBytes()
[Output Only] Type of resource.String
getLoadBalancingScheme()
Specifies the load balancer type.com.google.protobuf.ByteString
getLoadBalancingSchemeBytes()
Specifies the load balancer type.BackendServiceLocalityLoadBalancingPolicyConfig
getLocalityLbPolicies(int index)
A list of locality load-balancing policies to be used in order of preference.int
getLocalityLbPoliciesCount()
A list of locality load-balancing policies to be used in order of preference.List<BackendServiceLocalityLoadBalancingPolicyConfig>
getLocalityLbPoliciesList()
A list of locality load-balancing policies to be used in order of preference.BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder
getLocalityLbPoliciesOrBuilder(int index)
A list of locality load-balancing policies to be used in order of preference.List<? extends BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder>
getLocalityLbPoliciesOrBuilderList()
A list of locality load-balancing policies to be used in order of preference.String
getLocalityLbPolicy()
The load balancing algorithm used within the scope of the locality.com.google.protobuf.ByteString
getLocalityLbPolicyBytes()
The load balancing algorithm used within the scope of the locality.BackendServiceLogConfig
getLogConfig()
This field denotes the logging options for the load balancer traffic served by this backend service.BackendServiceLogConfigOrBuilder
getLogConfigOrBuilder()
This field denotes the logging options for the load balancer traffic served by this backend service.Duration
getMaxStreamDuration()
Specifies the default maximum duration (timeout) for streams to this service.DurationOrBuilder
getMaxStreamDurationOrBuilder()
Specifies the default maximum duration (timeout) for streams to this service.Map<String,String>
getMetadatas()
Deprecated.int
getMetadatasCount()
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHMap<String,String>
getMetadatasMap()
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHString
getMetadatasOrDefault(String key, String defaultValue)
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHString
getMetadatasOrThrow(String key)
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHString
getName()
Name of the resource.com.google.protobuf.ByteString
getNameBytes()
Name of the resource.String
getNetwork()
The URL of the network to which this backend service belongs.com.google.protobuf.ByteString
getNetworkBytes()
The URL of the network to which this backend service belongs.OutlierDetection
getOutlierDetection()
Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service.OutlierDetectionOrBuilder
getOutlierDetectionOrBuilder()
Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service.int
getPort()
Deprecated in favor of portName.String
getPortName()
A named port on a backend instance group representing the port for communication to the backend VMs in that group.com.google.protobuf.ByteString
getPortNameBytes()
A named port on a backend instance group representing the port for communication to the backend VMs in that group.String
getProtocol()
The protocol this BackendService uses to communicate with backends.com.google.protobuf.ByteString
getProtocolBytes()
The protocol this BackendService uses to communicate with backends.String
getRegion()
[Output Only] URL of the region where the regional backend service resides.com.google.protobuf.ByteString
getRegionBytes()
[Output Only] URL of the region where the regional backend service resides.String
getSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this backend service.com.google.protobuf.ByteString
getSecurityPolicyBytes()
[Output Only] The resource URL for the security policy associated with this backend service.SecuritySettings
getSecuritySettings()
This field specifies the security settings that apply to this backend service.SecuritySettingsOrBuilder
getSecuritySettingsOrBuilder()
This field specifies the security settings that apply to this backend service.String
getSelfLink()
[Output Only] Server-defined URL for the resource.com.google.protobuf.ByteString
getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.String
getServiceBindings(int index)
URLs of networkservices.ServiceBinding resources.com.google.protobuf.ByteString
getServiceBindingsBytes(int index)
URLs of networkservices.ServiceBinding resources.int
getServiceBindingsCount()
URLs of networkservices.ServiceBinding resources.List<String>
getServiceBindingsList()
URLs of networkservices.ServiceBinding resources.String
getSessionAffinity()
Type of session affinity to use.com.google.protobuf.ByteString
getSessionAffinityBytes()
Type of session affinity to use.Subsetting
getSubsetting()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
SubsettingOrBuilder
getSubsettingOrBuilder()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
int
getTimeoutSec()
The backend service timeout has a different meaning depending on the type of load balancer.boolean
hasAffinityCookieTtlSec()
Lifetime of cookies in seconds.boolean
hasCdnPolicy()
Cloud CDN configuration for this BackendService.boolean
hasCircuitBreakers()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
boolean
hasCompressionMode()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.boolean
hasConnectionDraining()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
boolean
hasConnectionTrackingPolicy()
Connection Tracking configuration for this BackendService.boolean
hasConsistentHash()
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.boolean
hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.boolean
hasDescription()
An optional description of this resource.boolean
hasEdgeSecurityPolicy()
[Output Only] The resource URL for the edge security policy associated with this backend service.boolean
hasEnableCDN()
If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.boolean
hasFailoverPolicy()
Requires at least one backend instance group to be defined as a backup (failover) backend.boolean
hasFingerprint()
Fingerprint of this resource.boolean
hasIap()
The configurations for Identity-Aware Proxy on this resource.boolean
hasId()
[Output Only] The unique identifier for the resource.boolean
hasKind()
[Output Only] Type of resource.boolean
hasLoadBalancingScheme()
Specifies the load balancer type.boolean
hasLocalityLbPolicy()
The load balancing algorithm used within the scope of the locality.boolean
hasLogConfig()
This field denotes the logging options for the load balancer traffic served by this backend service.boolean
hasMaxStreamDuration()
Specifies the default maximum duration (timeout) for streams to this service.boolean
hasName()
Name of the resource.boolean
hasNetwork()
The URL of the network to which this backend service belongs.boolean
hasOutlierDetection()
Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service.boolean
hasPort()
Deprecated in favor of portName.boolean
hasPortName()
A named port on a backend instance group representing the port for communication to the backend VMs in that group.boolean
hasProtocol()
The protocol this BackendService uses to communicate with backends.boolean
hasRegion()
[Output Only] URL of the region where the regional backend service resides.boolean
hasSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this backend service.boolean
hasSecuritySettings()
This field specifies the security settings that apply to this backend service.boolean
hasSelfLink()
[Output Only] Server-defined URL for the resource.boolean
hasSessionAffinity()
Type of session affinity to use.boolean
hasSubsetting()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
boolean
hasTimeoutSec()
The backend service timeout has a different meaning depending on the type of load balancer.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
hasAffinityCookieTtlSec
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 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:
- Whether the affinityCookieTtlSec field is set.
-
getAffinityCookieTtlSec
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 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:
- The affinityCookieTtlSec.
-
getBackendsList
List<Backend> getBackendsList()
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;
-
getBackends
Backend getBackends(int index)
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;
-
getBackendsCount
int getBackendsCount()
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;
-
getBackendsOrBuilderList
List<? extends BackendOrBuilder> getBackendsOrBuilderList()
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;
-
getBackendsOrBuilder
BackendOrBuilder getBackendsOrBuilder(int index)
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;
-
hasCdnPolicy
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:
- Whether the cdnPolicy field is set.
-
getCdnPolicy
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:
- The cdnPolicy.
-
getCdnPolicyOrBuilder
BackendServiceCdnPolicyOrBuilder getCdnPolicyOrBuilder()
Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;
-
hasCircuitBreakers
boolean hasCircuitBreakers()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
- Returns:
- Whether the circuitBreakers field is set.
-
getCircuitBreakers
CircuitBreakers getCircuitBreakers()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
- Returns:
- The circuitBreakers.
-
getCircuitBreakersOrBuilder
CircuitBreakersOrBuilder getCircuitBreakersOrBuilder()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
-
hasCompressionMode
boolean hasCompressionMode()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Check the CompressionMode enum for the list of possible values.
optional string compression_mode = 95520988;
- Returns:
- Whether the compressionMode field is set.
-
getCompressionMode
String getCompressionMode()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Check the CompressionMode enum for the list of possible values.
optional string compression_mode = 95520988;
- Returns:
- The compressionMode.
-
getCompressionModeBytes
com.google.protobuf.ByteString getCompressionModeBytes()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Check the CompressionMode enum for the list of possible values.
optional string compression_mode = 95520988;
- Returns:
- The bytes for compressionMode.
-
hasConnectionDraining
boolean hasConnectionDraining()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
- Returns:
- Whether the connectionDraining field is set.
-
getConnectionDraining
ConnectionDraining getConnectionDraining()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
- Returns:
- The connectionDraining.
-
getConnectionDrainingOrBuilder
ConnectionDrainingOrBuilder getConnectionDrainingOrBuilder()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
-
hasConnectionTrackingPolicy
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:
- Whether the connectionTrackingPolicy field is set.
-
getConnectionTrackingPolicy
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:
- The connectionTrackingPolicy.
-
getConnectionTrackingPolicyOrBuilder
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;
-
hasConsistentHash
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;
- Returns:
- Whether the consistentHash field is set.
-
getConsistentHash
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;
- Returns:
- The consistentHash.
-
getConsistentHashOrBuilder
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;
-
hasCreationTimestamp
boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
- Returns:
- Whether the creationTimestamp field is set.
-
getCreationTimestamp
String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
- Returns:
- The creationTimestamp.
-
getCreationTimestampBytes
com.google.protobuf.ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
- Returns:
- The bytes for creationTimestamp.
-
getCustomRequestHeadersList
List<String> getCustomRequestHeadersList()
Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_request_headers = 27977992;
- Returns:
- A list containing the customRequestHeaders.
-
getCustomRequestHeadersCount
int getCustomRequestHeadersCount()
Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_request_headers = 27977992;
- Returns:
- The count of customRequestHeaders.
-
getCustomRequestHeaders
String getCustomRequestHeaders(int index)
Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_request_headers = 27977992;
- Parameters:
index
- The index of the element to return.- Returns:
- The customRequestHeaders at the given index.
-
getCustomRequestHeadersBytes
com.google.protobuf.ByteString getCustomRequestHeadersBytes(int index)
Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_request_headers = 27977992;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the customRequestHeaders at the given index.
-
getCustomResponseHeadersList
List<String> getCustomResponseHeadersList()
Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_response_headers = 387539094;
- Returns:
- A list containing the customResponseHeaders.
-
getCustomResponseHeadersCount
int getCustomResponseHeadersCount()
Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_response_headers = 387539094;
- Returns:
- The count of customResponseHeaders.
-
getCustomResponseHeaders
String getCustomResponseHeaders(int index)
Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_response_headers = 387539094;
- Parameters:
index
- The index of the element to return.- Returns:
- The customResponseHeaders at the given index.
-
getCustomResponseHeadersBytes
com.google.protobuf.ByteString getCustomResponseHeadersBytes(int index)
Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_response_headers = 387539094;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the customResponseHeaders at the given index.
-
hasDescription
boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
- Returns:
- Whether the description field is set.
-
getDescription
String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
- Returns:
- The bytes for description.
-
hasEdgeSecurityPolicy
boolean hasEdgeSecurityPolicy()
[Output Only] The resource URL for the edge security policy associated with this backend service.
optional string edge_security_policy = 41036943;
- Returns:
- Whether the edgeSecurityPolicy field is set.
-
getEdgeSecurityPolicy
String getEdgeSecurityPolicy()
[Output Only] The resource URL for the edge security policy associated with this backend service.
optional string edge_security_policy = 41036943;
- Returns:
- The edgeSecurityPolicy.
-
getEdgeSecurityPolicyBytes
com.google.protobuf.ByteString getEdgeSecurityPolicyBytes()
[Output Only] The resource URL for the edge security policy associated with this backend service.
optional string edge_security_policy = 41036943;
- Returns:
- The bytes for edgeSecurityPolicy.
-
hasEnableCDN
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:
- Whether the enableCDN field is set.
-
getEnableCDN
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:
- The enableCDN.
-
hasFailoverPolicy
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](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;
- Returns:
- Whether the failoverPolicy field is set.
-
getFailoverPolicy
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](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;
- Returns:
- The failoverPolicy.
-
getFailoverPolicyOrBuilder
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](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;
-
hasFingerprint
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;
- Returns:
- Whether the fingerprint field is set.
-
getFingerprint
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;
- Returns:
- The fingerprint.
-
getFingerprintBytes
com.google.protobuf.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;
- Returns:
- The bytes for fingerprint.
-
getHealthChecksList
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;
- Returns:
- A list containing the healthChecks.
-
getHealthChecksCount
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;
- Returns:
- The count of healthChecks.
-
getHealthChecks
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;
- Parameters:
index
- The index of the element to return.- Returns:
- The healthChecks at the given index.
-
getHealthChecksBytes
com.google.protobuf.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;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the healthChecks at the given index.
-
hasIap
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:
- Whether the iap field is set.
-
getIap
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:
- The iap.
-
getIapOrBuilder
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;
-
hasId
boolean hasId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
- Returns:
- Whether the id field is set.
-
getId
long getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
- Returns:
- The id.
-
hasKind
boolean hasKind()
[Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;
- Returns:
- Whether the kind field is set.
-
getKind
String getKind()
[Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;
- Returns:
- The kind.
-
getKindBytes
com.google.protobuf.ByteString getKindBytes()
[Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;
- Returns:
- The bytes for kind.
-
hasLoadBalancingScheme
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;
- Returns:
- Whether the loadBalancingScheme field is set.
-
getLoadBalancingScheme
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;
- Returns:
- The loadBalancingScheme.
-
getLoadBalancingSchemeBytes
com.google.protobuf.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;
- Returns:
- The bytes for loadBalancingScheme.
-
getLocalityLbPoliciesList
List<BackendServiceLocalityLoadBalancingPolicyConfig> getLocalityLbPoliciesList()
A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;
-
getLocalityLbPolicies
BackendServiceLocalityLoadBalancingPolicyConfig getLocalityLbPolicies(int index)
A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;
-
getLocalityLbPoliciesCount
int getLocalityLbPoliciesCount()
A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;
-
getLocalityLbPoliciesOrBuilderList
List<? extends BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder> getLocalityLbPoliciesOrBuilderList()
A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;
-
getLocalityLbPoliciesOrBuilder
BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder getLocalityLbPoliciesOrBuilder(int index)
A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;
-
hasLocalityLbPolicy
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;
- Returns:
- Whether the localityLbPolicy field is set.
-
getLocalityLbPolicy
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;
- Returns:
- The localityLbPolicy.
-
getLocalityLbPolicyBytes
com.google.protobuf.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;
- Returns:
- The bytes for localityLbPolicy.
-
hasLogConfig
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:
- Whether the logConfig field is set.
-
getLogConfig
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:
- The logConfig.
-
getLogConfigOrBuilder
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;
-
hasMaxStreamDuration
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;
- Returns:
- Whether the maxStreamDuration field is set.
-
getMaxStreamDuration
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;
- Returns:
- The maxStreamDuration.
-
getMaxStreamDurationOrBuilder
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;
-
getMetadatasCount
int getMetadatasCount()
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;
-
containsMetadatas
boolean containsMetadatas(String key)
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;
-
getMetadatas
@Deprecated Map<String,String> getMetadatas()
Deprecated.UsegetMetadatasMap()
instead.
-
getMetadatasMap
Map<String,String> getMetadatasMap()
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;
-
getMetadatasOrDefault
String getMetadatasOrDefault(String key, String defaultValue)
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;
-
getMetadatasOrThrow
String getMetadatasOrThrow(String key)
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;
-
hasName
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]([-a-z0-9]*[a-z0-9])?` 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:
- Whether the name field is set.
-
getName
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]([-a-z0-9]*[a-z0-9])?` 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:
- The name.
-
getNameBytes
com.google.protobuf.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]([-a-z0-9]*[a-z0-9])?` 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:
- The bytes for name.
-
hasNetwork
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:
- Whether the network field is set.
-
getNetwork
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:
- The network.
-
getNetworkBytes
com.google.protobuf.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:
- The bytes for network.
-
hasOutlierDetection
boolean hasOutlierDetection()
Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. 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:
- Whether the outlierDetection field is set.
-
getOutlierDetection
OutlierDetection getOutlierDetection()
Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. 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:
- The outlierDetection.
-
getOutlierDetectionOrBuilder
OutlierDetectionOrBuilder getOutlierDetectionOrBuilder()
Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. 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;
-
hasPort
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:
- Whether the port field is set.
-
getPort
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:
- The port.
-
hasPortName
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](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). 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:
- Whether the portName field is set.
-
getPortName
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](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). 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:
- The portName.
-
getPortNameBytes
com.google.protobuf.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](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). 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:
- The bytes for portName.
-
hasProtocol
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;
- Returns:
- Whether the protocol field is set.
-
getProtocol
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;
- Returns:
- The protocol.
-
getProtocolBytes
com.google.protobuf.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;
- Returns:
- The bytes for protocol.
-
hasRegion
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;
- Returns:
- Whether the region field is set.
-
getRegion
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;
- Returns:
- The region.
-
getRegionBytes
com.google.protobuf.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;
- Returns:
- The bytes for region.
-
hasSecurityPolicy
boolean hasSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;
- Returns:
- Whether the securityPolicy field is set.
-
getSecurityPolicy
String getSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;
- Returns:
- The securityPolicy.
-
getSecurityPolicyBytes
com.google.protobuf.ByteString getSecurityPolicyBytes()
[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;
- Returns:
- The bytes for securityPolicy.
-
hasSecuritySettings
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:
- Whether the securitySettings field is set.
-
getSecuritySettings
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:
- The securitySettings.
-
getSecuritySettingsOrBuilder
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;
-
hasSelfLink
boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
- Returns:
- Whether the selfLink field is set.
-
getSelfLink
String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
- Returns:
- The selfLink.
-
getSelfLinkBytes
com.google.protobuf.ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
- Returns:
- The bytes for selfLink.
-
getServiceBindingsList
List<String> 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:
- A list containing the serviceBindings.
-
getServiceBindingsCount
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:
- The count of serviceBindings.
-
getServiceBindings
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;
- Parameters:
index
- The index of the element to return.- Returns:
- The serviceBindings at the given index.
-
getServiceBindingsBytes
com.google.protobuf.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;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the serviceBindings at the given index.
-
hasSessionAffinity
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](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). Check the SessionAffinity enum for the list of possible values.
optional string session_affinity = 463888561;
- Returns:
- Whether the sessionAffinity field is set.
-
getSessionAffinity
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](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). Check the SessionAffinity enum for the list of possible values.
optional string session_affinity = 463888561;
- Returns:
- The sessionAffinity.
-
getSessionAffinityBytes
com.google.protobuf.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](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). Check the SessionAffinity enum for the list of possible values.
optional string session_affinity = 463888561;
- Returns:
- The bytes for sessionAffinity.
-
hasSubsetting
boolean hasSubsetting()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
- Returns:
- Whether the subsetting field is set.
-
getSubsetting
Subsetting getSubsetting()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
- Returns:
- The subsetting.
-
getSubsettingOrBuilder
SubsettingOrBuilder getSubsettingOrBuilder()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
-
hasTimeoutSec
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;
- Returns:
- Whether the timeoutSec field is set.
-
getTimeoutSec
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;
- Returns:
- The timeoutSec.
-
-