Class UrlMap.Builder (1.65.0) 

public static final class UrlMap.Builder extends GeneratedMessageV3.Builder<UrlMap.Builder> implements UrlMapOrBuilder

Represents a URL Map resource. Compute Engine has two URL Map resources: * Global * Regional A URL map resource is a component of certain types of cloud load balancers and Traffic Director: * urlMaps are used by global external Application Load Balancers, classic Application Load Balancers, and cross-region internal Application Load Balancers. * regionUrlMaps are used by internal Application Load Balancers, regional external Application Load Balancers and regional internal Application Load Balancers. For a list of supported URL map features by the load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from hostnames and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL, EXTERNAL_MANAGED, or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.

Protobuf type google.cloud.compute.v1.UrlMap

Inheritance

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

Implements

UrlMapOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllHostRules(Iterable<? extends HostRule> values)

public UrlMap.Builder addAllHostRules(Iterable<? extends HostRule> values)

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.HostRule>
Returns
Type Description
UrlMap.Builder

addAllPathMatchers(Iterable<? extends PathMatcher> values)

public UrlMap.Builder addAllPathMatchers(Iterable<? extends PathMatcher> values)

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.PathMatcher>
Returns
Type Description
UrlMap.Builder

addAllTests(Iterable<? extends UrlMapTest> values)

public UrlMap.Builder addAllTests(Iterable<? extends UrlMapTest> values)

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.UrlMapTest>
Returns
Type Description
UrlMap.Builder

addHostRules(HostRule value)

public UrlMap.Builder addHostRules(HostRule value)

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Parameter
Name Description
value HostRule
Returns
Type Description
UrlMap.Builder

addHostRules(HostRule.Builder builderForValue)

public UrlMap.Builder addHostRules(HostRule.Builder builderForValue)

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Parameter
Name Description
builderForValue HostRule.Builder
Returns
Type Description
UrlMap.Builder

addHostRules(int index, HostRule value)

public UrlMap.Builder addHostRules(int index, HostRule value)

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Parameters
Name Description
index int
value HostRule
Returns
Type Description
UrlMap.Builder

addHostRules(int index, HostRule.Builder builderForValue)

public UrlMap.Builder addHostRules(int index, HostRule.Builder builderForValue)

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Parameters
Name Description
index int
builderForValue HostRule.Builder
Returns
Type Description
UrlMap.Builder

addHostRulesBuilder()

public HostRule.Builder addHostRulesBuilder()

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Returns
Type Description
HostRule.Builder

addHostRulesBuilder(int index)

public HostRule.Builder addHostRulesBuilder(int index)

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Parameter
Name Description
index int
Returns
Type Description
HostRule.Builder

addPathMatchers(PathMatcher value)

public UrlMap.Builder addPathMatchers(PathMatcher value)

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Parameter
Name Description
value PathMatcher
Returns
Type Description
UrlMap.Builder

addPathMatchers(PathMatcher.Builder builderForValue)

public UrlMap.Builder addPathMatchers(PathMatcher.Builder builderForValue)

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Parameter
Name Description
builderForValue PathMatcher.Builder
Returns
Type Description
UrlMap.Builder

addPathMatchers(int index, PathMatcher value)

public UrlMap.Builder addPathMatchers(int index, PathMatcher value)

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Parameters
Name Description
index int
value PathMatcher
Returns
Type Description
UrlMap.Builder

addPathMatchers(int index, PathMatcher.Builder builderForValue)

public UrlMap.Builder addPathMatchers(int index, PathMatcher.Builder builderForValue)

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Parameters
Name Description
index int
builderForValue PathMatcher.Builder
Returns
Type Description
UrlMap.Builder

addPathMatchersBuilder()

public PathMatcher.Builder addPathMatchersBuilder()

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Returns
Type Description
PathMatcher.Builder

addPathMatchersBuilder(int index)

public PathMatcher.Builder addPathMatchersBuilder(int index)

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Parameter
Name Description
index int
Returns
Type Description
PathMatcher.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UrlMap.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UrlMap.Builder
Overrides

addTests(UrlMapTest value)

