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
@Generated
public interface BackendServiceOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsMetadatas(String key) Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHintLifetime of cookies in seconds.getBackends(int index) The list of backends that serve this BackendService.intThe list of backends that serve this BackendService.The list of backends that serve this BackendService.getBackendsOrBuilder(int index) The list of backends that serve this BackendService.List<? extends BackendOrBuilder>The list of backends that serve this BackendService.Cloud CDN configuration for this BackendService.Cloud CDN configuration for this BackendService.optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.com.google.protobuf.ByteStringCompress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.connectionDraining cannot be specified with haPolicy.connectionDraining cannot be specified with haPolicy.Connection Tracking configuration for this BackendService.Connection Tracking configuration for this BackendService.Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.Output only.com.google.protobuf.ByteStringOutput only.getCustomMetrics(int index) List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.intList of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.getCustomMetricsOrBuilder(int index) List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.List<? extends BackendServiceCustomMetricOrBuilder>List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.getCustomRequestHeaders(int index) Headers that the load balancer adds to proxied requests.com.google.protobuf.ByteStringgetCustomRequestHeadersBytes(int index) Headers that the load balancer adds to proxied requests.intHeaders that the load balancer adds to proxied requests.Headers that the load balancer adds to proxied requests.getCustomResponseHeaders(int index) Headers that the load balancer adds to proxied responses.com.google.protobuf.ByteStringgetCustomResponseHeadersBytes(int index) Headers that the load balancer adds to proxied responses.intHeaders that the load balancer adds to proxied responses.Headers that the load balancer adds to proxied responses.An optional description of this resource.com.google.protobuf.ByteStringAn optional description of this resource.[Output Only] The resource URL for the edge security policy associated with this backend service.com.google.protobuf.ByteString[Output Only] The resource URL for the edge security policy associated with this backend service.booleanIf true, enables Cloud CDN for the backend service of a global external Application Load Balancer.Specifies the canary migration state.com.google.protobuf.ByteStringSpecifies the canary migration state.floatDetermines the fraction of requests that should be processed by the Global external Application Load Balancer.Requires at least one backend instance group to be defined as a backup (failover) backend.Requires at least one backend instance group to be defined as a backup (failover) backend.Fingerprint of this resource.com.google.protobuf.ByteStringFingerprint of this resource.Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding.Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding.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.ByteStringgetHealthChecksBytes(int index) The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.intThe list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.getIap()The configurations for Identity-Aware Proxy on this resource.The configurations for Identity-Aware Proxy on this resource.longgetId()[Output Only] The unique identifier for the resource.Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC).com.google.protobuf.ByteStringSpecifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC).getKind()Output only.com.google.protobuf.ByteStringOutput only.Specifies the load balancer type.com.google.protobuf.ByteStringSpecifies the load balancer type.getLocalityLbPolicies(int index) A list of locality load-balancing policies to be used in order of preference.intA list of locality load-balancing policies to be used in order of preference.A list of locality load-balancing policies to be used in order of preference.getLocalityLbPoliciesOrBuilder(int index) A list of locality load-balancing policies to be used in order of preference.A list of locality load-balancing policies to be used in order of preference.The load balancing algorithm used within the scope of the locality.com.google.protobuf.ByteStringThe load balancing algorithm used within the scope of the locality.This field denotes the logging options for the load balancer traffic served by this backend service.This field denotes the logging options for the load balancer traffic served by this backend service.Specifies the default maximum duration (timeout) for streams to this service.Specifies the default maximum duration (timeout) for streams to this service.Deprecated.intDeployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHDeployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHgetMetadatasOrDefault(String key, String defaultValue) Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHDeployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHgetName()Name of the resource.com.google.protobuf.ByteStringName of the resource.The URL of the network to which this backend service belongs.com.google.protobuf.ByteStringThe URL of the network to which this backend service belongs.Configures traffic steering properties of internal passthrough Network Load Balancers.Configures traffic steering properties of internal passthrough Network Load Balancers.Information about the resource or system that manages the backend service.Information about the resource or system that manages the backend service.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.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.Input only.Input only.intgetPort()Deprecated in favor of portName.A named port on a backend instance group representing the port for communication to the backend VMs in that group.com.google.protobuf.ByteStringA named port on a backend instance group representing the port for communication to the backend VMs in that group.The protocol this BackendService uses to communicate with backends.com.google.protobuf.ByteStringThe protocol this BackendService uses to communicate with backends.Output only.com.google.protobuf.ByteStringOutput only.[Output Only] The resource URL for the security policy associated with this backend service.com.google.protobuf.ByteString[Output Only] The resource URL for the security policy associated with this backend service.This field specifies the security settings that apply to this backend service.This field specifies the security settings that apply to this backend service.[Output Only] Server-defined URL for the resource.com.google.protobuf.ByteString[Output Only] Server-defined URL for the resource.getServiceBindings(int index) URLs of networkservices.ServiceBinding resources.com.google.protobuf.ByteStringgetServiceBindingsBytes(int index) URLs of networkservices.ServiceBinding resources.intURLs of networkservices.ServiceBinding resources.URLs of networkservices.ServiceBinding resources.URL to networkservices.ServiceLbPolicy resource.com.google.protobuf.ByteStringURL to networkservices.ServiceLbPolicy resource.Type of session affinity to use.com.google.protobuf.ByteStringType of session affinity to use.Describes the HTTP cookie used for stateful session affinity.Describes the HTTP cookie used for stateful session affinity.subsetting cannot be specified with haPolicy.subsetting cannot be specified with haPolicy.intThe backend service timeout has a different meaning depending on the type of load balancer.Configuration for Backend Authenticated TLS and mTLS.Configuration for Backend Authenticated TLS and mTLS.getUsedBy(int index) Output only.intOutput only.Output only.getUsedByOrBuilder(int index) Output only.List<? extends BackendServiceUsedByOrBuilder>Output only.booleanLifetime of cookies in seconds.booleanCloud CDN configuration for this BackendService.booleanoptional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;booleanCompress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.booleanconnectionDraining cannot be specified with haPolicy.booleanConnection Tracking configuration for this BackendService.booleanConsistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.booleanOutput only.booleanAn optional description of this resource.boolean[Output Only] The resource URL for the edge security policy associated with this backend service.booleanIf true, enables Cloud CDN for the backend service of a global external Application Load Balancer.booleanSpecifies the canary migration state.booleanDetermines the fraction of requests that should be processed by the Global external Application Load Balancer.booleanRequires at least one backend instance group to be defined as a backup (failover) backend.booleanFingerprint of this resource.booleanConfigures self-managed High Availability (HA) for External and Internal Protocol Forwarding.booleanhasIap()The configurations for Identity-Aware Proxy on this resource.booleanhasId()[Output Only] The unique identifier for the resource.booleanSpecifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC).booleanhasKind()Output only.booleanSpecifies the load balancer type.booleanThe load balancing algorithm used within the scope of the locality.booleanThis field denotes the logging options for the load balancer traffic served by this backend service.booleanSpecifies the default maximum duration (timeout) for streams to this service.booleanhasName()Name of the resource.booleanThe URL of the network to which this backend service belongs.booleanConfigures traffic steering properties of internal passthrough Network Load Balancers.booleanInformation about the resource or system that manages the backend service.booleanSettings 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.booleanInput only.booleanhasPort()Deprecated in favor of portName.booleanA named port on a backend instance group representing the port for communication to the backend VMs in that group.booleanThe protocol this BackendService uses to communicate with backends.booleanOutput only.boolean[Output Only] The resource URL for the security policy associated with this backend service.booleanThis field specifies the security settings that apply to this backend service.boolean[Output Only] Server-defined URL for the resource.booleanURL to networkservices.ServiceLbPolicy resource.booleanType of session affinity to use.booleanDescribes the HTTP cookie used for stateful session affinity.booleansubsetting cannot be specified with haPolicy.booleanThe backend service timeout has a different meaning depending on the type of load balancer.booleanConfiguration for Backend Authenticated TLS and mTLS.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasAffinityCookieTtlSec
boolean hasAffinityCookieTtlSec()Lifetime of cookies in seconds. This setting is applicable to Application 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 Application 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
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903; -
getBackends
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
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()connectionDraining cannot be specified with haPolicy.
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;- Returns:
- Whether the connectionDraining field is set.
-
getConnectionDraining
ConnectionDraining getConnectionDraining()connectionDraining cannot be specified with haPolicy.
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;- Returns:
- The connectionDraining.
-
getConnectionDrainingOrBuilder
ConnectionDrainingOrBuilder getConnectionDrainingOrBuilder()connectionDraining cannot be specified with haPolicy.
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 external passthrough Network Load Balancers and internal passthrough Network Load Balancers. connectionTrackingPolicy cannot be specified with haPolicy.
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 external passthrough Network Load Balancers and internal passthrough Network Load Balancers. connectionTrackingPolicy cannot be specified with haPolicy.
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 external passthrough Network Load Balancers and internal passthrough Network Load Balancers. connectionTrackingPolicy cannot be specified with haPolicy.
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 whenlocalityLbPolicy is set to MAGLEV orRING_HASH. This field is applicable to either: - A regional backend service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, 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 whenlocalityLbPolicy is set to MAGLEV orRING_HASH. This field is applicable to either: - A regional backend service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, 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 whenlocalityLbPolicy is set to MAGLEV orRING_HASH. This field is applicable to either: - A regional backend service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, 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. [Output Only] Creation timestamp inRFC3339 text format.
optional string creation_timestamp = 30525366;- Returns:
- Whether the creationTimestamp field is set.
-
getCreationTimestamp
String getCreationTimestamp()Output only. [Output Only] Creation timestamp inRFC3339 text format.
optional string creation_timestamp = 30525366;- Returns:
- The creationTimestamp.
-
getCreationTimestampBytes
com.google.protobuf.ByteString getCreationTimestampBytes()Output only. [Output Only] Creation timestamp inRFC3339 text format.
optional string creation_timestamp = 30525366;- Returns:
- The bytes for creationTimestamp.
-
getCustomMetricsList
List<BackendServiceCustomMetric> getCustomMetricsList()List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
repeated .google.cloud.compute.v1.BackendServiceCustomMetric custom_metrics = 429453813; -
getCustomMetrics
List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
repeated .google.cloud.compute.v1.BackendServiceCustomMetric custom_metrics = 429453813; -
getCustomMetricsCount
int getCustomMetricsCount()List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
repeated .google.cloud.compute.v1.BackendServiceCustomMetric custom_metrics = 429453813; -
getCustomMetricsOrBuilderList
List<? extends BackendServiceCustomMetricOrBuilder> getCustomMetricsOrBuilderList()List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
repeated .google.cloud.compute.v1.BackendServiceCustomMetric custom_metrics = 429453813; -
getCustomMetricsOrBuilder
List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
repeated .google.cloud.compute.v1.BackendServiceCustomMetric custom_metrics = 429453813; -
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
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
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
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 a global external Application 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 a global external Application Load Balancer.
optional bool enable_c_d_n = 250733499;- Returns:
- The enableCDN.
-
hasExternalManagedMigrationState
boolean hasExternalManagedMigrationState()Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. Check the ExternalManagedMigrationState enum for the list of possible values.
optional string external_managed_migration_state = 66947020;- Returns:
- Whether the externalManagedMigrationState field is set.
-
getExternalManagedMigrationState
String getExternalManagedMigrationState()Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. Check the ExternalManagedMigrationState enum for the list of possible values.
optional string external_managed_migration_state = 66947020;- Returns:
- The externalManagedMigrationState.
-
getExternalManagedMigrationStateBytes
com.google.protobuf.ByteString getExternalManagedMigrationStateBytes()Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. Check the ExternalManagedMigrationState enum for the list of possible values.
optional string external_managed_migration_state = 66947020;- Returns:
- The bytes for externalManagedMigrationState.
-
hasExternalManagedMigrationTestingPercentage
boolean hasExternalManagedMigrationTestingPercentage()Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see:Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE.
optional float external_managed_migration_testing_percentage = 507232462;- Returns:
- Whether the externalManagedMigrationTestingPercentage field is set.
-
getExternalManagedMigrationTestingPercentage
float getExternalManagedMigrationTestingPercentage()Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see:Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE.
optional float external_managed_migration_testing_percentage = 507232462;- Returns:
- The externalManagedMigrationTestingPercentage.
-
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 passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). failoverPolicy cannot be specified with haPolicy.
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 passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). failoverPolicy cannot be specified with haPolicy.
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 passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). failoverPolicy cannot be specified with haPolicy.
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.
-
hasHaPolicy
boolean hasHaPolicy()Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. The backends of this regional backend service must only specify zonal network endpoint groups (NEGs) of type GCE_VM_IP. When haPolicy is set for an Internal Passthrough Network Load Balancer, the regional backend service must set the network field. All zonal NEGs must belong to the same network. However, individual NEGs can belong to different subnetworks of that network. When haPolicy is specified, the set of attached network endpoints across all backends comprise an High Availability domain from which one endpoint is selected as the active endpoint (the leader) that receives all traffic. haPolicy can be added only at backend service creation time. Once set up, it cannot be deleted. Note that haPolicy is not for load balancing, and therefore cannot be specified with sessionAffinity, connectionTrackingPolicy, and failoverPolicy. haPolicy requires customers to be responsible for tracking backend endpoint health and electing a leader among the healthy endpoints. Therefore, haPolicy cannot be specified with healthChecks. haPolicy can only be specified for External Passthrough Network Load Balancers and Internal Passthrough Network Load Balancers.
optional .google.cloud.compute.v1.BackendServiceHAPolicy ha_policy = 519879480;- Returns:
- Whether the haPolicy field is set.
-
getHaPolicy
BackendServiceHAPolicy getHaPolicy()Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. The backends of this regional backend service must only specify zonal network endpoint groups (NEGs) of type GCE_VM_IP. When haPolicy is set for an Internal Passthrough Network Load Balancer, the regional backend service must set the network field. All zonal NEGs must belong to the same network. However, individual NEGs can belong to different subnetworks of that network. When haPolicy is specified, the set of attached network endpoints across all backends comprise an High Availability domain from which one endpoint is selected as the active endpoint (the leader) that receives all traffic. haPolicy can be added only at backend service creation time. Once set up, it cannot be deleted. Note that haPolicy is not for load balancing, and therefore cannot be specified with sessionAffinity, connectionTrackingPolicy, and failoverPolicy. haPolicy requires customers to be responsible for tracking backend endpoint health and electing a leader among the healthy endpoints. Therefore, haPolicy cannot be specified with healthChecks. haPolicy can only be specified for External Passthrough Network Load Balancers and Internal Passthrough Network Load Balancers.
optional .google.cloud.compute.v1.BackendServiceHAPolicy ha_policy = 519879480;- Returns:
- The haPolicy.
-
getHaPolicyOrBuilder
BackendServiceHAPolicyOrBuilder getHaPolicyOrBuilder()Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. The backends of this regional backend service must only specify zonal network endpoint groups (NEGs) of type GCE_VM_IP. When haPolicy is set for an Internal Passthrough Network Load Balancer, the regional backend service must set the network field. All zonal NEGs must belong to the same network. However, individual NEGs can belong to different subnetworks of that network. When haPolicy is specified, the set of attached network endpoints across all backends comprise an High Availability domain from which one endpoint is selected as the active endpoint (the leader) that receives all traffic. haPolicy can be added only at backend service creation time. Once set up, it cannot be deleted. Note that haPolicy is not for load balancing, and therefore cannot be specified with sessionAffinity, connectionTrackingPolicy, and failoverPolicy. haPolicy requires customers to be responsible for tracking backend endpoint health and electing a leader among the healthy endpoints. Therefore, haPolicy cannot be specified with healthChecks. haPolicy can only be specified for External Passthrough Network Load Balancers and Internal Passthrough Network Load Balancers.
optional .google.cloud.compute.v1.BackendServiceHAPolicy ha_policy = 519879480; -
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 unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy.
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 unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy.
repeated string health_checks = 448370606;- Returns:
- The count of healthChecks.
-
getHealthChecks
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 unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy.
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 unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy.
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 passthrough Network Load Balancers and external passthrough Network Load Balancers.
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 passthrough Network Load Balancers and external passthrough Network Load Balancers.
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 passthrough Network Load Balancers and external passthrough Network Load Balancers.
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.
-
hasIpAddressSelectionPolicy
boolean hasIpAddressSelectionPolicy()Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - Regional external Application Load Balancer, - Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). Check the IpAddressSelectionPolicy enum for the list of possible values.
optional string ip_address_selection_policy = 77600840;- Returns:
- Whether the ipAddressSelectionPolicy field is set.
-
getIpAddressSelectionPolicy
String getIpAddressSelectionPolicy()Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - Regional external Application Load Balancer, - Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). Check the IpAddressSelectionPolicy enum for the list of possible values.
optional string ip_address_selection_policy = 77600840;- Returns:
- The ipAddressSelectionPolicy.
-
getIpAddressSelectionPolicyBytes
com.google.protobuf.ByteString getIpAddressSelectionPolicyBytes()Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - Regional external Application Load Balancer, - Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). Check the IpAddressSelectionPolicy enum for the list of possible values.
optional string ip_address_selection_policy = 77600840;- Returns:
- The bytes for ipAddressSelectionPolicy.
-
hasKind
boolean hasKind()Output only. [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. [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. [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 toChoosing 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 toChoosing 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 toChoosing 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, seeDefine 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
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, seeDefine 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, seeDefine 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, seeDefine 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
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, seeDefine 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 Maglev: A Fast and Reliable Software Network Load Balancer. - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via thecustomMetrics field. This field is applicable to either: - A regional backend service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy isMAGLEV. 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. localityLbPolicy cannot be specified with haPolicy. 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 Maglev: A Fast and Reliable Software Network Load Balancer. - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via thecustomMetrics field. This field is applicable to either: - A regional backend service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy isMAGLEV. 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. localityLbPolicy cannot be specified with haPolicy. 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 Maglev: A Fast and Reliable Software Network Load Balancer. - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via thecustomMetrics field. This field is applicable to either: - A regional backend service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy isMAGLEV. 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. localityLbPolicy cannot be specified with haPolicy. 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
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.UsegetMetadatasMap()instead. -
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
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
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 withRFC1035. 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 withRFC1035. 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 withRFC1035. 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 must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
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 must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
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 must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
optional string network = 232872494;- Returns:
- The bytes for network.
-
hasNetworkPassThroughLbTrafficPolicy
boolean hasNetworkPassThroughLbTrafficPolicy()Configures traffic steering properties of internal passthrough Network Load Balancers. networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
optional .google.cloud.compute.v1.BackendServiceNetworkPassThroughLbTrafficPolicy network_pass_through_lb_traffic_policy = 230323750;- Returns:
- Whether the networkPassThroughLbTrafficPolicy field is set.
-
getNetworkPassThroughLbTrafficPolicy
BackendServiceNetworkPassThroughLbTrafficPolicy getNetworkPassThroughLbTrafficPolicy()Configures traffic steering properties of internal passthrough Network Load Balancers. networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
optional .google.cloud.compute.v1.BackendServiceNetworkPassThroughLbTrafficPolicy network_pass_through_lb_traffic_policy = 230323750;- Returns:
- The networkPassThroughLbTrafficPolicy.
-
getNetworkPassThroughLbTrafficPolicyOrBuilder
BackendServiceNetworkPassThroughLbTrafficPolicyOrBuilder getNetworkPassThroughLbTrafficPolicyOrBuilder()Configures traffic steering properties of internal passthrough Network Load Balancers. networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
optional .google.cloud.compute.v1.BackendServiceNetworkPassThroughLbTrafficPolicy network_pass_through_lb_traffic_policy = 230323750; -
hasOrchestrationInfo
boolean hasOrchestrationInfo()Information about the resource or system that manages the backend service.
optional .google.cloud.compute.v1.BackendServiceOrchestrationInfo orchestration_info = 441144300;- Returns:
- Whether the orchestrationInfo field is set.
-
getOrchestrationInfo
BackendServiceOrchestrationInfo getOrchestrationInfo()Information about the resource or system that manages the backend service.
optional .google.cloud.compute.v1.BackendServiceOrchestrationInfo orchestration_info = 441144300;- Returns:
- The orchestrationInfo.
-
getOrchestrationInfoOrBuilder
BackendServiceOrchestrationInfoOrBuilder getOrchestrationInfoOrBuilder()Information about the resource or system that manages the backend service.
optional .google.cloud.compute.v1.BackendServiceOrchestrationInfo orchestration_info = 441144300; -
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 service protocol set to HTTP, HTTPS, HTTP2 or H2C, 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 service protocol set to HTTP, HTTPS, HTTP2 or H2C, 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 service protocol set to HTTP, HTTPS, HTTP2 or H2C, 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; -
hasParams
boolean hasParams()Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
optional .google.cloud.compute.v1.BackendServiceParams params = 78313862;- Returns:
- Whether the params field is set.
-
getParams
BackendServiceParams getParams()Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
optional .google.cloud.compute.v1.BackendServiceParams params = 78313862;- Returns:
- The params.
-
getParamsOrBuilder
BackendServiceParamsOrBuilder getParamsOrBuilder()Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
optional .google.cloud.compute.v1.BackendServiceParams params = 78313862; -
hasPort
boolean hasPort()Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, 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 passthrough Network Load Balancers and external passthrough Network Load Balancers, 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 passthrough Network Load Balancers and external passthrough Network Load Balancers, 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 passthrough Network Load Balancers and external passthrough Network Load Balancers, 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 passthrough Network Load Balancers and external passthrough Network Load Balancers, 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, H2C, 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, H2C, 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, H2C, 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. [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. [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. [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
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
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.
-
hasServiceLbPolicy
boolean hasServiceLbPolicy()URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
optional string service_lb_policy = 94848785;- Returns:
- Whether the serviceLbPolicy field is set.
-
getServiceLbPolicy
String getServiceLbPolicy()URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
optional string service_lb_policy = 94848785;- Returns:
- The serviceLbPolicy.
-
getServiceLbPolicyBytes
com.google.protobuf.ByteString getServiceLbPolicyBytes()URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
optional string service_lb_policy = 94848785;- Returns:
- The bytes for serviceLbPolicy.
-
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). sessionAffinity cannot be specified with haPolicy. 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). sessionAffinity cannot be specified with haPolicy. 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). sessionAffinity cannot be specified with haPolicy. Check the SessionAffinity enum for the list of possible values.
optional string session_affinity = 463888561;- Returns:
- The bytes for sessionAffinity.
-
hasStrongSessionAffinityCookie
boolean hasStrongSessionAffinityCookie()Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
optional .google.cloud.compute.v1.BackendServiceHttpCookie strong_session_affinity_cookie = 238195722;- Returns:
- Whether the strongSessionAffinityCookie field is set.
-
getStrongSessionAffinityCookie
BackendServiceHttpCookie getStrongSessionAffinityCookie()Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
optional .google.cloud.compute.v1.BackendServiceHttpCookie strong_session_affinity_cookie = 238195722;- Returns:
- The strongSessionAffinityCookie.
-
getStrongSessionAffinityCookieOrBuilder
BackendServiceHttpCookieOrBuilder getStrongSessionAffinityCookieOrBuilder()Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
optional .google.cloud.compute.v1.BackendServiceHttpCookie strong_session_affinity_cookie = 238195722; -
hasSubsetting
boolean hasSubsetting()subsetting cannot be specified with haPolicy.
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;- Returns:
- Whether the subsetting field is set.
-
getSubsetting
Subsetting getSubsetting()subsetting cannot be specified with haPolicy.
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;- Returns:
- The subsetting.
-
getSubsettingOrBuilder
SubsettingOrBuilder getSubsettingOrBuilder()subsetting cannot be specified with haPolicy.
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.
-
hasTlsSettings
boolean hasTlsSettings()Configuration for Backend Authenticated TLS and mTLS. May only be specified when the backend protocol is SSL, HTTPS or HTTP2.
optional .google.cloud.compute.v1.BackendServiceTlsSettings tls_settings = 81794791;- Returns:
- Whether the tlsSettings field is set.
-
getTlsSettings
BackendServiceTlsSettings getTlsSettings()Configuration for Backend Authenticated TLS and mTLS. May only be specified when the backend protocol is SSL, HTTPS or HTTP2.
optional .google.cloud.compute.v1.BackendServiceTlsSettings tls_settings = 81794791;- Returns:
- The tlsSettings.
-
getTlsSettingsOrBuilder
BackendServiceTlsSettingsOrBuilder getTlsSettingsOrBuilder()Configuration for Backend Authenticated TLS and mTLS. May only be specified when the backend protocol is SSL, HTTPS or HTTP2.
optional .google.cloud.compute.v1.BackendServiceTlsSettings tls_settings = 81794791; -
getUsedByList
List<BackendServiceUsedBy> getUsedByList()Output only. [Output Only] List of resources referencing given backend service.
repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729; -
getUsedBy
Output only. [Output Only] List of resources referencing given backend service.
repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729; -
getUsedByCount
int getUsedByCount()Output only. [Output Only] List of resources referencing given backend service.
repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729; -
getUsedByOrBuilderList
List<? extends BackendServiceUsedByOrBuilder> getUsedByOrBuilderList()Output only. [Output Only] List of resources referencing given backend service.
repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729; -
getUsedByOrBuilder
Output only. [Output Only] List of resources referencing given backend service.
repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729;
-