public UrlMap.Builder addTests(UrlMapTest value)

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Parameter
Name Description
value UrlMapTest
Returns
Type Description
UrlMap.Builder

addTests(UrlMapTest.Builder builderForValue)

public UrlMap.Builder addTests(UrlMapTest.Builder builderForValue)

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Parameter
Name Description
builderForValue UrlMapTest.Builder
Returns
Type Description
UrlMap.Builder

addTests(int index, UrlMapTest value)

public UrlMap.Builder addTests(int index, UrlMapTest value)

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Parameters
Name Description
index int
value UrlMapTest
Returns
Type Description
UrlMap.Builder

addTests(int index, UrlMapTest.Builder builderForValue)

public UrlMap.Builder addTests(int index, UrlMapTest.Builder builderForValue)

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Parameters
Name Description
index int
builderForValue UrlMapTest.Builder
Returns
Type Description
UrlMap.Builder

addTestsBuilder()

public UrlMapTest.Builder addTestsBuilder()

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Returns
Type Description
UrlMapTest.Builder

addTestsBuilder(int index)

public UrlMapTest.Builder addTestsBuilder(int index)

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Parameter
Name Description
index int
Returns
Type Description
UrlMapTest.Builder

build()

public UrlMap build()
Returns
Type Description
UrlMap

buildPartial()

public UrlMap buildPartial()
Returns
Type Description
UrlMap

clear()

public UrlMap.Builder clear()
Returns
Type Description
UrlMap.Builder
Overrides

clearCreationTimestamp()

public UrlMap.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
UrlMap.Builder

This builder for chaining.

clearDefaultCustomErrorResponsePolicy()

public UrlMap.Builder clearDefaultCustomErrorResponsePolicy()

defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089;

Returns
Type Description
UrlMap.Builder

clearDefaultRouteAction()

public UrlMap.Builder clearDefaultRouteAction()

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;

Returns
Type Description
UrlMap.Builder

clearDefaultService()

public UrlMap.Builder clearDefaultService()

The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional string default_service = 370242231;

Returns
Type Description
UrlMap.Builder

This builder for chaining.

clearDefaultUrlRedirect()

public UrlMap.Builder clearDefaultUrlRedirect()

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;

Returns
Type Description
UrlMap.Builder

clearDescription()

public UrlMap.Builder clearDescription()

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

optional string description = 422937596;

Returns
Type Description
UrlMap.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public UrlMap.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UrlMap.Builder
Overrides

clearFingerprint()

public UrlMap.Builder clearFingerprint()

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

optional string fingerprint = 234678500;

Returns
Type Description
UrlMap.Builder

This builder for chaining.

clearHeaderAction()

public UrlMap.Builder clearHeaderAction()

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
Type Description
UrlMap.Builder

clearHostRules()

public UrlMap.Builder clearHostRules()

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Returns
Type Description
UrlMap.Builder

clearId()

public UrlMap.Builder clearId()

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

optional uint64 id = 3355;

Returns
Type Description
UrlMap.Builder

This builder for chaining.

clearKind()

public UrlMap.Builder clearKind()

[Output Only] Type of the resource. Always compute#urlMaps for url maps.

optional string kind = 3292052;

Returns
Type Description
UrlMap.Builder

This builder for chaining.

clearName()

public UrlMap.Builder clearName()

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

optional string name = 3373707;

Returns
Type Description
UrlMap.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public UrlMap.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UrlMap.Builder
Overrides

clearPathMatchers()

public UrlMap.Builder clearPathMatchers()

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Returns
Type Description
UrlMap.Builder

clearRegion()

public UrlMap.Builder clearRegion()

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

optional string region = 138946292;

Returns
Type Description
UrlMap.Builder

This builder for chaining.

clearSelfLink()

public UrlMap.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
UrlMap.Builder

This builder for chaining.

clearTests()

public UrlMap.Builder clearTests()

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Returns
Type Description
UrlMap.Builder

clone()

public UrlMap.Builder clone()
Returns
Type Description
UrlMap.Builder
Overrides

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultCustomErrorResponsePolicy()

public CustomErrorResponsePolicy getDefaultCustomErrorResponsePolicy()

defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089;

Returns
Type Description
CustomErrorResponsePolicy

The defaultCustomErrorResponsePolicy.

getDefaultCustomErrorResponsePolicyBuilder()

public CustomErrorResponsePolicy.Builder getDefaultCustomErrorResponsePolicyBuilder()

defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089;

Returns
Type Description
CustomErrorResponsePolicy.Builder

getDefaultCustomErrorResponsePolicyOrBuilder()

public CustomErrorResponsePolicyOrBuilder getDefaultCustomErrorResponsePolicyOrBuilder()

defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089;

Returns
Type Description
CustomErrorResponsePolicyOrBuilder

getDefaultInstanceForType()

public UrlMap getDefaultInstanceForType()
Returns
Type Description
UrlMap

getDefaultRouteAction()

public HttpRouteAction getDefaultRouteAction()

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;

Returns
Type Description
HttpRouteAction

The defaultRouteAction.

getDefaultRouteActionBuilder()

public HttpRouteAction.Builder getDefaultRouteActionBuilder()

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;

Returns
Type Description
HttpRouteAction.Builder

getDefaultRouteActionOrBuilder()

public HttpRouteActionOrBuilder getDefaultRouteActionOrBuilder()

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;

Returns
Type Description
HttpRouteActionOrBuilder

getDefaultService()

public String getDefaultService()

The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional string default_service = 370242231;

Returns
Type Description
String

The defaultService.

getDefaultServiceBytes()

public ByteString getDefaultServiceBytes()

The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional string default_service = 370242231;

Returns
Type Description
ByteString

The bytes for defaultService.

getDefaultUrlRedirect()

public HttpRedirectAction getDefaultUrlRedirect()

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;

Returns
Type Description
HttpRedirectAction

The defaultUrlRedirect.

getDefaultUrlRedirectBuilder()

public HttpRedirectAction.Builder getDefaultUrlRedirectBuilder()

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;

Returns
Type Description
HttpRedirectAction.Builder

getDefaultUrlRedirectOrBuilder()

public HttpRedirectActionOrBuilder getDefaultUrlRedirectOrBuilder()

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;

Returns
Type Description
HttpRedirectActionOrBuilder

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFingerprint()

public String getFingerprint()

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

optional string fingerprint = 234678500;

Returns
Type Description
String

The fingerprint.

getFingerprintBytes()

public ByteString getFingerprintBytes()

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

optional string fingerprint = 234678500;

Returns
Type Description
ByteString

The bytes for fingerprint.

getHeaderAction()

public HttpHeaderAction getHeaderAction()

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
Type Description
HttpHeaderAction

The headerAction.

getHeaderActionBuilder()

public HttpHeaderAction.Builder getHeaderActionBuilder()

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
Type Description
HttpHeaderAction.Builder

getHeaderActionOrBuilder()

public HttpHeaderActionOrBuilder getHeaderActionOrBuilder()

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
Type Description
HttpHeaderActionOrBuilder

getHostRules(int index)

public HostRule getHostRules(int index)

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Parameter
Name Description
index int
Returns
Type Description
HostRule

getHostRulesBuilder(int index)

public HostRule.Builder getHostRulesBuilder(int index)

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Parameter
Name Description
index int
Returns
Type Description
HostRule.Builder

getHostRulesBuilderList()

public List<HostRule.Builder> getHostRulesBuilderList()

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Returns
Type Description
List<Builder>

getHostRulesCount()

public int getHostRulesCount()

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Returns
Type Description
int

getHostRulesList()

public List<HostRule> getHostRulesList()

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Returns
Type Description
List<HostRule>

getHostRulesOrBuilder(int index)

public HostRuleOrBuilder getHostRulesOrBuilder(int index)

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Parameter
Name Description
index int
Returns
Type Description
HostRuleOrBuilder

getHostRulesOrBuilderList()

public List<? extends HostRuleOrBuilder> getHostRulesOrBuilderList()

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

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

getId()

public long getId()

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

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#urlMaps for url maps.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#urlMaps for url maps.

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getName()

public String getName()

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

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getPathMatchers(int index)

public PathMatcher getPathMatchers(int index)

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Parameter
Name Description
index int
Returns
Type Description
PathMatcher

getPathMatchersBuilder(int index)

public PathMatcher.Builder getPathMatchersBuilder(int index)

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Parameter
Name Description
index int
Returns
Type Description
PathMatcher.Builder

getPathMatchersBuilderList()

public List<PathMatcher.Builder> getPathMatchersBuilderList()

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Returns
Type Description
List<Builder>

getPathMatchersCount()

public int getPathMatchersCount()

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Returns
Type Description
int

getPathMatchersList()

public List<PathMatcher> getPathMatchersList()

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Returns
Type Description
List<PathMatcher>

getPathMatchersOrBuilder(int index)

public PathMatcherOrBuilder getPathMatchersOrBuilder(int index)

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Parameter
Name Description
index int
Returns
Type Description
PathMatcherOrBuilder

getPathMatchersOrBuilderList()

public List<? extends PathMatcherOrBuilder> getPathMatchersOrBuilderList()

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

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

getRegion()

public String getRegion()

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

optional string region = 138946292;

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

optional string region = 138946292;

Returns
Type Description
ByteString

The bytes for region.

getSelfLink()

public String getSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getTests(int index)

public UrlMapTest getTests(int index)

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Parameter
Name Description
index int
Returns
Type Description
UrlMapTest

getTestsBuilder(int index)

public UrlMapTest.Builder getTestsBuilder(int index)

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Parameter
Name Description
index int
Returns
Type Description
UrlMapTest.Builder

getTestsBuilderList()

public List<UrlMapTest.Builder> getTestsBuilderList()

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Returns
Type Description
List<Builder>

getTestsCount()

public int getTestsCount()

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Returns
Type Description
int

getTestsList()

public List<UrlMapTest> getTestsList()

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Returns
Type Description
List<UrlMapTest>

getTestsOrBuilder(int index)

public UrlMapTestOrBuilder getTestsOrBuilder(int index)

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Parameter
Name Description
index int
Returns
Type Description
UrlMapTestOrBuilder

getTestsOrBuilderList()

public List<? extends UrlMapTestOrBuilder> getTestsOrBuilderList()

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

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

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDefaultCustomErrorResponsePolicy()

public boolean hasDefaultCustomErrorResponsePolicy()

defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089;

Returns
Type Description
boolean

Whether the defaultCustomErrorResponsePolicy field is set.

hasDefaultRouteAction()

public boolean hasDefaultRouteAction()

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;

Returns
Type Description
boolean

Whether the defaultRouteAction field is set.

hasDefaultService()

public boolean hasDefaultService()

The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional string default_service = 370242231;

Returns
Type Description
boolean

Whether the defaultService field is set.

hasDefaultUrlRedirect()

public boolean hasDefaultUrlRedirect()

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;

Returns
Type Description
boolean

Whether the defaultUrlRedirect field is set.

hasDescription()

public boolean hasDescription()

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

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasFingerprint()

public boolean hasFingerprint()

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

optional string fingerprint = 234678500;

Returns
Type Description
boolean

Whether the fingerprint field is set.

hasHeaderAction()

public boolean hasHeaderAction()

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Returns
Type Description
boolean

Whether the headerAction field is set.

hasId()

public boolean hasId()

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

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of the resource. Always compute#urlMaps for url maps.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasName()

public boolean hasName()

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

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasRegion()

public boolean hasRegion()

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

optional string region = 138946292;

Returns
Type Description
boolean

Whether the region field is set.

hasSelfLink()

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDefaultCustomErrorResponsePolicy(CustomErrorResponsePolicy value)

public UrlMap.Builder mergeDefaultCustomErrorResponsePolicy(CustomErrorResponsePolicy value)

defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089;

Parameter
Name Description
value CustomErrorResponsePolicy
Returns
Type Description
UrlMap.Builder

mergeDefaultRouteAction(HttpRouteAction value)

public UrlMap.Builder mergeDefaultRouteAction(HttpRouteAction value)

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;

Parameter
Name Description
value HttpRouteAction
Returns
Type Description
UrlMap.Builder

mergeDefaultUrlRedirect(HttpRedirectAction value)

public UrlMap.Builder mergeDefaultUrlRedirect(HttpRedirectAction value)

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;

Parameter
Name Description
value HttpRedirectAction
Returns
Type Description
UrlMap.Builder

mergeFrom(UrlMap other)

public UrlMap.Builder mergeFrom(UrlMap other)
Parameter
Name Description
other UrlMap
Returns
Type Description
UrlMap.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UrlMap.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UrlMap.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UrlMap.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UrlMap.Builder
Overrides

mergeHeaderAction(HttpHeaderAction value)

public UrlMap.Builder mergeHeaderAction(HttpHeaderAction value)

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Parameter
Name Description
value HttpHeaderAction
Returns
Type Description
UrlMap.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UrlMap.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UrlMap.Builder
Overrides

removeHostRules(int index)

public UrlMap.Builder removeHostRules(int index)

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Parameter
Name Description
index int
Returns
Type Description
UrlMap.Builder

removePathMatchers(int index)

public UrlMap.Builder removePathMatchers(int index)

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Parameter
Name Description
index int
Returns
Type Description
UrlMap.Builder

removeTests(int index)

public UrlMap.Builder removeTests(int index)

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Parameter
Name Description
index int
Returns
Type Description
UrlMap.Builder

setCreationTimestamp(String value)

public UrlMap.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value String

The creationTimestamp to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public UrlMap.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value ByteString

The bytes for creationTimestamp to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setDefaultCustomErrorResponsePolicy(CustomErrorResponsePolicy value)

public UrlMap.Builder setDefaultCustomErrorResponsePolicy(CustomErrorResponsePolicy value)

defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089;

Parameter
Name Description
value CustomErrorResponsePolicy
Returns
Type Description
UrlMap.Builder

setDefaultCustomErrorResponsePolicy(CustomErrorResponsePolicy.Builder builderForValue)

public UrlMap.Builder setDefaultCustomErrorResponsePolicy(CustomErrorResponsePolicy.Builder builderForValue)

defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.

optional .google.cloud.compute.v1.CustomErrorResponsePolicy default_custom_error_response_policy = 81266089;

Parameter
Name Description
builderForValue CustomErrorResponsePolicy.Builder
Returns
Type Description
UrlMap.Builder

setDefaultRouteAction(HttpRouteAction value)

public UrlMap.Builder setDefaultRouteAction(HttpRouteAction value)

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;

Parameter
Name Description
value HttpRouteAction
Returns
Type Description
UrlMap.Builder

setDefaultRouteAction(HttpRouteAction.Builder builderForValue)

public UrlMap.Builder setDefaultRouteAction(HttpRouteAction.Builder builderForValue)

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpRouteAction default_route_action = 378919466;

Parameter
Name Description
builderForValue HttpRouteAction.Builder
Returns
Type Description
UrlMap.Builder

setDefaultService(String value)

public UrlMap.Builder setDefaultService(String value)

The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional string default_service = 370242231;

Parameter
Name Description
value String

The defaultService to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setDefaultServiceBytes(ByteString value)

public UrlMap.Builder setDefaultServiceBytes(ByteString value)

The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

optional string default_service = 370242231;

Parameter
Name Description
value ByteString

The bytes for defaultService to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setDefaultUrlRedirect(HttpRedirectAction value)

public UrlMap.Builder setDefaultUrlRedirect(HttpRedirectAction value)

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;

Parameter
Name Description
value HttpRedirectAction
Returns
Type Description
UrlMap.Builder

setDefaultUrlRedirect(HttpRedirectAction.Builder builderForValue)

public UrlMap.Builder setDefaultUrlRedirect(HttpRedirectAction.Builder builderForValue)

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy.

optional .google.cloud.compute.v1.HttpRedirectAction default_url_redirect = 359503338;

Parameter
Name Description
builderForValue HttpRedirectAction.Builder
Returns
Type Description
UrlMap.Builder

setDescription(String value)

public UrlMap.Builder setDescription(String value)

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

optional string description = 422937596;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public UrlMap.Builder setDescriptionBytes(ByteString value)

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

optional string description = 422937596;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public UrlMap.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UrlMap.Builder
Overrides

setFingerprint(String value)

public UrlMap.Builder setFingerprint(String value)

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

optional string fingerprint = 234678500;

Parameter
Name Description
value String

The fingerprint to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setFingerprintBytes(ByteString value)

public UrlMap.Builder setFingerprintBytes(ByteString value)

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

optional string fingerprint = 234678500;

Parameter
Name Description
value ByteString

The bytes for fingerprint to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setHeaderAction(HttpHeaderAction value)

public UrlMap.Builder setHeaderAction(HttpHeaderAction value)

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Parameter
Name Description
value HttpHeaderAction
Returns
Type Description
UrlMap.Builder

setHeaderAction(HttpHeaderAction.Builder builderForValue)

public UrlMap.Builder setHeaderAction(HttpHeaderAction.Builder builderForValue)

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

optional .google.cloud.compute.v1.HttpHeaderAction header_action = 328077352;

Parameter
Name Description
builderForValue HttpHeaderAction.Builder
Returns
Type Description
UrlMap.Builder

setHostRules(int index, HostRule value)

public UrlMap.Builder setHostRules(int index, HostRule value)

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Parameters
Name Description
index int
value HostRule
Returns
Type Description
UrlMap.Builder

setHostRules(int index, HostRule.Builder builderForValue)

public UrlMap.Builder setHostRules(int index, HostRule.Builder builderForValue)

The list of host rules to use against the URL.

repeated .google.cloud.compute.v1.HostRule host_rules = 311804832;

Parameters
Name Description
index int
builderForValue HostRule.Builder
Returns
Type Description
UrlMap.Builder

setId(long value)

public UrlMap.Builder setId(long value)

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

optional uint64 id = 3355;

Parameter
Name Description
value long

The id to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setKind(String value)

public UrlMap.Builder setKind(String value)

[Output Only] Type of the resource. Always compute#urlMaps for url maps.

optional string kind = 3292052;

Parameter
Name Description
value String

The kind to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setKindBytes(ByteString value)

public UrlMap.Builder setKindBytes(ByteString value)

[Output Only] Type of the resource. Always compute#urlMaps for url maps.

optional string kind = 3292052;

Parameter
Name Description
value ByteString

The bytes for kind to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setName(String value)

public UrlMap.Builder setName(String value)

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

optional string name = 3373707;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setNameBytes(ByteString value)

public UrlMap.Builder setNameBytes(ByteString value)

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

optional string name = 3373707;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setPathMatchers(int index, PathMatcher value)

public UrlMap.Builder setPathMatchers(int index, PathMatcher value)

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Parameters
Name Description
index int
value PathMatcher
Returns
Type Description
UrlMap.Builder

setPathMatchers(int index, PathMatcher.Builder builderForValue)

public UrlMap.Builder setPathMatchers(int index, PathMatcher.Builder builderForValue)

The list of named PathMatchers to use against the URL.

repeated .google.cloud.compute.v1.PathMatcher path_matchers = 271664219;

Parameters
Name Description
index int
builderForValue PathMatcher.Builder
Returns
Type Description
UrlMap.Builder

setRegion(String value)

public UrlMap.Builder setRegion(String value)

[Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. 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;

Parameter
Name Description
value String

The region to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public UrlMap.Builder setRegionBytes(ByteString value)

[Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. 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;

Parameter
Name Description
value ByteString

The bytes for region to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

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

public UrlMap.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UrlMap.Builder
Overrides

setSelfLink(String value)

public UrlMap.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
Name Description
value String

The selfLink to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public UrlMap.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
Name Description
value ByteString

The bytes for selfLink to set.
Returns
Type Description
UrlMap.Builder

This builder for chaining.

setTests(int index, UrlMapTest value)

public UrlMap.Builder setTests(int index, UrlMapTest value)

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Parameters
Name Description
index int
value UrlMapTest
Returns
Type Description
UrlMap.Builder

setTests(int index, UrlMapTest.Builder builderForValue)

public UrlMap.Builder setTests(int index, UrlMapTest.Builder builderForValue)

The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

repeated .google.cloud.compute.v1.UrlMapTest tests = 110251553;

Parameters
Name Description
index int
builderForValue UrlMapTest.Builder
Returns
Type Description
UrlMap.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final UrlMap.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UrlMap.Builder
Overrides